- Inherits:
- Object
- Defined in:
- lib/opentok/session.rb
Overview
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
-
#:archive_resolution ⇒ String
readonly
The resolution of archives in an auto-archived session.
-
#archive_mode ⇒ String
readonly
Whether the session will be archived automatically (
:always
) or not (:manual
). -
#archive_name ⇒ String
readonly
The name to use for archives in auto-archived sessions.
-
#archive_resolution ⇒ Object
readonly
Returns the value of attribute archive_resolution.
-
#e2ee ⇒ Object
readonly
Returns the value of attribute e2ee.
-
#location ⇒ String
readonly
The location hint IP address.
-
#media_mode ⇒ String
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.
-
#session_id ⇒ String
readonly
The session ID.
Instance Method Summary
-
#generate_token(options) ⇒ String
Generates a token.
Instance Attribute Details
#:archive_resolution ⇒ String (readonly)
The resolution of archives in an auto-archived session.
#archive_mode ⇒ String (readonly)
Whether the session will be archived automatically (:always
) or not (:manual
).
#archive_name ⇒ String (readonly)
The name to use for archives in auto-archived sessions.
#archive_resolution ⇒ Object (readonly)
Returns the value of attribute archive_resolution.
#e2ee ⇒ Object (readonly)
Returns the value of attribute e2ee.
#location ⇒ String (readonly)
The location hint IP address. See the OpenTok.createSession() method.
#media_mode ⇒ String (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.
#session_id ⇒ String (readonly)
The session ID.
Instance Method Details
#generate_token(options) ⇒ String
Generates a token.