継承元： : Object
定義場所： : lib/opentok/opentok.rb
概要
OpenTokセッションの作成やトークンの生成を行うメソッドが含まれています。また、アーカイブの操作、ライブストリーミング放送の処理、SIP相互接続の利用、セッションへのシグナルの送信、クライアントのセッションからの切断、およびストリームのレイアウトクラスの設定を行うためのオブジェクトを返すメソッドも含まれています。
新しい OpenTok オブジェクトを作成するには、OpenTok API キーと API シークレットを指定して OpenTok コンストラクタを呼び出します。 OpenTokプロジェクト. APIシークレットを公に公開しないでください。このシークレットは、OpenTokコンストラクタ（Webサーバー上でのみ）を使用してOpenTokセッションを作成する際に使用します。
インスタンスメソッドの概要
-
OpenTokのアーカイブを操作できる「Archives」オブジェクトです。
-
OpenTokのライブストリーミング配信を操作できるBroadcastsオブジェクトです。
-
OpenTokセッションのライブキャプションを開始および停止できる「Captions」オブジェクトです。
-
OpenTokセッションからクライアントを切断できる「Connections」オブジェクトです。
-
#create_session(opts = {}) ⇒ セッション
新しい OpenTok セッションを作成し、そのセッションを一意に識別するセッション ID を返します。
-
#generate_token(session_id, options) ⇒ 文字列
指定されたセッションのトークンを生成します。
-
#初期化(api_key, api_secret, opts = {}) ⇒ OpenTok コンストラクタ
新しい OpenTok オブジェクトを作成します。
-
OpenTok Experience Composerのレンダリングを操作できる「Renders」オブジェクトです。
-
OpenTokセッションにシグナルを送信できるSignalsオブジェクトです。
-
OpenTok SIPゲートウェイを利用できるようにするSipオブジェクトです。
-
OpenTokのライブストリーミング配信を操作できるStreamsオブジェクトです。
-
OpenTokのストリームをWebSocket URIに接続できるWebSocketオブジェクトです。
コンストラクタの詳細
#初期化(api_key, api_secret, opts = {}) ⇒ OpenTok
新しい OpenTok オブジェクトを作成します。
パラメータ：
-
api_key (文字列) —
お客様の OpenTok API キーは OpenTokプロジェクト.
-
api_secret (文字列) —
OpenTokのAPIキー。
-
opts (ハッシュ) （デフォルトは：{}） —
カスタマイズ可能なオプションのセット
オプションハッシュ (opts):
-
:api_url (シンボル)
-
このパラメータを設定しないでください。これはVonageの内部使用を目的としたものです。
-
:ua_addendum (記号)
-
このパラメータを設定しないでください。これはVonageの内部使用を目的としたものです。
-
:timeout_length (シンボル)
-
秒単位のカスタムタイムアウト。指定がない場合は、デフォルトで2秒になります。
インスタンスメソッドの詳細
#アーカイブ ⇒ オブジェクト
OpenTokのアーカイブを操作できる「Archives」オブジェクトです。
#放送 ⇒ オブジェクト
OpenTokのライブストリーミング配信を操作できるBroadcastsオブジェクトです。
#キャプション ⇒ オブジェクト
OpenTokセッションのライブキャプションを開始および停止できる「Captions」オブジェクトです。
#コネクション ⇒ オブジェクト
OpenTokセッションからクライアントを切断できる「Connections」オブジェクトです。
#create_session(opts = {}) ⇒ セッション
新しい OpenTok セッションを作成し、そのセッションを一意に識別するセッション ID を返します。
たとえば、OpenTok JavaScript ライブラリを使用する場合、OT.initSession() メソッドを呼び出す際（OpenTok セッションを初期化するため）は、セッション ID を使用してください。
OpenTokのセッションには有効期限はありません。ただし、認証トークンには有効期限があります（generateToken() メソッドを参照）。また、セッションを明示的に破棄することはできない点にもご注意ください。
セッションIDの文字列は、最大255文字まで可能です。
このメソッドを呼び出した際、エラーが発生すると OpenTokException が発生します。詳細については、エラーメッセージを確認してください。
また、OpenTok REST API（</developer/rest/#session_id_production>を参照）を使用するか、ご自身の OpenTokのAccountページ.
パラメータ：
-
opts (ハッシュ) （デフォルトは：{}） —
(オプション) このハッシュは、セッションのオプションを定義します。
オプションハッシュ (opts):
-
:media_mode (シンボル)
-
セッションで OpenTok Media Router を使用してストリームを送信するかどうかを決定します（
:routed)または(:relayed). デフォルトでは、このプロパティは:relayed.を持つ。
media_modeプロパティを:relayed, セッションでは、クライアント間でストリームを直接送信しようとします。ファイアウォールの制限によりクライアントが接続できない場合、セッションではOpenTokのTURNサーバーを使用して音声・動画ストリームを中継します。を持つ。
media_modeプロパティを:routed, このセッションでは OpenTok メディアルーター. OpenTok Media Router には、次のような利点があります：- OpenTok Media Router を使用すると、多者間セッションにおける帯域幅の使用量を削減できます。（
media_modeプロパティが:relayed各クライアントは、サブスクライブしている各クライアントに個別のオーディオ・ビデオストリームを送信しなければならない)。 - OpenTok Media Router は、以下の機能を通じてユーザー体験の質を向上させることができます。 オーディオのフォールバックとビデオのリカバリー. これらの機能により、クライアントの接続状態が、購読しているストリームの動画を再生できないほど悪化した場合、そのクライアントでは動画の配信が停止され（他のクライアントには影響しません）、クライアントには音声のみが配信されます。クライアントの接続状態が改善すると、動画の配信が再開されます。
- OpenTok Media Router は、以下の機能をサポートしています。 アーカイビング OpenTokセッションの録画、保存、および再生が可能な機能です。
- OpenTok Media Router を使用すると、多者間セッションにおける帯域幅の使用量を削減できます。（
-
:location (文字列)
-
OpenTokサーバーが、グローバルネットワーク内でセッションの位置を特定するために使用するIPアドレスです。位置情報のヒントを設定しない場合、OpenTokサーバーは、セッションに最初に接続したクライアントを基準とします。
-
:archive_mode (シンボル)
-
セッションを自動的にアーカイブするかどうかを指定します（
:always)または(:manual). 自動アーカイブを使用する場合、セッションでは:routedメディアモード。 -
:archive_name (シンボル)
-
自動アーカイブされるセッションのアーカイブに使用する名前。このオプションを設定する場合、:archive_mode オプションを :always に設定する必要があります。そうしないとエラーが発生します。 アーカイブ名の長さは最大80文字までです。エンコーディングの制限により、以下の特殊文字はコロン (:) に変換されます：~、-、_。名前を設定せず、かつ archiveMode オプションが always に設定されている場合、アーカイブ名は空になります。
-
:archive_resolution (シンボル)
-
自動アーカイブセッションにおけるアーカイブの解像度。有効な値は、「480x640」、「640x480」（デフォルト）、「720x1280」、「1280x720」、 「1080x1920」、および「1920x1080」です。このオプションを設定する場合、:archive_mode オプションを :always に設定する必要があります。そうしないとエラーが発生します。
-
:e2ee (true, false)
— デフォルト: ブール値、省略可 —
— セッションでクライアント間でのエンドツーエンド暗号化を使用するかどうか（デフォルト：false）。これを「true」に設定してはなりません。
if:media_modeis:relayed`。詳しくは / ドキュメント をご覧ください。
リターンズ
-
(セッション) —
Session オブジェクト。このオブジェクトの session_id プロパティがセッション ID です。
引き上げ：
- (ArgumentError)
#generate_token(session_id, options) ⇒ 文字列
指定されたセッションのトークンを生成します。
パラメータ：
-
session_id (文字列) —
クライアントがトークンを使用してアクセスするセッションのセッションID。
-
オプション (ハッシュ) —
トークンのオプションを定義するハッシュ。
オプションハッシュ (options):
-
:role (シンボル)
-
トークンの役割。以下のいずれかの値に設定してください：
:subscriber– 加入者はストリームのみを購読できます。:publisher– パブリッシャーは、ストリームの配信、ストリームの購読、およびシグナルの送信を行うことができます。（ロールを指定しない場合のデフォルト値です。）:moderator– 配信者に付与される権限に加え、モデレーターは、クライアントの接続切断を強制したり、配信を停止させたり、配信中のストリームの音声をミュートしたりといったモデレーション機能を実行できます。詳しくは、 / モデレーション開発者ガイド.
-
:expire_time (整数)
-
有効期限は、UNIXエポックからの経過時間（秒単位）です。0を指定すると、トークン作成時から24時間というデフォルトの有効期限が適用されます。有効期限の上限は、作成時から30日間です。
-
:data (文字列)
-
エンドユーザーに関する接続メタデータを含む文字列です。たとえば、ユーザーID、名前、またはエンドユーザーに関するその他のデータを渡すことができます。文字列の長さは1000文字までに制限されています。このデータは、一度設定されると更新することはできません。
-
:initial_layout_class_list (配列)
-
クライアントによって公開されるストリームの初期レイアウトクラスとして使用されるクラス名（文字列）の配列。レイアウトクラスは、動画のレイアウトをカスタマイズする際に使用されます。 / ライブ配信 そして 整理済みのアーカイブ.
-
:token_type (文字列)
-
生成するトークンの種類。‘T1’ または ‘JWT’ のいずれかを指定する必要があります。デフォルトは ‘JWT’ です。
リターンズ
-
(文字列) —
トークンの文字列。
#レンダリング ⇒ オブジェクト
OpenTok Experience Composerのレンダリングを操作できる「Renders」オブジェクトです。
#信号 ⇒ オブジェクト
OpenTokセッションにシグナルを送信できるSignalsオブジェクトです。
#ひと口 ⇒ オブジェクト
OpenTok SIPゲートウェイを利用できるようにするSipオブジェクトです。
#ストリーム ⇒ オブジェクト
OpenTokのライブストリーミング配信を操作できるStreamsオブジェクトです。
#WebSocket ⇒ オブジェクト
OpenTokのストリームをWebSocket URIに接続できるWebSocketオブジェクトです。