Class: OpenTok::OpenTok

Parameters:

• opts (Hash) (defaults to: {}) —

  (Optional) This hash defines options for the session.

Options Hash (opts):

• :media_mode (Symbol) —

  Determines whether the session will transmit streams the using OpenTok Media Router (:routed) or not (:relayed). By default, this property is set to :relayed.

  With the media_mode property set to :relayed, the session will attempt to transmit streams directly between clients. If clients cannot connect due to firewall restrictions, the session uses the OpenTok TURN server to relay audio-video streams.

  With the media_mode property set to :routed, the session will use the OpenTok Media Router. The OpenTok Media Router provides the following benefits:

  • The OpenTok Media Router can decrease bandwidth usage in multiparty sessions. (When the media_mode property is set to :relayed, each client must send a separate audio-video stream to each client subscribing to it.)

  • The OpenTok Media Router can improve the quality of the user experience through audio fallback and video recovery. With these features, if a client’s connectivity degrades to a degree that it does not support video for a stream it’s subscribing to, the video is dropped on that client (without affecting other clients), and the client receives audio only. If the client’s connectivity improves, the video returns.

  • The OpenTok Media Router supports the archiving feature, which lets you record, save, and retrieve OpenTok sessions.

• :location (String) —

  An IP address that the OpenTok servers will use to situate the session in its global network. If you do not set a location hint, the OpenTok servers will be based on the first client connecting to the session.

• :archive_mode (Symbol) —

  Determines whether the session will be archived automatically (:always) or not (:manual). When using automatic archiving, the session must use the :routed media mode.

• :archive_name (Symbol) —

  The name to use for archives in auto-archived sessions. When setting this option, the :archive_mode option must be set to :always or an error will result. The length of the archive name can be up to 80 chars. Due to encoding limitations the following special characters are translated to a colon (:) character: ~, -, _. If you do not set a name and the archiveMode option is set to always, the archive name will be empty.

• :archive_resolution (Symbol) —

  The resolution of archives in an auto-archived session. Valid values are “480x640”, “640x480” (the default), “720x1280”, “1280x720”, “1080x1920”, and “1920x1080”. When setting this option, the :archive_mode option must be set to :always or an error will result.

• :e2ee (true, false) — default: Boolean, optional —

  — Whether the session uses end-to-end encryption from client to client (default: false). This should not be set to ‘true` if `:media_mode` is `:relayed`. See the / documentation for more information.

Returns:

• (Session) —

  The Session object. The session_id property of the object is the session ID.

Raises:

• (ArgumentError)

Parameters:

• session_id (String) —

  The session ID of the session to be accessed by the client using the token.

• options (Hash) —

  A hash defining options for the token.

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.

• :token_type (String) —

  The type of token to generate. Must be one of ‘T1’ or ‘JWT’. ‘JWT’ is the default.

Returns:

• (String) —

  The token string.