OpenTok Ruby SDK リファレンス

OpenTok Ruby SDK には、以下のクラスが含まれています:

クラス 説明
OpenTok::アーカイブ OpenTokセッションのアーカイブを表します。
OpenTok::ArchiveList Archive オブジェクトの配列にアクセスするためのクラス。
OpenTok::アーカイブ OpenTokのアーカイブを扱うためのクラス。
OpenTok::Broadcast OpenTok セッションのライブストリーミング配信を表します。/ ライブストリーミング配信 を参照してください。
OpenTok::BroadcastList Broadcast オブジェクトの配列にアクセスするためのクラス。
OpenTok::Broadcasts OpenTokのライブ配信を扱うためのクラスです。/ ライブ配信 を参照してください。
OpenTok::Captions OpenTokのキャプションを扱うためのクラス。
OpenTok::Connections OpenTok接続を扱うためのクラス。
OpenTok::OpenTok OpenTokセッションの作成やトークンの生成を行うメソッドが含まれています。また、アーカイブの操作、ライブストリーミング放送の処理、SIP相互接続の利用、セッションへのシグナルの送信、クライアントのセッションからの切断、レイアウトの設定を行うためのオブジェクトを返すメソッドも含まれています。
OpenTok::OpenTokArchiveError OpenTok Ruby SDK のアーカイブ関連メソッドによって発生するエラーを定義します。
OpenTok::OpenTokAuthenticationError 無効な OpenTok API キーまたはシークレットを使用して操作を実行しようとした際に発生するエラーを定義します。
OpenTok::OpenTokBroadcastError ブロードキャスト操作を実行した際に発生するエラーを定義します。
OpenTok::OpenTokCaptionsError キャプション操作を実行した際に発生するエラーを定義します。
OpenTok::OpenTokConnectionError クライアントがセッションに接続されていない状態で、強制切断を試みた際に発生するエラーを定義します。
OpenTok::OpenTokError OpenTok Ruby SDK のメソッドによって発生するエラーを定義します。
OpenTok::OpenTokRenderError Experience Composer のレンダリング操作を実行した際に発生するエラーを定義します。
OpenTok::OpenTokSipError OpenTok Ruby SDK の SIP メソッドによって発生するエラーを定義します。
OpenTok::OpenTokStreamLayoutError ストリームにレイアウトクラスを設定しようとした際に発生するエラーを定義します。
OpenTok::OpenTokWebSocketError WebSocket URI への接続時に発生するエラーを定義します。
OpenTok::Render OpenTokセッションのExperience Composerによるレンダリングを表しています。/ Experience Composer を参照してください。
OpenTok::RenderList Experience Composer Render オブジェクトの配列にアクセスするためのクラス。
OpenTok::Renders OpenTok Experience Composer のレンダリングを扱うためのクラスです。/ Experience Composer を参照してください。
OpenTok::Session OpenTokセッションを表します。
OpenTok::Signals OpenTokシグナルを扱うためのクラス。
OpenTok::Sip SIPゲートウェイに接続し、OpenTokセッションに音声のみのストリームを入力します。
OpenTok::Stream ストリームのレイアウトクラスの配列。
OpenTok::StreamList Stream オブジェクトのリストにアクセスするためのクラス。
OpenTok::Streams OpenTokストリームを操作するためのクラスです。このクラスには、OpenTokストリームに関する情報を取得するメソッド、ストリームのレイアウトクラスを設定するメソッド、およびストリームをミュートするメソッドが含まれています。
OpenTok::TokenGenerator モジュール:ClassMethods
OpenTok::WebSocket Vonage Video API セッションから WebSocket URI へオーディオを送信するために、Audio Connector WebSocket 接続を開始します。