OpenTok Ruby SDK reference
The OpenTok Ruby SDK includes the following classes:
| Class | Description |
|---|---|
| OpenTok::Archive | Represents an archive of an OpenTok session. |
| OpenTok::ArchiveList | A class for accessing an array of Archive objects. |
| OpenTok::Archives | A class for working with OpenTok archives. |
| OpenTok::Broadcast | Represents a live streaming broadcast of an OpenTok session. See / Live streaming broadcasts . |
| OpenTok::BroadcastList | A class for accessing an array of Broadcast objects. |
| OpenTok::Broadcasts | A class for working with OpenTok live streaming broadcasts. See / Live streaming broadcasts . |
| OpenTok::Captions | A class for working with OpenTok captions. |
| OpenTok::Connections | A class for working with OpenTok connections. |
| OpenTok::OpenTok | Contains methods for creating OpenTok sessions and generating tokens. It also includes methods for returning object that let you work with archives, work with live streaming broadcasts, using SIP interconnect, sending signals to sessions, disconnecting clients from sessions, and setting the layout c |
| OpenTok::OpenTokArchiveError | Defines errors raised by archive-related methods of the OpenTok Ruby SDK. |
| OpenTok::OpenTokAuthenticationError | Defines errors raised when you attempt an operation using an invalid OpenTok API key or secret. |
| OpenTok::OpenTokBroadcastError | Defines errors raised when you perform Broadcast operations. |
| OpenTok::OpenTokCaptionsError | Defines errors raised when you perform Captions operations. |
| OpenTok::OpenTokConnectionError | Defines errors raised when you attempt a force disconnect a client and it is not connected to the session. |
| OpenTok::OpenTokError | Defines errors raised by methods of the OpenTok Ruby SDK. |
| OpenTok::OpenTokRenderError | Defines errors raised when you perform Experience Composer render operations. |
| OpenTok::OpenTokSipError | Defines errors raised by SIP methods of the OpenTok Ruby SDK. |
| OpenTok::OpenTokStreamLayoutError | Defines errors raised when you attempt set layout classes to a stream. |
| OpenTok::OpenTokWebSocketError | Defines errors raised when connecting to WebSocket URIs. |
| OpenTok::Render | Represents an Experience Composer render of an OpenTok session. See / Experience Composer . |
| OpenTok::RenderList | A class for accessing an array of Experience Composer Render objects. |
| OpenTok::Renders | A class for working with OpenTok Experience Composer renders. See / Experience Composer . |
| OpenTok::Session | Represents an OpenTok session. |
| OpenTok::Signals | A class for working with OpenTok signals. |
| OpenTok::Sip | Dials a SIP gateway to input an audio-only stream into your OpenTok session. |
| OpenTok::Stream | An array of the layout classes for the stream. |
| OpenTok::StreamList | A class for accessing a list of Stream objects. |
| OpenTok::Streams | A class for working with OpenTok streams. It includes methods for getting info about OpenTok streams, for setting layout classes for streams, and for muting streams. |
| OpenTok::TokenGenerator | Modules: ClassMethods |
| OpenTok::WebSocket | Starts an Audio Connector WebSocket connection to send audio from a Vonage Video API session to a WebSocket URI. |