Vonage Video API セッションの作成、トークンの生成、およびアーカイブの操作を行うためのメソッドが含まれています。 続きを読む...

詳細な説明

Vonage Video API セッションの作成、トークンの生成、およびアーカイブの操作を行うためのメソッドが含まれています。

新しいものを作成するには オープントーク オブジェクトでは、 OpenTok() Vonage Video API キーと、ご自身の API シークレットを指定してコンストラクタを呼び出し、 OpenTokプロジェクト. APIシークレットを公に公開しないでください。これは、 オープントーク コンストラクタ（Webサーバー上でのみ）を使用して、Vonage Video APIのセッションを作成します。

コンストラクタとデストラクタのドキュメント

OpenTok() [1/2]

を作成する。 オープントーク オブジェクトがある。

パラメータ : | | | | --- | --- | | apiKey | お客様のVonage Video APIキー。（詳細は TokBoxのアカウントページ | | apiSecret | お客様のVonage Video APIシークレット。（詳細は TokBoxのアカウントページ |

OpenTok() [2/2]

TokBox社内の使用限定。

パラメータ : | | | | --- | --- | | apiKey | | | apiSecret | | | apiUrl | |

メンバー関数のドキュメント

AddStreamToArchive()

現在実行中の、 streamMode に設定する。 StreamMode.Manual. 同じストリームIDを使用してこのメソッドを繰り返し呼び出すことで、アーカイブ内のストリームの音声や映像の表示・非表示を切り替えることができます。

パラメータ : | | | | --- | --- | | archiveId | アーカイブ ID。 | | streamId | ストリーム ID。 | | hasAudio | 生成されるアーカイブに、ストリームのオーディオを含めるかどうか（true：デフォルト、false：含めない）。 | | hasVideo | 合成されたアーカイブにストリームのビデオを含めるかどうか（true：デフォルト、false：含めない）。 |

AddStreamToArchiveAsync()

現在実行中の、 streamMode に設定する。 StreamMode.Manual. 同じストリームIDを使用してこのメソッドを繰り返し呼び出すことで、アーカイブ内のストリームの音声や映像の表示・非表示を切り替えることができます。

パラメータ : | | | | --- | --- | | archiveId | アーカイブ ID。 | | streamId | ストリーム ID。 | | hasAudio | 生成されるアーカイブに、ストリームのオーディオを含めるかどうか（true：デフォルト、false：含めない）。 | | hasVideo | 合成されたアーカイブにストリームのビデオを含めるかどうか（true：デフォルト、false：含めない）。 |

AddStreamToBroadcast()

現在実行中の、以下のコマンドで開始された放送にストリームを追加します。 streamMode に設定する。 StreamMode.Manual. 同じストリームIDを使用してこのメソッドを繰り返し呼び出すことで、放送中のストリームの音声や映像の表示・非表示を切り替えることができます。

パラメータ : | | | | --- | --- | | broadcastId | 放送ID。 | | streamId | ストリームID。 | | hasAudio | 放送にストリームの音声を含まれるか（true：デフォルト）、含まれないか（false）。 | | hasVideo | ブロードキャストにストリームの動画を包含するかどうか（true：デフォルト、false：含まない）。 |

例外 : | | | | --- | --- | | OpenTokArgumentException | |

AddStreamToBroadcastAsync()

現在実行中の、以下のコマンドで開始された放送にストリームを追加します。 streamMode に設定する。 StreamMode.Manual. 同じストリームIDを使用してこのメソッドを繰り返し呼び出すことで、放送中のストリームの音声や映像の表示・非表示を切り替えることができます。

パラメータ : | | | | --- | --- | | broadcastId | 放送ID。 | | streamId | ストリームID。 | | hasAudio | 放送にストリームの音声を含まれるか（true：デフォルト）、含まれないか（false）。 | | hasVideo | ブロードキャストにストリームの動画を包含するかどうか（true：デフォルト、false：含まない）。 |

例外 : | | | | --- | --- | | OpenTokArgumentException | |

CreateSession()

新しいVonage Video APIセッションを作成します。

Vonage Video API のセッションには有効期限がありません。ただし、認証トークンには有効期限があります（generateToken() メソッドを参照）。また、セッションを明示的に破棄することはできない点にもご注意ください。

セッションIDの文字列は、最大255文字まで可能です。

このメソッドを呼び出した際、エラーが発生すると OpenTokException が発生します。詳細については、エラーメッセージを確認してください。

また、以下の方法を使ってセッションを作成することもできます。 OpenTok REST API または、アカウントにログインして TokBoxアカウント.

パラメータ : | | | | --- | --- | | location | Vonage Video API サーバーが、グローバルネットワーク内でセッションの位置を特定するために使用する IP アドレス。ロケーションのヒントを設定しない場合、Vonage Video API サーバーは、セッションに最初に接続したクライアントを基準とします。 | | mediaMode | セッションが Vonage Video API メディアルーターを使用してストリームを送信するかどうか（MediaMode.ROUTED)または(MediaMode.RELAYED). デフォルトでは、この設定は MediaMode.RELAYED. パラメータを MediaMode.RELAYED, セッションはクライアント間でストリームを直接送信しようとします。ファイアウォールの制限によりクライアントが接続できない場合、セッションは オープントーク ストリームを中継するためにサーバーを有効にします。その OpenTok メディアルーター 次のようなメリットがあります： - Vonage Video API メディアルーターは、多者間セッションにおける帯域幅の使用量を削減できます。（ mediaMode パラメータが MediaMode.ROUTED, 各クライアントは、そのストリームを購読している各クライアントに対して、個別の音声・映像ストリームを送信する必要があります。） - Vonage Video API メディアルーターは、以下を通じてユーザー体験の質を向上させることができます。 オーディオのフォールバックとビデオのリカバリー これらの機能により、クライアントの接続状態が、購読しているストリームの動画再生に対応できないほど悪化した場合、そのクライアントでは動画の配信が停止され（他のクライアントには影響しません）、クライアントには音声のみが配信されます。クライアントの接続状態が改善すると、動画の配信が再開されます。 - Vonage Video API メディアルーターは、 アーカイビング Vonage Video APIのセッションを記録、保存、および取得できる機能です。 | | archiveMode | セッションが自動的にアーカイブされるかどうか（ArchiveMode.ALWAYS)または(ArchiveMode.MANUAL). デフォルトでは、この設定は ArchiveMode.MANUAL そして、次の関数を呼び出す必要があります。 StartArchive のメソッドを使用する。 オープントーク アーカイブを開始するオブジェクト。セッションをアーカイブするには（自動か手動かに関わらず）、mediaMode パラメータを MediaMode.ROUTED | | 暗号化 | 有効にする エンドツーエンドのメディア暗号化 ルーティングされたセッションにおいて。 | | archiveName | 自動アーカイブされたセッション内のアーカイブ名。アーカイブモードが「always」で開始されたセッションでは、そのセッションのすべてのアーカイブに対してこのアーカイブ名が使用されます。アーカイブモードが「manual」の場合に「archiveName」を指定すると、エラー応答が返されます。 | | archiveResolution | 自動アーカイブセッションにおけるアーカイブの解像度。アーカイブモードが「always」で開始されたセッションでは、そのセッションのすべてのアーカイブに対してこの解像度が使用されます。アーカイブモードが「manual」の場合に「archiveResolution」を指定すると、エラー応答が返されます。 |

返り値 : A セッション 新しいセッションを表すオブジェクト。その Session.Id プロパティの セッション これはセッションIDであり、セッションを一意に識別するものです。クライアントSDKでは、このセッションIDを使用してセッションを識別します。たとえば、OpenTok.jsライブラリを使用する場合、 OT.initSession() メソッド（Vonage Video API セッションを初期化するため）。

CreateSessionAsync()

新しいVonage Video APIセッションを作成します。

Vonage Video API のセッションには有効期限がありません。ただし、認証トークンには有効期限があります（generateToken() メソッドを参照）。また、セッションを明示的に破棄することはできない点にもご注意ください。

セッションIDの文字列は、最大255文字まで可能です。

このメソッドを呼び出した際、エラーが発生すると OpenTokException が発生します。詳細については、エラーメッセージを確認してください。

また、以下の方法を使ってセッションを作成することもできます。 OpenTok REST API または、アカウントにログインして TokBoxアカウント.

パラメータ : | | | | --- | --- | | location | Vonage Video API サーバーが、グローバルネットワーク内でセッションの位置を特定するために使用する IP アドレス。ロケーションのヒントを設定しない場合、Vonage Video API サーバーは、セッションに最初に接続したクライアントを基準とします。 | | mediaMode | セッションが Vonage Video API メディアルーターを使用してストリームを送信するかどうか（MediaMode.ROUTED)または(MediaMode.RELAYED). デフォルトでは、この設定は MediaMode.RELAYED. パラメータを MediaMode.RELAYED, セッションはクライアント間でストリームを直接送信しようとします。ファイアウォールの制限によりクライアントが接続できない場合、セッションは オープントーク ストリームを中継するためにサーバーを有効にします。その OpenTok メディアルーター 次のようなメリットがあります： - Vonage Video API メディアルーターは、多者間セッションにおける帯域幅の使用量を削減できます。（ mediaMode パラメータが MediaMode.ROUTED, 各クライアントは、そのストリームを購読している各クライアントに対して、個別の音声・映像ストリームを送信する必要があります。） - Vonage Video API メディアルーターは、以下を通じてユーザー体験の質を向上させることができます。 オーディオのフォールバックとビデオのリカバリー これらの機能により、クライアントの接続状態が、購読しているストリームの動画再生に対応できないほど悪化した場合、そのクライアントでは動画の配信が停止され（他のクライアントには影響しません）、クライアントには音声のみが配信されます。クライアントの接続状態が改善すると、動画の配信が再開されます。 - Vonage Video API メディアルーターは、 アーカイビング Vonage Video APIのセッションを記録、保存、および取得できる機能です。 | | archiveMode | セッションが自動的にアーカイブされるかどうか（ArchiveMode.ALWAYS)または(ArchiveMode.MANUAL). デフォルトでは、この設定は ArchiveMode.MANUAL そして、次の関数を呼び出す必要があります。 StartArchive のメソッドを使用する。 オープントーク アーカイブを開始するオブジェクト。セッションをアーカイブするには（自動か手動かに関わらず）、mediaMode パラメータを MediaMode.ROUTED | | 暗号化 | 有効にする エンドツーエンドのメディア暗号化 ルーティングされたセッションにおいて。 | | archiveName | 自動アーカイブされたセッション内のアーカイブ名。アーカイブモードが「always」で開始されたセッションでは、そのセッションのすべてのアーカイブに対してこのアーカイブ名が使用されます。アーカイブモードが「manual」の場合に「archiveName」を指定すると、エラー応答が返されます。 | | archiveResolution | 自動アーカイブセッションにおけるアーカイブの解像度。アーカイブモードが「always」で開始されたセッションでは、そのセッションのすべてのアーカイブに対してこの解像度が使用されます。アーカイブモードが「manual」の場合に「archiveResolution」を指定すると、エラー応答が返されます。 |

返り値 : A セッション 新しいセッションを表すオブジェクト。その Session.Id プロパティの セッション これはセッションIDであり、セッションを一意に識別するものです。クライアントSDKでは、このセッションIDを使用してセッションを識別します。たとえば、OpenTok.jsライブラリを使用する場合、 OT.initSession() メソッド（Vonage Video API セッションを初期化するため）。

DeleteArchive()

を削除します オープントーク アーカイブ。

「利用可能」または「アップロード済み」の状態にあるアーカイブのみ削除できます。アーカイブを削除すると、アーカイブ一覧からその記録が削除されます。「利用可能」状態のアーカイブの場合、アーカイブファイル自体も削除されるため、ダウンロードできなくなります。

パラメータ : | | | | --- | --- | | archiveId | 削除したいアーカイブのアーカイブID。 |

DeleteArchiveAsync()

を削除します オープントーク アーカイブ。

「利用可能」または「アップロード済み」の状態にあるアーカイブのみ削除できます。アーカイブを削除すると、アーカイブ一覧からその記録が削除されます。「利用可能」状態のアーカイブの場合、アーカイブファイル自体も削除されるため、ダウンロードできなくなります。

パラメータ : | | | | --- | --- | | archiveId | 削除したいアーカイブのアーカイブID。 |

Dial()

SIPプラットフォームをVonage Video APIセッションに接続します。

技術的な詳細やセキュリティ上の考慮事項など、詳細については、以下の OpenTok SIP相互接続開発者ガイド.

パラメータ : | | | | --- | --- | | sessionId | ユーザーが接続するセッションに対応するセッションID。 | | token | SIPユーザーが接続に使用するセッションIDに対応するトークン。 | | sipUri | から発信されるSIP通話の宛先として使用されるSIP URI。 オープントーク SIPプラットフォームへ。SIP URIに​transport=tls​ヘッダーが含まれている場合、 オープントーク これにより、SIPエンドポイント間の通信は安全に行われます。なお、これはネゴシエーション自体にのみ適用され、音声の伝送には適用されない点にご注意ください。音声の伝送も暗号化したい場合は、 Secure のの DialOptions options パラメータに渡されたオブジェクト ​true​. これは設定の例です sipUri 安全なコールネゴシエーションを行うには： "sip:user@sip.partner.com;transport=tls". これは、安全でないコールネゴシエーションの例です： "sip:user@sip.partner.com". | | オプション | SIPダイヤル用のオプションパラメータ。 |

DialAsync()

SIPプラットフォームをVonage Video APIセッションに接続します。

技術的な詳細やセキュリティ上の考慮事項など、詳細については、以下の OpenTok SIP相互接続開発者ガイド.

こちらも参照 OpenTok.Dial.

パラメータ : | | | | --- | --- | | sessionId | ユーザーが接続するセッションに対応するセッションID。 | | token | SIPユーザーが接続に使用するセッションIDに対応するトークン。 | | sipUri | から発信されるSIP通話の宛先として使用されるSIP URI。 オープントーク SIPプラットフォームへ。SIP URIに​transport=tls​ヘッダーが含まれている場合、 オープントーク これにより、SIPエンドポイント間の通信は安全に行われます。なお、これはネゴシエーション自体にのみ適用され、音声の伝送には適用されない点にご注意ください。音声の伝送も暗号化したい場合は、 Secure のの DialOptions options パラメータに渡されたオブジェクト ​true​. これは設定の例です sipUri 安全なコールネゴシエーションを行うには： "sip:user@sip.partner.com;transport=tls". これは、安全でないコールネゴシエーションの例です： "sip:user@sip.partner.com". | | オプション | SIPダイヤル用のオプションパラメータ。 |

DisableForceMute()

セッションのアクティブなミュート状態を解除します。このメソッドを呼び出すと、そのセッションに配信される新しいストリームの音声はミュートされなくなります。

を呼び出した後 ForceMuteAll このメソッドを呼び出すと、その呼び出し後にパブリッシュされるすべてのストリームは、音声がミュートされた状態でパブリッシュされます。 DisableForceMute() セッションのミュート状態を解除する方法。これにより、新たに公開されるストリームが自動的にミュートされるのを防ぐことができます。

また、以下の項目も参照してください。 DisableForceMuteAsync メソッドを使用する。

パラメータ : | | | | --- | --- | | sessionId | セッション ID。 |

例外 : | | | | --- | --- | | OpenTokArgumentException | セッション ID が無効な場合にスローされます。 | | OpenTokWebException | HTTP エラーが発生した場合にスローされます。 |

DisableForceMuteAsync()

セッションのアクティブなミュート状態を解除します。このメソッドを呼び出すと、そのセッションに配信される新しいストリームの音声はミュートされなくなります。

を呼び出した後 ForceMuteAllAsync このメソッドを呼び出すと、その呼び出し後にパブリッシュされるすべてのストリームは、音声がミュートされた状態でパブリッシュされます。 DisableForceMuteAsync() セッションのミュート状態を解除する方法。これにより、新たに公開されるストリームが自動的にミュートされるのを防ぐことができます。

また、以下の項目も参照してください。 DisableForceMute メソッドを使用する。

パラメータ : | | | | --- | --- | | sessionId | セッション ID。 |

例外 : | | | | --- | --- | | OpenTokArgumentException | セッション ID が無効な場合にスローされます。 | | OpenTokWebException | HTTP エラーが発生した場合にスローされます。 |

ForceDisconnect()

特定のクライアントを、Vonage Video API セッションから強制的に切断させる。

パラメータ : | | | | --- | --- | | sessionId | セッションに対応するセッションID。 | | connectionId | セッション内の接続の接続ID。 |

ForceDisconnectAsync()

特定のクライアントを、Vonage Video API セッションから強制的に切断させる。

パラメータ : | | | | --- | --- | | sessionId | セッションに対応するセッションID。 | | connectionId | セッション内の接続の接続ID。 |

ForceMuteAll()

セッション内のすべてのストリーム（オプションで指定されたストリーム一覧を除く）について、配信中のオーディオをミュートするように強制します。

既存のストリームに加え、このメソッドの呼び出し後に公開されるすべてのストリームは、音声がミュートされた状態で公開されます。セッションのミュート状態を解除するには、 DisableForceMute メソッドを使用する。

また、以下の項目も参照してください。 ForceMuteAllAsync そして ForceMuteStream のメソッドがある。

パラメータ : | | | | --- | --- | | sessionId | セッションのID。 | | excludedStreamIds | ミュート対象外となるストリームのID。 |

例外 : | | | | --- | --- | | OpenTokArgumentException | セッション ID が無効な場合にスローされます。 | | OpenTokWebException | HTTP エラーが発生した場合にスローされます。 |

ForceMuteAllAsync()

セッション内のすべてのストリーム（オプションで指定されたストリーム一覧を除く）について、配信中のオーディオをミュートするように強制します。

既存のストリームに加え、このメソッドの呼び出し後に公開されるすべてのストリームは、音声がミュートされた状態で公開されます。セッションのミュート状態を解除するには、 DisableForceMuteAsync メソッドを使用する。

また、以下の項目も参照してください。 ForceMuteAll そして ForceMuteStreamAsync のメソッドがある。

パラメータ : | | | | --- | --- | | sessionId | セッションのID。 | | excludedStreamIds | ミュート対象外となるストリームのID。 |

例外 : | | | | --- | --- | | OpenTokArgumentException | セッション ID が無効な場合にスローされます。 | | OpenTokWebException | HTTP エラーが発生した場合にスローされます。 |

ForceMuteStream()

特定のストリームの配信者に、配信中の音声をミュートするよう強制する。

また、以下の項目も参照してください。 ForceMuteAll そして ForceMuteStreamAsync のメソッドがある。

パラメータ : | | | | --- | --- | | sessionId | ストリームを含むセッションのセッションID。 | | streamId | ストリームのID。 |

例外 : | | | | --- | --- | | OpenTokArgumentException | セッション ID またはストリーム ID が無効な場合にスローされます。 | | OpenTokWebException | HTTP エラーが発生した場合にスローされます。 |

ForceMuteStreamAsync()

特定のストリームの配信者に、配信中の音声をミュートするよう強制する。

また、以下の項目も参照してください。 ForceMuteAll そして ForceMuteStream のメソッドがある。

パラメータ : | | | | --- | --- | | sessionId | ストリームを含むセッションのセッションID。 | | streamId | ストリームのID。 |

例外 : | | | | --- | --- | | OpenTokArgumentException | セッション ID またはストリーム ID が無効な場合にスローされます。 | | OpenTokWebException | HTTP エラーが発生した場合にスローされます。 |

GenerateToken()

Vonage Video API セッションに接続するためのトークンを作成します。Vonage Video API セッションに接続するユーザーを認証するために、クライアントはセッションへの接続時にトークンを渡します。

テストを行うには、アカウントにログインしてテスト用トークンを生成することもできます。 TokBoxアカウント.

パラメータ : | | | | --- | --- | | sessionId | ユーザーが接続するセッションに対応するセッション ID。 | | role | トークンのロール。有効な値は Role 列挙型で定義されています： - 役割.SUBSCRIBER （加入者はストリームのみを購読できます） - Role.PUBLISHER (パブリッシャーは、ストリームの配信、ストリームの購読、およびシグナルの送信を行うことができます。（ロールを指定しない場合のデフォルト値です。）) - 役割：モデレーター （パブリッシャーに付与される権限に加え、モデレーターは、クライアントの強制切断、ストリームの配信停止、配信中のストリームの音声ミュートなど、モデレーション機能を実行することができます。詳しくは、 モデレーション開発者ガイド. | | expireTime | トークンの有効期限。UNIXエポックからの経過秒数で指定します。0を指定すると、トークン作成時から24時間というデフォルトの有効期限が適用されます。有効期限の最大値は、作成時から30日です。 | | data | エンドユーザーに関する接続メタデータを含む文字列。 たとえば、ユーザー ID、名前、またはエンドユーザーを説明するその他のデータを渡すことができます。文字列の長さは 1000 文字までに制限されています。このデータは、一度設定されると更新できません。 | | initialLayoutClassList | ストリームの初期レイアウトを含む文字列値のリスト。 |

リターン

GetArchive()

を取得します アーカイブ 指定されたアーカイブIDに対応するオブジェクト。

パラメータ : | | | | --- | --- | | archiveId | アーカイブ ID。 |

返品 : ザ アーカイブ オブジェクトがある。

GetArchiveAsync()

を取得します アーカイブ 指定されたアーカイブIDに対応するオブジェクト。

パラメータ : | | | | --- | --- | | archiveId | アーカイブ ID。 |

返品 : ザ アーカイブ オブジェクトがある。

GetBroadcast()

このメソッドを使用して、Vonage Video API セッションのライブストリーミング放送オブジェクトを取得します。

放送に関する詳細については、以下の 放送開発者ガイド。

パラメータ : | | | | --- | --- | | broadcastId | 放送セッションの放送ID |

返品 : ザ ブロードキャスト オブジェクト。このオブジェクトには、ブロードキャストIDを含む、ブロードキャストを定義するプロパティが含まれています。

GetBroadcastAsync()

このメソッドを使用して、Vonage Video API セッションのライブストリーミング放送オブジェクトを取得します。

放送に関する詳細については、以下の 放送開発者ガイド。

パラメータ : | | | | --- | --- | | broadcastId | 放送セッションの放送ID |

返品 : ザ ブロードキャスト オブジェクト。このオブジェクトには、ブロードキャストIDを含む、ブロードキャストを定義するプロパティが含まれています。

GetRenderAsync()

Experience Composer のレンダラーを取得します。

パラメータ : | | | | --- | --- | | renderId | レンダリングのID。 |

GetStream()

を取得します ストリーム 指定されたストリームIDに対応するオブジェクト。

パラメータ : | | | | --- | --- | | sessionId | Vonage Video API セッションのセッション ID。 | | streamId | ストリーム ID。 |

返品 : ザ ストリーム オブジェクトがある。

GetStreamAsync()

を取得します ストリーム 指定されたストリームIDに対応するオブジェクト。

パラメータ : | | | | --- | --- | | sessionId | Vonage Video API セッションのセッション ID。 | | streamId | ストリーム ID。 |

返品 : ザ ストリーム オブジェクトがある。

ListArchives()

以下のリストを返します。 アーカイブ APIキーに対応する、完了済みおよび進行中のアーカイブを表すオブジェクト。

パラメータ : | | | | --- | --- | | offset | 最初のアーカイブのインデックスオフセット。0 は最も最近開始されたアーカイブのオフセットです。1 は、その直前に開始されたアーカイブのオフセットです。 | | count | 返すアーカイブの数。返されるアーカイブの最大数は 1000 です。 | | sessionId | セッション ID。 |

返り値 : 以下のリスト アーカイブ オブジェクトがある。

ListArchivesAsync()

以下のリストを返します。 アーカイブ APIキーに対応する、完了済みおよび進行中のアーカイブを表すオブジェクト。

パラメータ : | | | | --- | --- | | offset | 最初のアーカイブのインデックスオフセット。0 は最も最近開始されたアーカイブのオフセットです。1 は、その直前に開始されたアーカイブのオフセットです。 | | count | 返すアーカイブの数。返されるアーカイブの最大数は 1000 です。 | | sessionId | セッション ID。 |

返り値 : 以下のリスト アーカイブ オブジェクトがある。

ListRendersAsync()

指定されたリクエストに一致するすべての Experience Composer レンダラーを取得します。

パラメータ : | | | | --- | --- | | request | フィルタリングオプションを含むリクエスト。 |

戻り値 : レンダリング結果のリスト。

ListStreams()

以下のリストを返します。 ストリーム そのセッションIDに対応する、現在処理中のストリームを表すオブジェクト。

パラメータ : | | | | --- | --- | | sessionId | セッションに対応するセッションID。 |

返り値 : 以下のリスト ストリーム オブジェクトがある。

例外 : | | | | --- | --- | | OpenTokArgumentException | |

ListStreamsAsync()

以下のリストを返します。 ストリーム そのセッションIDに対応する、現在処理中のストリームを表すオブジェクト。

パラメータ : | | | | --- | --- | | sessionId | セッションに対応するセッションID。 |

返り値 : 以下のリスト ストリーム オブジェクトがある。

例外 : | | | | --- | --- | | OpenTokArgumentException | |

PlayDTMF()

アクティブなVonage Video APIセッションのすべての参加者、またはそのセッションに接続している特定のクライアントに対して、DTMF番号を送信します。

パラメータ : | | | | --- | --- | | sessionId | DTMF文字列を受信するセッションに対応するセッションID。 | | connectionId | DTMF信号を送信するクライアントの接続ID。セッションに接続されているすべてのクライアントにDTMF信号を送信する場合は、空欄のままにしてください。 | | digits | 送信するDTMF数字の文字列です。0～9、'*'、'#'、および'p'を含めることができます。'p'は500msの休止を意味します（数字の送信に遅延を加える必要がある場合）。 |

PlayDTMFAsync()

アクティブなVonage Video APIセッションのすべての参加者、またはそのセッションに接続している特定のクライアントに対して、DTMF番号を送信します。

パラメータ : | | | | --- | --- | | sessionId | DTMF文字列を受信するセッションに対応するセッションID。 | | connectionId | DTMF信号を送信するクライアントの接続ID。セッションに接続されているすべてのクライアントにDTMF信号を送信する場合は、空欄のままにしてください。 | | digits | 送信するDTMF数字の文字列です。0～9、'*'、'#'、および'p'を含めることができます。'p'は500msの休止を意味します（数字の送信に遅延を加える必要がある場合）。 |

RemoveStreamFromArchive()

``で開始された複合アーカイブからストリームを削除します。 streamMode に設定する。 StreamMode.Manual.

パラメータ : | | | | --- | --- | | archiveId | アーカイブ ID。 | | streamId | ストリーム ID。 |

RemoveStreamFromArchiveAsync()

``で開始された複合アーカイブからストリームを削除します。 streamMode に設定する。 StreamMode.Manual.

パラメータ : | | | | --- | --- | | archiveId | アーカイブ ID。 | | streamId | ストリーム ID。 |

RemoveStreamFromBroadcast()

で開始された放送からストリームを削除します。 streamMode に設定する。 StreamMode.Manual.

パラメータ : | | | | --- | --- | | broadcastId | ブロードキャスト ID。 | | streamId | ストリーム ID。 |

例外 : | | | | --- | --- | | OpenTokArgumentException | |

RemoveStreamFromBroadcastAsync()

で開始された放送からストリームを削除します。 streamMode に設定する。 StreamMode.Manual.

パラメータ : | | | | --- | --- | | broadcastId | ブロードキャスト ID。 | | streamId | ストリーム ID。 |

例外 : | | | | --- | --- | | OpenTokArgumentException | |

SetArchiveLayout()

アーカイブの作成中に、そのレイアウトを動的に変更することができます。詳細は以下を参照してください。 構成されたアーカイブのビデオレイアウトをカスタマイズする レイアウトのカスタマイズに関する詳細については、

パラメータ : | | | | --- | --- | | archiveId | | | layout | |

リターン

SetArchiveLayoutAsync()

アーカイブの作成中に、そのレイアウトを動的に変更することができます。詳細は以下を参照してください。 構成されたアーカイブのビデオレイアウトをカスタマイズする レイアウトのカスタマイズに関する詳細については、

パラメータ : | | | | --- | --- | | archiveId | | | layout | |

リターン

SetBroadcastLayout()

放送のレイアウトタイプを設定します。レイアウトタイプの詳細については、以下を参照してください。 OpenTokライブ配信の動画レイアウトの設定.

パラメータ : | | | | --- | --- | | broadcastId | 放送セッションの放送ID。 | | layout | BroadcastLayout 放送のレイアウト設定を定義するものです。 |

SetBroadcastLayoutAsync()

放送のレイアウトタイプを設定します。レイアウトタイプの詳細については、以下を参照してください。 OpenTokライブ配信の動画レイアウトの設定.

パラメータ : | | | | --- | --- | | broadcastId | 放送セッションの放送ID。 | | layout | BroadcastLayout 放送のレイアウト設定を定義するものです。 |

SetCustomUserAgent()

カスタムユーザーエージェントの値を設定します。HttpClient は、この値が存在する場合、初期のユーザーエージェントの値にこの値を追加します。

パラメータ : | | | | --- | --- | | 値 | カスタムユーザーエージェントの値。 |

SetDefaultRequestTimeout()

SDKから送信されるすべてのWebRequestのデフォルトのリクエストタイムアウト（ミリ秒単位）を設定します

パラメータ : | | | | --- | --- | | タイムアウト | |

SetStreamClassLists()

セッション内のストリームに対するレイアウトクラス一覧を設定します。レイアウトクラスは、合成アーカイブやライブストリーミング放送のレイアウトで使用されます。詳細については、以下を参照してください。 構成されたアーカイブのビデオレイアウトをカスタマイズする そして OpenTokライブ配信の動画レイアウトの設定.

クライアントによって公開されるストリームの初期レイアウトクラス一覧は、クライアントが使用するものを生成する際に設定できます。詳しくは、 GenerateToken メソッドを使用する。

パラメータ : | | | | --- | --- | | sessionId | sessionId | | streams | セッション内の1つ以上のストリームに対するクラス一覧を定義する StreamsProperties のリスト。 |

SetStreamClassListsAsync()

セッション内のストリームに対するレイアウトクラス一覧を設定します。レイアウトクラスは、合成アーカイブやライブストリーミング放送のレイアウトで使用されます。詳細については、以下を参照してください。 構成されたアーカイブのビデオレイアウトをカスタマイズする そして OpenTokライブ配信の動画レイアウトの設定.

クライアントによって公開されるストリームの初期レイアウトクラス一覧は、クライアントが使用するものを生成する際に設定できます。詳しくは、 GenerateToken メソッドを使用する。

パラメータ : | | | | --- | --- | | sessionId | sessionId | | streams | セッション内の1つ以上のストリームに対するクラス一覧を定義する StreamsProperties のリスト。 |

Signal()

Vonage Video API セッションに接続しているクライアント（または特定のクライアント）にシグナルを送信します。

パラメータ : | | | | --- | --- | | sessionId | シグナルが送信される Vonage Video API の sessionId。 | | signalProperties | この signalProperties は、シグナルのペイロードを定義します。 | | connectionId | セッション内の特定の接続にシグナルを送信するために使用されるオプションのパラメータ。 |

SignalAsync()

Vonage Video API セッションに接続しているクライアント（または特定のクライアント）にシグナルを送信します。

パラメータ : | | | | --- | --- | | sessionId | シグナルが送信される Vonage Video API の sessionId。 | | signalProperties | この signalProperties は、シグナルのペイロードを定義します。 | | connectionId | セッション内の特定の接続にシグナルを送信するために使用されるオプションのパラメータ。 |

StartArchive()

Vonage Video API セッションのアーカイブを開始します。

アーカイブの録画を正常に開始するには、クライアントがVonage Video APIセッションにアクティブに接続されている必要があります。

1つのセッションにつき、一度にアーカイブできるのは1つだけです。アーカイブできるのは、Vonage Video API Media Router を使用しているセッション（メディアモードが「routed」に設定されているセッション）のみです。メディアモードが「relayed」に設定されているセッションはアーカイブできません。

なお、のarchiveModeパラメータを設定することで、セッションを自動的にアーカイブすることができます。 CreateSession メソッドを使用します。 ArchiveMode.ALWAYS.

パラメータ : | | | | --- | --- | | sessionId | アーカイブ対象のVonage Video APIセッションのセッションID。 | | name | アーカイブの名前。この名前を使用してアーカイブを識別できます。これは、 アーカイブ オブジェクトであり、これは オープントーク クライアントライブラリ。 | | hasVideo | アーカイブで動画を記録するかどうか（true）または記録しないかどうか（false）。デフォルト値は true（動画を記録する）です。両方を設定した場合 hasAudio そして hasVideo false に設定すると、 StartArchive このメソッドを実行するとエラーが発生します。 | | hasAudio | アーカイブで音声を録音するかどうか（true）または録音しないかどうか（false）。デフォルト値は true（音声が録音される）です。両方を設定すると hasAudio そして hasVideo false に設定すると、 StartArchive このメソッドを実行するとエラーが発生します。 | | outputMode | アーカイブ内のすべてのストリームを単一のファイルに記録するかどうか（OutputMode.COMPOSED（デフォルト）または個々のファイル（OutputMode.INDIVIDUAL). | | 解像度 | アーカイブの解像度。デフォルト値は OutputMode.COMPOSED は「640×480」です。の解像度は指定できません。 OutputMode.INDIVIDUAL. | | layout | アーカイブで使用するレイアウト。type が LayoutType.custom アーカイブのレイアウト方法を指定するために、Vonage にスタイルシートの文字列を提供する必要があります。| | streamMode | アーカイブに含まれるストリームが自動的に選択されるかどうか（StreamMode.Auto（デフォルト）または手動で（StreamMode.Manual). これに伴い、 StreamMode.Manual, アーカイブに含めるストリームは、 OpenTok.AddStreamToArchive そして OpenTok.RemoveStreamFromArchive メソッド（または OpenTok.AddStreamToArchiveAsync そして OpenTok.RemoveStreamFromArchiveAsync メソッド）。 | | multiArchiveTag | 同じセッションの複数のアーカイブを同時に記録できるようにするには、これを設定します。進行中のセッションの同時アーカイブごとに、一意の文字列を設定してください。 自動的にアーカイブされるセッションで手動でアーカイブを開始する場合も、このオプションを設定する必要があります。一意の multiArchiveTag を指定しない場合、特定のセッションに対して一度に記録できるアーカイブは 1 つだけです。詳しくは 同時アーカイブ. |

返品 : ザ アーカイブ オブジェクト。このオブジェクトには、アーカイブIDを含む、アーカイブを定義するプロパティが含まれています。

StartArchiveAsync()

Vonage Video API セッションのアーカイブを開始します。

アーカイブの録画を正常に開始するには、クライアントがVonage Video APIセッションにアクティブに接続されている必要があります。

1つのセッションにつき、一度にアーカイブできるのは1つだけです。アーカイブできるのは、Vonage Video API Media Router を使用しているセッション（メディアモードが「routed」に設定されているセッション）のみです。メディアモードが「relayed」に設定されているセッションはアーカイブできません。

なお、のarchiveModeパラメータを設定することで、セッションを自動的にアーカイブすることができます。 CreateSession メソッドを使用します。 ArchiveMode.ALWAYS.

パラメータ : | | | | --- | --- | | sessionId | アーカイブ対象のVonage Video APIセッションのセッションID。 | | name | アーカイブの名前。この名前を使用してアーカイブを識別できます。これは、 アーカイブ オブジェクトであり、これは オープントーク クライアントライブラリ。 | | hasVideo | アーカイブで動画を記録するかどうか（true）または記録しないかどうか（false）。デフォルト値は true（動画を記録する）です。両方を設定した場合 hasAudio そして hasVideo false に設定すると、 StartArchive このメソッドを実行するとエラーが発生します。 | | hasAudio | アーカイブで音声を録音するかどうか（true）または録音しないかどうか（false）。デフォルト値は true（音声が録音される）です。両方を設定すると hasAudio そして hasVideo false に設定すると、 StartArchive このメソッドを実行するとエラーが発生します。 | | outputMode | アーカイブ内のすべてのストリームを単一のファイルに記録するかどうか（OutputMode.COMPOSED（デフォルト）または個々のファイル（OutputMode.INDIVIDUAL). | | 解像度 | アーカイブの解像度。デフォルト値は OutputMode.COMPOSED は「640×480」です。の解像度は指定できません。 OutputMode.INDIVIDUAL. | | layout | アーカイブで使用するレイアウト。type が LayoutType.custom アーカイブのレイアウト方法を指定するために、Vonage にスタイルシートの文字列を提供する必要があります。| | streamMode | アーカイブに含まれるストリームが自動的に選択されるかどうか（StreamMode.Auto（デフォルト）または手動で（StreamMode.Manual). これに伴い、 StreamMode.Manual, アーカイブに含めるストリームは、 OpenTok.AddStreamToArchive そして OpenTok.RemoveStreamFromArchive メソッド（または OpenTok.AddStreamToArchiveAsync そして OpenTok.RemoveStreamFromArchiveAsync メソッド）。 | | multiArchiveTag | 同じセッションの複数のアーカイブを同時に記録できるようにするには、これを設定します。進行中のセッションの同時アーカイブごとに、一意の文字列を設定してください。 自動的にアーカイブされるセッションで手動でアーカイブを開始する場合も、このオプションを設定する必要があります。一意の multiArchiveTag を指定しない場合、特定のセッションに対して一度に記録できるアーカイブは 1 つだけです。詳しくは 同時アーカイブ. |

返品 : ザ アーカイブ オブジェクト。このオブジェクトには、アーカイブIDを含む、アーカイブを定義するプロパティが含まれています。

StartAudioConnectorAsync()

Vonage Video API セッションからのオーディオを WebSocket に送信します。詳細については、 オーディオコネクタ開発者ガイド.

パラメータ : | | | | --- | --- | | request | オーディオコネクタを起動するためのリクエスト。 |

戻り値 : サーバーからの応答オブジェクト。

StartBroadcast()

このメソッドを使用して、Vonage Video API セッションのライブストリーミングを開始します。これにより、セッションが HLS（HTTP ライブストリーミング）または RTMP ストリームとして配信されます。

セッションのブロードキャストを成功裏に開始するには、少なくとも1人のクライアントがセッションに接続していなければならない。

1つのセッションにつき、同時にアクティブなライブストリーミング配信は1つしか設定できません（ただし、複数設定しても意味はありません）。1つのセッションにおいて、ライブストリーミング配信は1つのHLSエンドポイントと、最大5つのRTMPサーバーを同時に配信先として指定できます。 ライブストリーミングを開始できるのは、Vonage Video API Media Router を使用し（メディアモードが「routed」に設定されている）、セッションに限られます。メディアモードが「relayed Vonage Video API Media Router」に設定されているセッションでは、ライブストリーミングを使用することはできません。詳細については、以下を参照してください。 OpenTok メディアルーターとメディアモード。

放送に関する詳細については、以下の 放送開発者ガイド。

パラメータ : | | | | --- | --- | | sessionId | セッションに対応するセッションID。 | | hls | HLS放送を含めるかどうか。 | | rtmpList | リスト RTMP オブジェクト。放送するRTMPストリームを定義します（最大5つ）。 | | 解像度 | 放送用動画の解像度。 有効な解像度は「640x480」、「1280x720」、「1920x1080」、「480x640」、「720x1280」、「1080x1920」ですです。 | | maxDuration | 放送の最大継続時間（秒単位）。最大継続時間に達すると、放送は自動的に停止します。 最大再生時間は、60（60秒）から36000（10時間）までの値に設定できます。デフォルトの最大再生時間は2時間（7,200秒）です。 | | layout | これを指定します BroadcastLayout 放送の初期レイアウトタイプを割り当てるオブジェクト。 | | streamMode | 放送に含まれるストリームが自動的に選択されるかどうか（StreamMode.Auto（デフォルト）または手動で（StreamMode.Manual). これに伴い、 StreamMode.Manual, では、 OpenTok.AddStreamToBroadcast そして OpenTok.RemoveStreamFromBroadcast メソッド（または OpenTok.AddStreamToBroadcastAsync そして OpenTok.RemoveStreamFromBroadcastAsync メソッド）。 | | dvr | DVR機能（巻き戻し、一時停止、再生再開）をサポートするプレーヤーで、この機能を有効にするか（true）、無効にするか（false、デフォルト）を指定します。DVRを有効にすると、HLS URLの末尾に「?DVR」というクエリ文字列が追加されます。詳しくは DVR機能 | | lowLatency | HLSストリームで低遅延モードを有効にするかどうか。一部のHLSプレーヤーは低遅延モードに対応していません。この機能は、DVRモードのHLS配信とは互換性がありません。詳しくは 低遅延HLS放送 | | multiBroadcastTag | 同じセッションに対して複数のブロードキャストを同時にサポートするには、これを設定します。進行中のセッションの同時ブロードキャストごとに、一意の文字列を設定してください。詳しくは 同時放送. | | hasAudio | 放送に音声があるかどうか（デフォルトは true）。 | | hasVideo | 放送に映像があるかどうか（デフォルトは true）。 |

返品 : ザ ブロードキャスト オブジェクト。このオブジェクトには、アーカイブIDを含む、アーカイブを定義するプロパティが含まれています。

StartBroadcastAsync()

このメソッドを使用して、Vonage Video API セッションのライブストリーミングを開始します。これにより、セッションが HLS（HTTP ライブストリーミング）または RTMP ストリームとして配信されます。

セッションのブロードキャストを成功裏に開始するには、少なくとも1人のクライアントがセッションに接続していなければならない。

1つのセッションにつき、同時にアクティブなライブストリーミング配信は1つしか設定できません（ただし、複数設定しても意味はありません）。1つのセッションにおいて、ライブストリーミング配信は1つのHLSエンドポイントと、最大5つのRTMPサーバーを同時に配信先として指定できます。 ライブストリーミングを開始できるのは、Vonage Video API Media Router を使用し（メディアモードが「routed」に設定されている）、セッションに限られます。メディアモードが「relayed Vonage Video API Media Router」に設定されているセッションでは、ライブストリーミングを使用することはできません。詳細については、以下を参照してください。 OpenTok メディアルーターとメディアモード。

放送に関する詳細については、以下の 放送開発者ガイド。

パラメータ : | | | | --- | --- | | sessionId | セッションに対応するセッションID。 | | hls | HLS放送を含めるかどうか。 | | rtmpList | リスト RTMP オブジェクト。放送するRTMPストリームを定義します（最大5つ）。 | | 解像度 | 放送用動画の解像度。 有効な解像度は「640x480」、「1280x720」、「1920x1080」、「480x640」、「720x1280」、「1080x1920」ですです。 | | maxDuration | 放送の最大継続時間（秒単位）。最大継続時間に達すると、放送は自動的に停止します。 最大再生時間は、60（60秒）から36000（10時間）までの値に設定できます。デフォルトの最大再生時間は2時間（7,200秒）です。 | | layout | これを指定します BroadcastLayout 放送の初期レイアウトタイプを割り当てるオブジェクト。 | | streamMode | 放送に含まれるストリームが自動的に選択されるかどうか（StreamMode.Auto（デフォルト）または手動で（StreamMode.Manual). これに伴い、 StreamMode.Manual, では、 OpenTok.AddStreamToBroadcast そして OpenTok.RemoveStreamFromBroadcast メソッド（または OpenTok.AddStreamToBroadcastAsync そして OpenTok.RemoveStreamFromBroadcastAsync メソッド）。 | | dvr | DVR機能（巻き戻し、一時停止、再生再開）をサポートするプレーヤーで、この機能を有効にするか（true）、無効にするか（false、デフォルト）を指定します。DVRを有効にすると、HLS URLの末尾に「?DVR」というクエリ文字列が追加されます。詳しくは DVR機能 | | lowLatency | HLSストリームで低遅延モードを有効にするかどうか。一部のHLSプレーヤーは低遅延モードに対応していません。この機能は、DVRモードのHLS配信とは互換性がありません。詳しくは 低遅延HLS放送 | | multiBroadcastTag | 同じセッションに対して複数のブロードキャストを同時にサポートするには、これを設定します。進行中のセッションの同時ブロードキャストごとに、一意の文字列を設定してください。詳しくは 同時放送. | | hasAudio | 放送に音声があるかどうか（デフォルトは true）。 | | hasVideo | 放送に映像があるかどうか（デフォルトは true）。 |

返品 : ザ ブロードキャスト オブジェクト。このオブジェクトには、アーカイブIDを含む、アーカイブを定義するプロパティが含まれています。

StartRenderAsync()

Vonage Video API セッション用に、新しい Experience Composer レンダラーを起動します。

詳細については、. を参照してください。 Experience Composer 開発者ガイド.

パラメータ : | | | | --- | --- | | request | レンダリングリクエスト。 |

戻り値 : 生成されたレンダリング結果。

StopArchive()

を停止します オープントーク 記録中のアーカイブ。

アーカイブは、120分経過するか、アーカイブ対象のセッションからすべてのクライアントが切断されると、自動的に記録を停止します。

パラメータ : | | | | --- | --- | | archiveId | 記録を停止したいアーカイブのアーカイブID。 |

返品 : ザ アーカイブ 停止されるアーカイブに対応するオブジェクト。

StopArchiveAsync()

を停止します オープントーク 記録中のアーカイブ。

アーカイブは、120分経過するか、アーカイブ対象のセッションからすべてのクライアントが切断されると、自動的に記録を停止します。

パラメータ : | | | | --- | --- | | archiveId | 記録を停止したいアーカイブのアーカイブID。 |

返品 : ザ アーカイブ 停止されるアーカイブに対応するオブジェクト。

StopAudioConnectorAsync()

Vonage Video API セッションへの音声送信を停止します。

パラメータ : | | | | --- | --- | | connectionId | The オープントーク Vonage Video API セッションにおける Audio Connector WebSocket 接続の接続 ID。[AudioConnector.ConnectionId] を参照してください。 |

StopBroadcast()

このメソッドを使用して、Vonage Video API セッションのライブ配信を停止します。なお、配信は開始から 120 分後に自動的に停止します。

放送に関する詳細については、以下の 放送開発者ガイド。

パラメータ : | | | | --- | --- | | broadcastId | 放送セッションの放送ID |

返品 : ザ ブロードキャスト オブジェクト。このオブジェクトには、ブロードキャストIDを含む、ブロードキャストを定義するプロパティが含まれています。

StopBroadcastAsync()

このメソッドを使用して、Vonage Video API セッションのライブ配信を停止します。なお、配信は開始から 120 分後に自動的に停止します。

放送に関する詳細については、以下の 放送開発者ガイド。

パラメータ : | | | | --- | --- | | broadcastId | 放送セッションの放送ID |

返品 : ザ ブロードキャスト オブジェクト。このオブジェクトには、ブロードキャストIDを含む、ブロードキャストを定義するプロパティが含まれています。

StopRenderAsync()

Experience Composerのレンダラーを停止します。

パラメータ : | | | | --- | --- | | renderId | レンダリングのID。 |

物件に関する資料

ApiKey

Vonage Video API キーが OpenTok() コンストラクタを使用する。

ApiSecret

Vonage Video APIのシークレットが OpenTok() コンストラクタを使用する。

クライアント

社内用

デバッグ

コンソールにリクエスト/レスポンスの詳細を出力できるようにします。本番環境では使用しないでください。