close search

Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs

Visit the Vonage API Developer Portal

Class: OpenTok::Session

Defined in:


Represents an OpenTok session.

Use the OpenTok.createSession() method to create an OpenTok session. Use the session_id property of the Session object to get the session ID.

Instance Attribute Summary

Instance Method Summary

Instance Attribute Details

#archive_modeString (readonly)

Whether the session will be archived automatically (:always) or not (:manual).


  • (String)

    the current value of archive_mode

#locationString (readonly)

The location hint IP address. See the OpenTok.createSession() method.


  • (String)

    the current value of location

#media_modeString (readonly)

Set to :routed if the session uses the OpenTok Media Router or to :relayed if the session attempts to transmit streams directly between clients.


  • (String)

    the current value of media_mode

#session_idString (readonly)

The session ID.


  • (String)

    the current value of session_id

Instance Method Details

#generate_token(options) ⇒ String

Generates a token.


  • options (Hash)

Options Hash (options):

  • :role (Symbol)

    The role for the token. Set this to one of the following values:

    • :subscriber – A subscriber can only subscribe to streams.

    • :publisher – A publisher can publish streams, subscribe to streams, and signal. (This is the default value if you do not specify a role.)

    • :moderator – In addition to the privileges granted to a publisher, a moderator can perform moderation functions, such as forcing clients to disconnect, to stop publishing streams, or to mute audio in published streams. See the Moderation developer guide.

  • :expire_time (integer)

    The expiration time, in seconds since the UNIX epoch. Pass in 0 to use the default expiration time of 24 hours after the token creation time. The maximum expiration time is 30 days after the creation time.

  • :data (String)

    A string containing connection metadata describing the end-user. For example, you can pass the user ID, name, or other data describing the end-user. The length of the string is limited to 1000 characters. This data cannot be updated once it is set.

  • :initial_layout_class_list (Array)

    An array of class names (strings) to be used as the initial layout classes for streams published by the client. Layout classes are used in customizing the layout of videos in / live streaming broadcasts and composed archives.


  • (String)

    The token string.