- 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.
Constant Summary
Instance Attribute Summary
-
- (String) archive_mode
readonly
Whether the session will be archived automatically (:always) or not (:manual).
-
- (String) location
readonly
The location hint IP address.
-
- (String) media_mode
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) session_id
readonly
The session ID.
Instance Method Summary
-
- (String) generate_token(options)
Generates a token.
Instance Attribute Details
- (String) archive_mode (readonly)
Whether the session will be archived automatically (:always) or not (:manual).
- (String) location (readonly)
The location hint IP address. See the OpenTok.createSession() method.
- (String) media_mode (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) session_id (readonly)
The session ID.
Instance Method Details
- (String) generate_token(options)
Generates a token.