コンストラクタ

new OpenTok(apiKey, apiSecret)

OpenTokセッションの作成、トークンの生成、アーカイブの操作などに関するメソッドが含まれています。

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

Webサーバーには、OpenTok Node.js SDKを必ずすべて含めてください。

パラメータ：
名称 タイプ 説明
apiKey ストリング OpenTokのAPIキー。（詳細は Vonage Video API アカウントページ.)
apiSecret ストリング OpenTok APIのシークレット。（詳細については、 Vonage Video API アカウントページ.)

方法

名称 説明
addArchiveStream(archiveId, streamId, archiveOptions, callback) streamMode が「manual」に設定されているアーカイブにストリームを追加します。
addBroadcastStream(broadcastId, streamId, broadcastOptions, callback) streamMode が「manual」に設定されている放送に、ストリームを追加します。
createSession(options, callback) 新しい OpenTok セッションを作成します。
deleteArchive(archiveId, callback) OpenTokのアーカイブを削除します。
dial(sessionId, token, sipUri, options) SIPゲートウェイに接続し、OpenTokセッションに音声のみのストリームを入力します。
disableForceMute(sessionId, callback) セッションのアクティブなミュート状態を解除します。
forceDisconnect(sessionId, connectionId, callback) OpenTokセッションから参加者を切断します。
forceMuteAll(sessionId, opts, callback) セッション内のすべてのストリーム（オプションで指定されたストリームの配列を除く）について、配信中のオーディオをミュートするように強制します。
forceMuteStream(sessionId, streamId, callback) セッション内の特定のストリームの音声を強制的にミュートする。
generateToken(sessionId, options, generateT1Token) OpenTokセッションに接続するためのトークンを作成します。
getArchive(archiveId, callback) を取得します アーカイブ 指定されたアーカイブIDに対応するオブジェクト。
getBroadcast(broadcastId, callback) ライブストリーミング配信に関する情報を返します。
getRender(renderId, callback) を取得します レンダー 指定されたレンダリングIDに対応するオブジェクト。
getStream(sessionId, options, callback) ストリームに関する情報を取得します。
listArchives(options, callback) のリストを取得します アーカイブ APIキーに対応する、完了済みおよび進行中のアーカイブを表すオブジェクト。
listBroadcasts(options, callback) のリストを取得します ブロードキャスト APIキーに対応する、完了済みおよび進行中の放送を表すオブジェクト。
listRenders(options, callback) のリストを取得します レンダー APIキーに対応する、開始中、開始済み、停止中、または失敗中の状態にあるレンダリングを表すオブジェクト。
listStreams(sessionId, callback) のリストを取得します ストリーム セッション内の現在のストリームを表すオブジェクト。
playDTMF(sessionId, connectionId, digits, callback) アクティブな OpenTok セッションのすべての参加者に、またはそのセッションに接続している特定のクライアントに、DTMF 番号を送信します。
removeArchiveStream(archiveId, streamId, callback) streamMode が manual に設定されている複合アーカイブから、ストリームを削除します。
removeBroadcastStream(broadcastId, streamId, callback) streamMode が manual に設定されている放送から、ストリームを削除します。
setArchiveLayout(archiveId, type, stylesheet, screenshareType, callback) 構成済みアーカイブのレイアウトタイプを設定します。
setBroadcastLayout(broadcastId, type, stylesheet, screenshareType, callback) 放送のレイアウトを設定（または更新）します。
setStreamClassLists(sessionId, classListArray, callback) セッション内のストリームのレイアウトクラス一覧を設定します。
signal(sessionId, connectionId, payload, callback) セッション内のすべての接続、または特定の接続に対してシグナルを送信します。
startArchive(sessionId, options, callback) OpenTokセッションのアーカイブを開始します。
startBroadcast(sessionId, options, callback) ライブ配信を開始します。
startCaptions(sessionId, token, options, callback) OpenTokセッションのライブキャプションを開始します。
startCaptions(captionId, callback)
startRender(options, callback) OpenTok セッション用のエクスペリエンス・コンポーザーを起動します。
stopArchive(archiveId, callback) 録画中のOpenTokアーカイブを停止します。
stopBroadcast(broadcastId, callback) ライブ配信を停止します。
stopRender(renderId, callback) レンダリング中のエクスペリエンス・コンポーザーを停止します。
websocketConnect(sessionId, token, websocketUri, options, callback) Vonage Video API セッションからのオーディオを WebSocket に送信します。

addArchiveStream(archiveId, streamId, archiveOptions, callback)

streamMode が manual に設定されているアーカイブに、ストリームを追加します。 同じストリーム ID に対してこのメソッドを繰り返し呼び出すことで、 アーカイブ内のそのストリームの音声または映像の表示/非表示を切り替えることができます。

パラメータ：
名称 タイプ 説明
archiveId ストリング アーカイブID。
streamId ストリング アーカイブに追加するストリームID。
archiveOptions 目的 次のような特性を持つオブジェクト： - hasAudio — 生成されたアーカイブにストリームの音声を含めるかどうか（true：デフォルト、false：含めない）。 - hasVideo — 生成されたアーカイブに、ストリームの動画を含めるかどうか（true：デフォルト、false：含めない）。
callback 機能 操作の完了時に呼び出す関数。この関数には1つの引数が渡されます - error — エラーオブジェクト（メソッドの呼び出しが失敗した場合）。

addBroadcastStream(broadcastId, streamId, broadcastOptions, callback)

streamMode が manual に設定されている放送に、ストリームを追加します。 同じストリーム ID に対してこのメソッドを繰り返し呼び出すことで、 放送におけるそのストリームの音声または映像の表示/非表示を切り替えることができます。

パラメータ：
名称 タイプ 説明
broadcastId ストリング 放送ID。
streamId ストリング ブロードキャストに追加するストリームID。
broadcastOptions 目的 次のような特性を持つオブジェクト： - hasAudio — 配信にストリームの音声を含めるか（true、デフォルト）か、含まないか（false）か。 - hasVideo — 配信にストリームの動画を含めるかどうか（true：デフォルト、false：含めない）。
callback 機能 2つのパラメータを受け取るコールバックメソッド： error、これはエラー発生時にErrorオブジェクトに設定され、 broadcast, これは～に設定されており、 ブロードキャスト 成功時のオブジェクト。

createSession(options, callback)

新しい OpenTok セッションを作成します。セッションは セッション オブジェクトをコールバック 関数に渡します。その sessionId property はセッション ID であり、セッションを一意に識別します。 エラーが発生した場合は、Error オブジェクトがコールバック関数に渡されます。

たとえば、OpenTok.js ライブラリを使用する場合、 OT.initSession() メソッド（OpenTokセッションを初期化するため）。

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

セッションIDの文字列は、最大255文字まで指定できます。 また、以下の方法を使用してセッションを作成することもできます。 OpenTok REST API または、アカウントにログインして Vonage Video API アカウント.

パラメータ：
名称 タイプ 説明
options 目的 このオブジェクトは、セッションのオプションを定義するもので、以下のプロパティ（いずれもオプション）が含まれます： - location (文字列) — OpenTok サーバーが、グローバルな OpenTok ネットワーク内でセッションの位置を特定するために使用する IP アドレス。ロケーションヒントを設定しない場合、OpenTok サーバーは、セッションに最初に接続したクライアントに基づいて位置を特定します。 - e2ee (ブール値) — [end-to-end encryption](https://tokbox.com/developer/guides/end-to-end-encryption/) for the OpenTok session. Set to "true"or"false". - mediaMode (String) — Determines whether the session will transmit streams using the OpenTok Media Router (「打ち負かされた」) or not (「伝達された」). By default, the setting is 「伝達された」. With the mediaModeparameter set to「伝達された」, the session will attempt to transmit streams directly between clients. If clients cannot connect due to firewall restrictions, the session uses the OpenTok TURN server to relay audio-video streams. The [OpenTok Media Router](/opentok/guides/create-session/#media-mode) provides the following benefits: - archiveMode (String) — Whether the session is automatically archived (「いつも」) or not (「マニュアル」). By default, the setting is 「マニュアル」, and you must call the StartArchive()method of the OpenTok object to start archiving. To archive the session (either automatically or not), you must set themediaModeparameter to 「打ち負かされた」. - archiveName(String) — The name of the archives to be used in auto-archived sessions. The length of the archive name can be up to 80 chars. Due to encoding limitations the following special characters are translated to a colon (:) character: ~, -, \_. -アーカイブの解像度(Enum) — The resolution of archives in an auto-archived session. Valid values are "480x640", "640x480", "720x1280", "1280x720", "1080x1920", and "1920x1080". - The OpenTok Media Router can decrease bandwidth usage in multiparty sessions. (When themediaModeparameter is set to「中継」`、各クライアントは、それを購読している各クライアントに対して個別の音声・動画ストリームを送信する必要があります。） - OpenTok Media Router は、以下を通じてユーザー体験の質を向上させることができます。 オーディオのフォールバックとビデオの復旧. これらの機能により、クライアントの接続状態が、購読しているストリームの動画を再生できないほど悪化した場合、そのクライアントでは動画の配信が停止され（他のクライアントには影響しません）、クライアントには音声のみが配信されます。クライアントの接続状態が改善すると、動画の配信が再開されます。 - OpenTok Media Router は、 アーカイビング OpenTokセッションの録画、保存、および再生ができる機能です。
callback 機能 操作が完了したときに呼び出される関数です。この関数には、2つの引数が渡されます： - error — 失敗した場合、このパラメータには Error オブジェクトが設定されます。詳細については、エラーメッセージを確認してください。成功した場合は、null が設定されます。 - session — 成功した場合、このパラメータは セッション オブジェクト。このオブジェクトの sessionId プロパティは、セッションのセッション ID です。エラーが発生した場合、このパラメータは設定されません。

deleteArchive(archiveId, callback)

OpenTokのアーカイブを削除します。

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

パラメータ：
名称 タイプ 説明
archiveId ストリング 削除したいアーカイブのアーカイブID。
callback 機能 操作の完了時に呼び出される関数。アーカイブの削除に成功した場合、この関数は引数なしで呼び出されます。失敗した場合は、エラーオブジェクトが関数に渡されます。

dial(sessionId, token, sipUri, options)

SIPゲートウェイに接続し、OpenTokセッションに音声のみのストリームを入力します。SIP 機能の一部です。

パラメータ：
名称 タイプ 説明
sessionId ユーザーが接続するセッションに対応するセッションID。
token SIPユーザーが接続に使用するセッションIDのトークン。
sipUri SIP相互接続機能が発信するSIP URI。
options 目的 以下のプロパティを持つオプションのオプションオブジェクト（いずれもオプションです）： - headers (オブジェクト) — OpenTokからサードパーティのSIPプラットフォームに対して送信されるSIP INVITEリクエストに追加されるカスタムヘッダー。 - auth (オブジェクト) — サードパーティ製のSIPプラットフォームでHTTPダイジェスト認証が要求される場合に使用する認証情報。 - "username" -- SIP INVITEで使用するユーザー名。 - "password" -- SIP INVITE で使用するパスワード。 - secure (ブール値) — SIPメディアストリームを暗号化して送信するかどうか。 - from (文字列) — 発信者として最終的なSIP番号に送信される番号または文字列。以下の形式の文字列でなければなりません。 from@example.comここで from 文字列または数値です。 もし from は数値に設定されます（例えば、 "14155550101@example.com"), PSTN電話では発信元番号として表示されます。 もし from 未定義であるか、文字列に設定されている（例えば、 "joe@example.com"), +00000000 PSTN電話では、発信元番号として表示されます。 - video (ブール値) — SIP コールにビデオが含まれるかどうかを示すブール値のフラグ (true)または(false（デフォルト設定）。ビデオが含まれている場合、SIPクライアントのビデオは、OpenTokセッションに送信されるOpenTokストリームに含まれます。SIPクライアントは、OpenTokセッション内で公開されたストリームを動的に合成したビデオストリームを受信します。これはベータ機能です。 - observeForceMute (任意) SIPエンドポイントが、モデレーターなどの他のクライアントによる強制ミュート操作を遵守するかどうか（true) あるいはそうでない場合（false（デフォルト設定）。参照： セッション内のストリームの音声をミュートする. - streams (オプション) SIP参加者がサブスクライブする参加者のストリームID。指定がない場合は、セッション内のすべてのストリームが選択されます。
リターンズ

A SipInterconnect 以下のプロパティを持つオブジェクト：

  • id -- SIP通話の固有の会議ID
  • connectionId -- SIP通話を表す音声専用ストリームの 接続ID
  • streamId -- SIP通話を表す、音声のみのストリームの ストリームID

disableForceMute(sessionId, callback)

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

を呼び出した後 OpenTok.forceMuteAll() メソッドを 呼び出した後、配信されるすべてのストリームは、音声がミュートされた状態で配信されます。 OpenTok.disableForceMute() このメソッドを使用すると、セッションに公開された将来のストリームは ミュートされません（ただし、すでにミュートされているストリームは引き続きミュートされたままです）。

パラメータ：
名称 タイプ 説明
sessionId セッションID。
callback 機能 操作の完了時に呼び出される関数。この関数には1つの引数が渡されます。 error — 呼び出しが失敗したことを示すエラー。呼び出しが成功した場合は、null に設定されます。

forceDisconnect(sessionId, connectionId, callback)

OpenTokセッションから参加者を切断します。 これは、サーバー側における OpenTok.js の forceDisconnect() メソッド

パラメータ：
名称 タイプ 説明
sessionId 切断したいクライアントが接続している OpenTok セッションのセッション ID。
connectionId 切断したいクライアントの接続ID。
callback 機能 操作の完了時に呼び出す関数。この関数には 2 つの引数が渡されます： - error — エラーオブジェクト（メソッドの呼び出しが失敗した場合）。

forceMuteAll(sessionId, opts, callback)

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

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

パラメータ：
名称 タイプ 説明
sessionId セッションID。
opts 以下のプロパティを含むオブジェクト： - excudedStreamIds (文字列の配列) — ミュート対象から除外するストリーム ID の配列。これはオプションです。このプロパティを設定しない場合、セッション内のすべての配列がミュートされます。
callback 機能 操作の完了時に呼び出される関数。この関数には1つの引数が渡されます。 error — 呼び出しが失敗したことを示すエラー。呼び出しが成功した場合は、null に設定されます。

forceMuteStream(sessionId, streamId, callback)

セッション内の特定のストリームの音声を強制的にミュートする。

パラメータ：
名称 タイプ 説明
sessionId ストリング セッションID。
streamId ストリング ストリームID。
callback 機能 操作の完了時に呼び出される関数。この関数には1つの引数が渡されます。 error — 呼び出しが失敗したことを示すエラー。呼び出しが成功した場合は、null に設定されます。

generateToken(sessionId, options, generateT1Token)

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

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

パラメータ：
名称 タイプ 説明
sessionId ユーザーが接続するセッションに対応するセッションID。
options トークンのオプションを定義するオブジェクト（各オプションは任意です）： - role (文字列) — トークンのロール。各ロールは、そのトークンに付与される一連の権限を定義します： - 'subscriber' — 購読者はストリームのみを購読できます。 - 'publisher' — パブリッシャーは、ストリームの配信、ストリームの購読、およびシグナルの送信を行うことができます。（ロールを指定しない場合のデフォルト値です。） - 'publisheronly' — パブリッシャーはストリームを配信することしかできず、 ストリームを購読することはできません。 - 'moderator' — 配信者に付与される権限に加え、モデレーターは、クライアントの接続切断、配信の停止、または配信中のストリームの音声ミュートなどのモデレーション機能を実行できます。詳細は、 モデレーション開発者ガイド. - expireTime (数値) — トークンの有効期限。UNIXエポックからの経過時間を秒単位で指定します。有効期限の上限は、作成時刻から30日後です。小数点が指定された場合は、最も近い整数に切り捨てられます。デフォルトの有効期限は、トークン作成時刻から24時間後です。 - data (文字列) — エンドユーザーに関する接続メタデータを含む文字列。たとえば、ユーザー ID、名前、またはエンドユーザーに関するその他のデータを渡すことができます。文字列の長さは 1000 文字までに制限されています。このデータは、一度設定されると更新することはできません。 - initialLayoutClassList (配列) — クライアントによって公開されるストリームの初期レイアウトクラスとして使用されるクラス名（文字列）の配列。レイアウトクラスは、動画のレイアウトをカスタマイズする際に使用されます。 ライブ配信 放送 そして 作成済み アーカイブ.
generateT1Token 接続トークンは、SHA-256で署名されたJWTになりました。これを次のように設定してください。 true レガシーT1形式を使用してトークンを作成するには。
リターンズ

トークンの文字列。

getArchive(archiveId, callback)

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

パラメータ：
名称 タイプ 説明
archiveId ストリング アーカイブID。
callback 機能 操作の完了時に呼び出す関数。この関数には 2 つの引数が渡されます： - error — エラーオブジェクト（メソッドの呼び出しが失敗した場合）。 - archive - について アーカイブ オブジェクトがある。

getBroadcast(broadcastId, callback)

ライブストリーミング配信に関する情報を返します。

パラメータ：
名称 タイプ 説明
broadcastId ストリング ブロードキャストのID。
callback 機能 2つのパラメータを受け取るコールバックメソッド： error、これはエラー発生時にErrorオブジェクトに設定され、 broadcast, これは～に設定されており、 ブロードキャスト 成功時のオブジェクト。

getRender(renderId, callback)

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

パラメータ：
名称 タイプ 説明
renderId ストリング レンダリングID。
callback 機能 操作の完了時に呼び出す関数。この関数には 2 つの引数が渡されます： - error — エラーオブジェクト（メソッドの呼び出しが失敗した場合）。 - render - について レンダー オブジェクトがある。

getStream(sessionId, options, callback)

ストリームに関する情報を取得します。このストリームは、OpenTok セッション内でアクティブなストリームである必要があります。

パラメータ：
名称 タイプ 説明
sessionId ストリング ストリームを含む OpenTok セッションのセッション ID。
options ストリング ストリームID。
callback 機能 操作の完了時に呼び出す関数。この関数には 2 つの引数が渡されます： - error — エラーオブジェクト（メソッドの呼び出しが失敗した場合）。エラーがない場合は null に設定されます。無効なストリーム ID または無効なセッション ID をこのメソッドに渡すと、エラーが発生します。 - stream - について ストリーム オブジェクト。このオブジェクトには、ストリームを定義するプロパティが含まれています。エラーが発生した場合は、この値は未定義となります。

listArchives(options, callback)

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

パラメータ：
名称 タイプ 説明
options 目的 3つのプロパティを持つオプションパラメータ： - count — 返すアーカイブの最大数。デフォルトでは、50件のアーカイブが返されます（アーカイブが50件未満の場合は、その数まで）。このメソッドは最大で1000件のアーカイブを返します。 - offset — リストの先頭に表示される最初のアーカイブのオフセット（オフセット 0 として記録された最初のアーカイブから数えて）。1 は、最新のアーカイブの前に開始されたアーカイブのオフセットです。このプロパティはオプションであり、デフォルトは 0 です。 - sessionId — 特定のセッションのアーカイブを取得するには、そのセッションのIDを指定してください。このプロパティはオプションです。セッションIDが指定されていない場合、このメソッドは、そのAPIキーで作成されたすべてのセッションのアーカイブを返します。もし options 引数が指定された場合、このメソッドは、最初に記録されたアーカイブから順に、最大1000個のアーカイブを返します。
callback 機能 操作の完了時に呼び出す関数。この関数には 2 つの引数が渡されます： - error — エラーオブジェクト（メソッドの呼び出しが失敗した場合）。 - archives - の配列。 アーカイブ オブジェクトがある。

listBroadcasts(options, callback)

のリストを取得します ブロードキャスト APIキーに対応する、 完了済みおよび進行中の放送を表すオブジェクト。

パラメータ：
名称 タイプ 説明
options 目的 3つのプロパティを持つオプションパラメータ： - count — 返すブロードキャストの最大数。デフォルトでは、50件のブロードキャストが返されます（ブロードキャストが50件未満の場合は、その数までが返されます）。このメソッドは、最大で1000件のブロードキャストを返します。 - offset — リストの先頭にある放送のオフセット（オフセット 0 として記録された最初の放送から数えて）。1 は、最新の放送より前に開始された放送のオフセットです。このプロパティはオプションであり、デフォルトは 0 です。 - sessionId — 特定のセッションのブロードキャストを取得するには、そのセッションの ID を指定してください。このプロパティはオプションです。セッション ID が指定されていない場合、このメソッドは、あなたの API キーで作成されたすべてのセッションからのブロードキャストを返します。もし options 引数が指定された場合、このメソッドは、記録された最初のブロードキャストから順に、最大1000件のブロードキャストを返します。
callback 機能 操作の完了時に呼び出す関数。この関数には 2 つの引数が渡されます： - error — エラーオブジェクト（メソッドの呼び出しが失敗した場合）。 - broadcasts - の配列。 ブロードキャスト オブジェクトがある。

listRenders(options, callback)

のリストを取得します レンダー APIキーに対応する、開始中、 開始済み、停止中、または失敗中の状態にあるレンダリングを表すオブジェクト。

パラメータ：
名称 タイプ 説明
options 目的 3つのプロパティを持つオプションパラメータ： - count — 返すレンダリング結果の最大数。デフォルトでは、50件（レンダリング結果が50件未満の場合はその数）が返されます。このメソッドは最大1000件のレンダリング結果を返します。 - offset — リストの先頭にあるレンダリングのオフセット（オフセット 0 として記録された最初のレンダリングから数えて）。1 は、最新のレンダリングより前に開始されたレンダリングのオフセットです。このプロパティはオプションであり、デフォルトは 0 です。 - sessionId — 特定のセッションのレンダリングを取得するには、そのセッションの ID を指定してください。このプロパティはオプションです。セッション ID が指定されていない場合、このメソッドは、指定された API キーで作成されたすべてのセッションのレンダリングを返します。もし options 引数が指定された場合、このメソッドは、最初に記録されたレンダリングから順に、最大1000件のレンダリング結果を返します。
callback 機能 操作の完了時に呼び出す関数。この関数には 2 つの引数が渡されます： - error — エラーオブジェクト（メソッドの呼び出しが失敗した場合）。 - renders - の配列。 レンダー オブジェクトがある。

listStreams(sessionId, callback)

のリストを取得します ストリーム セッション内の現在のストリームを表すオブジェクト。

パラメータ：
名称 タイプ 説明
sessionId ストリング ストリームを含む OpenTok セッションのセッション ID。
callback 機能 操作の完了時に呼び出す関数。この関数には 2 つの引数が渡されます： - error — エラーオブジェクト（メソッドの呼び出しが失敗した場合）。エラーがない場合は null に設定されます。無効なセッション ID を渡してこのメソッドを呼び出すと、エラーが発生します。 - streams - の配列。 ストリーム オブジェクト。各 Stream オブジェクトには、ストリームを定義するプロパティが含まれています。エラーが発生した場合は、この値は未定義となります。

playDTMF(sessionId, connectionId, digits, callback)

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

パラメータ：
名称 タイプ 説明
sessionId DTMF文字列を受信するセッションに対応するセッションID。
connectionId DTMF信号を送信するクライアントの接続IDです。セッションに接続されているすべてのクライアントにDTMF信号を送信する場合は、この欄を空欄のままにしてください。
digits これは送信するDTMF数字の文字列です。0～9、'*'、'#'、および'p'を含めることができます。'p'は500msの休止を表します（数字の送信に遅延を加える必要がある場合）。
callback 機能 操作の完了時に呼び出す関数。この関数には1つの引数が渡されます： - error — エラーオブジェクト（メソッドの呼び出しが失敗した場合）。エラーがない場合は、null に設定されます。

removeArchiveStream(archiveId, streamId, callback)

streamMode が manual に設定されている複合アーカイブから、ストリームを削除します。

パラメータ：
名称 タイプ 説明
archiveId ストリング アーカイブID。
streamId ストリング アーカイブから削除するストリームID。
callback 機能 操作の完了時に呼び出す関数。呼び出しが失敗した場合は、エラーがこの関数に渡されます。

removeBroadcastStream(broadcastId, streamId, callback)

streamMode が manual に設定されている放送から、ストリームを削除します。

パラメータ：
名称 タイプ 説明
broadcastId ストリング 放送ID。
streamId ストリング 放送から削除するストリームID。
callback 機能 操作の完了時に呼び出す関数。呼び出しが失敗した場合は、エラーがこの関数に渡されます。

setArchiveLayout(archiveId, type, stylesheet, screenshareType, callback)

構成済みアーカイブのレイアウトタイプを設定します。レイアウトタイプの詳細については、以下を参照してください。 アーカイブ内の 動画レイアウトのカスタマイズ.

パラメータ：
名称 タイプ 説明
archiveId ストリング アーカイブID。
type ストリング レイアウトの種類。これを「bestFit」、「pip」、「verticalPresentation」、「horizontalPresentation」、「focus」、または「custom」に設定します。これらのレイアウトの種類に関する説明については、以下を参照してください。 構成されたアーカイブのビデオレイアウトをカスタマイズする.
stylesheet ストリング （オプション）カスタムレイアウト用のスタイルシート。以下の設定を行う場合は、このパラメータを設定してください。 type への "custom". それ以外の場合は、未定義のままにするか、null に設定してください。
screenshareType ストリング （オプション）セッションに画面共有ストリームが含まれている場合に使用するレイアウトの種類。なお、このパラメータを使用するには、 type パラメータを「bestFit」に設定し、 stylesheet パラメータを null.
callback 機能 操作の完了時に呼び出す関数。エラーが発生した場合は、 error オブジェクトが関数に渡されます。成功した場合は、エラーオブジェクトが渡されることなく関数が呼び出されます。

setBroadcastLayout(broadcastId, type, stylesheet, screenshareType, callback)

放送のレイアウトを設定（または更新）します。詳しくは OpenTokライブ配信の動画レイアウトの設定.

パラメータ：
名称 タイプ 説明
broadcastId ストリング ブロードキャストのID。
type ストリング レイアウトの種類。これを「bestFit」、「pip」、「verticalPresentation」、「horizontalPresentation」、「focus」、または「custom」に設定します。これらのレイアウトの種類に関する説明については、以下を参照してください。 OpenTokライブ配信のレイアウト設定.
stylesheet ストリング （オプション）カスタムレイアウト用のスタイルシート。以下の設定を行う場合は、このパラメータを設定してください。 type 「custom」に設定します。それ以外の場合は、未定義のままにするか、 null.
screenshareType ストリング （オプション）セッションに画面共有ストリームが含まれている場合に使用するレイアウトの種類。なお、このパラメータを使用するには、 type パラメータを「bestFit」に設定し、 stylesheet パラメータを null.
callback 機能 操作の完了時に呼び出す関数です。エラーが発生した場合は、Errorオブジェクトが関数に渡されます。正常に完了した場合は、Errorオブジェクトが渡されずに関数が呼び出されます。

setStreamClassLists(sessionId, classListArray, callback)

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

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

パラメータ：
名称 タイプ 説明
sessionId ストリング ストリームが属するセッションのセッションID。
classListArray 配列 (オプション) ストリームに適用するクラス一覧を定義する配列。この配列の各要素は、2つのプロパティを持つオブジェクトです： id そして layoutClassList.その id property はストリーム ID（文字列）であり、 layoutClassList は、ストリームに適用するクラス名（文字列）の配列です。設定 layoutClassList ストリームのレイアウトクラス一覧をクリアするには、空の配列を指定します。たとえば、これは streamClassArray array は、3 つのストリームのレイアウトクラス一覧を設定します： const classListArray = [ { id: '7b09ec3c-26f9-43d7-8197-f608f13d4fb6', layoutClassList: ['focus'] }, { id: '567bc941-6ea0-4c69-97fc-70a740b68976', layoutClassList: ['top'] }, { id: '307dc941-0450-4c09-975c-705740d08970', layoutClassList: ['bottom'] } ];
callback 機能 操作の完了時に呼び出す関数。エラーが発生した場合は、 error オブジェクトが関数に渡されます。成功した場合は、エラーオブジェクトが渡されることなく関数が呼び出されます。

signal(sessionId, connectionId, payload, callback)

セッション内のすべての接続、または特定の接続に対してシグナルを送信します。

クライアントにシグナルを正常に送信するには、クライアントがOpenTokセッションに アクティブに接続されている必要があります。

詳細は OpenTokのシグナリング 番組表。

パラメータ：
名称 タイプ 説明
sessionId シグナルを送信したい OpenTok セッションのセッション ID。
connectionId セッションに接続しているクライアントの接続IDです。セッション内のすべての接続にシグナルを送信したい場合は、この欄を空欄のままにしてください。
payload オプション付きのオブジェクト data そして type プロパティ： - data — 送信するデータ。データ文字列の長さの制限は 8kB です。データ文字列を null または undefined に設定しないでください。 - type — シグナルのタイプ。クライアントはこのタイプを使用してシグナルをフィルタリングできます。タイプ文字列の最大長は128文字です。
callback 機能 メソッドの呼び出しが成功または失敗した際に呼び出されるコールバック関数です。呼び出しが失敗した場合、エラーオブジェクトがコールバック関数に渡されます。

startArchive(sessionId, options, callback)

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

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

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

パラメータ：
名称 タイプ 説明
sessionId アーカイブするOpenTokセッションのセッションID。
options 目的 以下のプロパティを持つオプションのオプションオブジェクト（各プロパティは任意です）： - name (文字列) — アーカイブの名前。アーカイブを識別するために使用できます。この名前は Archive オブジェクトのプロパティとして設定され、OpenTok クライアントライブラリにおけるアーカイブ関連のイベントのプロパティとしても使用されます。 - hasAudio (ブール値) — アーカイブにオーディオトラックを含めるかどうか (true)または(false).デフォルト値は true （音声トラックが含まれています）。両方を設定すると hasAudio そして hasVideo への false, への呼び出し startArchive() このメソッドを実行するとエラーが発生します。 - hasVideo (ブール値) — アーカイブにビデオトラックを含めるかどうか (true) または (ではない false).デフォルト値は true （ビデオトラックが含まれています）。両方を設定すると hasAudio そして hasVideo への false, への呼び出し startArchive() このメソッドを実行するとエラーが発生します。 - outputMode (文字列) — アーカイブ内のすべてのストリームを単一のファイルに記録するか（「composed」、デフォルト）、個別のファイルに記録するか（「individual」）を指定します。 - layout (オブジェクト) — 構成済みアーカイブの初期レイアウト設定を定義するオブジェクト。このオブジェクトには、次の3つのプロパティがあります： type, stylesheetそして screenshareType、これらはそれぞれ文字列です。 設定 type 「bestFit」、「pip」、「verticalPresentation」、「horizontalPresentation」、または「custom」に設定します。 stylesheet 条件が満たされる場合 type を「カスタム」に設定し、カスタムレイアウトを定義するスタイルシートを指定します。たとえば、 layout 対象 { type: "pip" } アーカイブの初期レイアウトをピクチャー・イン・ピクチャーに設定するには、以下を設定します。 screenshareType セッションに画面共有ストリームが存在する場合に使用するレイアウトタイプを指定するプロパティ （このプロパティはオプションです。） なお、このプロパティを設定する場合は、 screenshareType プロパティについては、必ず type プロパティを「bestFit」に設定し、 stylesheet プロパティが設定解除されました。詳細については、以下を参照してください。 コンパイル済みアーカイブの動画レイアウトのカスタマイズ. - resolution (文字列) — 複合アーカイブの場合、これをアーカイブの解像度に設定します。有効な値は「1920x1080」、「1280x720」、または「640x480」（デフォルト）です。 - streamMode (オプション) — アーカイブのストリームモード。以下のいずれかに設定できます。 - "auto" — アーカイブに含まれるストリームは自動的に選択されます (デフォルト)。 - "manual" — OpenTok.addArchiveStream() の呼び出しに基づいて、アーカイブに含めるストリームを指定します。 OpenTok.removeArchiveStream() メソッド。 - multiArchiveTag (文字列) — 同じセッションの複数のアーカイブを同時に記録できるようにするには、これを設定します。進行中のセッションの同時アーカイブごとに、一意の文字列を設定してください。また、自動的にアーカイブされるアーカイブを手動で開始する場合も、このオプションを設定する必要があります。なお、 multiArchiveTag アーカイブの一覧表示やアーカイブ情報の取得を行うメソッドのレスポンスには、この値は含まれません。一意の multiArchiveTag 特定のセッションでは、一度に1つのアーカイブしか記録できません。 - maxBitrate (数値) — アーカイブの最大ビデオビットレート（ビット/秒単位）。このオプションは、合成アーカイブでのみ有効です。 合成アーカイブのサイズを制御するには、動画の最大ビットレートを設定してください。この最大ビットレートは、動画のビットレートにのみ適用されます。出力アーカイブに音声が含まれている場合、そのビットは制限の対象外となります。アーカイブおよびアーカイブファイル形式の詳細については、 OpenTokのアーカイブ機能 プログラミングガイド
callback 機能 操作の完了時に呼び出す関数。この関数には 2 つの引数が渡されます： - error — エラーオブジェクト（メソッドの呼び出しが失敗した場合）。 - archive - について アーカイブ オブジェクト。このオブジェクトには、アーカイブIDを含む、アーカイブを定義するプロパティが含まれています。

startBroadcast(sessionId, options, callback)

ライブ配信を開始します。詳しくは ライブ ストリーミング配信 開発者ガイド

パラメータ：
名称 タイプ 説明
sessionId ストリング 配信するセッションのID。
options 目的 次のような形式のオブジェクト： { outputs: { hls: { dvr: false, lowLatency: false, }, rtmp: [{ id: "foo", serverUrl: "rtmp://myfooserver/myfooapp", streamName: "myfoostream" }, { id: "bar", serverUrl: "rtmp://mybarserver/mybarapp", streamName: "mybarstream" }] }, maxDuration: 5400, resolution: "640x480", layout: { type: "custom", stylesheet: "the layout stylesheet (only used with type == custom)", screenshareType: "the layout type to use when there is a screen-sharing stream (optional)" }, streamMode: "manual" } その options このオブジェクトには、以下のプロパティが含まれています： - outputs (必須) — このオブジェクトは、開始したい配信ストリームの種類を定義します。配信ストリームとして、HLS、RTMP、あるいはその両方を指定できます。RTMPストリーミングを含める場合、最大5つの（または1つの）ターゲットRTMPストリームを指定できます。HLSの場合は、1つの hls outputs オブジェクト内のプロパティ。このオブジェクトには、以下のオプションのプロパティが含まれます： - dvr (ブール値) — 有効にするかどうか DVR機能 — 巻き戻し、一時停止、 および再生再開 — これらに対応しているプレーヤーでは（true), あるいはそうでない場合 (false（デフォルト設定）。DVRを有効にすると、HLS URLには ?DVR 末尾にクエリ文字列が追加されています。 - lowLatency (ブール値) — 有効にするかどうか 低遅延モード HLS ストリームの場合。一部の HLS プレーヤーは低遅延モードに対応していません。この機能は、DVR モードの HLS 放送とは互換性がありません。HLS URL は broadcastUrls として hls の内のプロパティ ブロードキャスト のコールバックメソッドに渡されたオブジェクト OpenTok#getBroadcast および OpenTok#listBroadcast メソッド。各 RTMP ストリームについて、以下を指定します。 serverUrl (RTMPサーバーのURL)、 streamName （ストリーム名。YouTube Liveのストリーム名やFacebookのストリームキーなど）および（任意で） id （ストリームの一意のID）。 IDを指定すると、それが id の属性 ブロードキャスト のコールバックメソッドに渡されたオブジェクト startBroadcast() メソッドと OpenTok.getBroadcast() 方法。OpenTokは、指定した各RTMP URLにセッションをストリーミングします。なお、OpenTokのライブストリーミングでは、RTMPおよびRTMPSがサポートされています。 - maxDuration (オプション) — ブロードキャストの最大継続時間（秒単位）。 最大継続時間に達すると、ブロードキャストは自動的に停止します。最大継続時間は、60（60秒）から36000（10時間）までの値に設定できます。デフォルトの最大継続時間は4時間（14,400秒）です。 - resolution （任意） — ブロードキャストの解像度：以下のいずれか "640x480" (SD、デフォルト)、 "1280x720" (HD) または "1920x1080" (FHD)。 layout (オプション) — 放送の初期レイアウトタイプを指定するには、これを指定します。このオブジェクトには、次の 3 つのプロパティがあります： type, stylesheetそして screenshareType、これらはそれぞれ文字列です。の有効な値は type プロパティは以下の通りです "bestFit" (ベストフィット）、 "custom" (カスタム）、 "horizontalPresentation" (水平プレゼンテーション）、 "pip" (ピクチャー・イン・ピクチャー）、そして "verticalPresentation" （縦向き表示）。もし "custom" レイアウト・タイプを設定します。 stylesheet プロパティの layout スタイルシートに異議を唱える。（その他のレイアウトタイプについては、 stylesheet プロパティ。）初期レイアウトタイプを指定しない場合、ブロードキャストストリームでは「Best Fit」レイアウトタイプが使用されます。 screenshareType セッションに画面共有ストリームが存在する場合に使用するレイアウトタイプを指定するプロパティです。（このプロパティはオプションです。）なお、 screenshareType プロパティについては、 type プロパティを "bestFit "に設定する。 stylesheet プロパティは設定されていません。詳しくは OpenTokライブ配信の動画レイアウトの設定).- streamMode (オプション) — ブロードキャストのストリームモード。以下のいずれかに設定できます。 - "auto" — ブロードキャストに含まれるストリームは自動的に選択されます (デフォルト)。 - "manual" — への呼び出しに基づいて、含めるストリームを指定します。 OpenTok.addBroadcastStream() そして OpenTok.removeBroadcastStream() メソッド。 - multiBroadcastTag (オプション) — 同じセッションに対して複数の同時配信をサポートするには、これを設定します。進行中のセッションの各同時配信について、一意の文字列を設定してください。なお、 multiBroadcastTag ライブストリーミング放送の一覧を表示するメソッドおよびライブストリーミング放送に関する情報を取得するメソッドのレスポンスには、この値は含まれません。
callback 機能 2つのパラメータを受け取るコールバックメソッド： error、これはエラー発生時にErrorオブジェクトに設定され、 broadcast, これは～に設定されており、 ブロードキャスト 成功時のオブジェクト。

startCaptions(sessionId, token, options, callback)

OpenTokセッションのライブキャプションを開始します。

許可される最大時間は4時間です。この時間を過ぎると、音声キャプションは停止しますが、 進行中のOpenTokセッションには何の影響もありません。キャプションの開始時にコールバックURLが 指定されている場合、そのURLにイベントが送信されます。

各OpenTokセッションでは、1つの音声キャプションセッションのみをサポートしています。

パラメータ：
名称 タイプ 説明
sessionId アーカイブするOpenTokセッションのセッションID。
token 「Moderator」に設定された、有効なOpenTokトークン。
options 目的 以下のプロパティを持つオプションのオプションオブジェクト（各プロパティは任意です）： - languageCode (文字列) — この通話で使用される話し言葉の BCP-47 コード。デフォルト値は「en-US」です。 以下の言語コードがサポートされています: "en-AU" (英語、オーストラリア)、"en-GB" (英語、英国)、"en-us" (英語、米国)、"es-US" (スペイン語、米国)、 "zh-CN" （中国語、簡体字）、「fr-FR」（フランス語）、「fr-CA」（フランス語、カナダ）、「de-DE」（ドイツ語）、「hi-IN」（ヒンディー語、インド）、「it-IT」 （イタリア語）、「ja-JP」（日本語）、 「ko-KR」（韓国語）、「pt-BR」（ポルトガル語、ブラジル）、「th-TH」（タイ語）。 - maxDuration (整数) — 音声キャプションの最大再生時間（秒単位）。デフォルト値は 14,400 秒（4 時間）で、これは許可される最大再生時間です。maxDuration の最小値は 300（300 秒、つまり 5 分）です。- partialCaptions (ブール値) — ある程度の不正確さを許容する代わりに、キャプションの生成を高速化するためにこの機能を有効にするかどうか。デフォルト値は true です。キャプションの詳細については、 OpenTokの字幕 プログラミングガイド
callback 機能 操作の完了時に呼び出す関数。この関数には 2 つの引数が渡されます： - error — エラーオブジェクト（メソッドの呼び出しが失敗した場合）。 - captionID — キャプションのID

startCaptions(captionId, callback)

OpenTokセッションのライブキャプションを停止する

パラメータ：
名称 タイプ 説明
captionId アーカイブする OpenTok セッションのセッション ID。キャプションの詳細については、 OpenTokの字幕 プログラミングガイド
callback 機能 操作の完了時に呼び出す関数。この関数には 2 つの引数が渡されます： - error — エラーオブジェクト（メソッドの呼び出しが失敗した場合）。 - success — 常に真実

startRender(options, callback)

OpenTok セッション用の Experience Composer を起動します。Experience Composer インスタンスは、Render オブジェクトとして表現されます。 詳細については、 Experience Composer 開発者ガイド.

セッションのレンダリングを正常に開始するには、クライアントがOpenTokセッションに アクティブに接続されている必要があります。

パラメータ：
名称 タイプ 説明
options 目的 以下のプロパティを持つオプションのオプションオブジェクト（各プロパティは任意です）： - sessionId (文字列) — セッションの ID（同じ APIKEY（URLで指定されている通り）レンダリングを開始したい対象として、 token (文字列) — Publisher ロールを持つ有効な OpenTok トークン、および（オプションで）出力ストリームに関連付ける接続データ。 - url (文字列) — 顧客が管理し、ユーザーの操作を必要とせずにレンダリング対象のコンテンツを生成できる、一般に公開されているURL。 - properties (オブジェクト) — 合成出力ストリームの Publisher プロパティの初期設定。 - maxDuration (数値) — レンダリングに許容される最大時間（秒単位）。この時間が経過してもレンダリングが実行中の場合は、自動的に停止されます。 - resolution (文字列) — コンポジションの表示領域の解像度。
callback 機能 操作の完了時に呼び出す関数。この関数には 2 つの引数が渡されます： - error — エラーオブジェクト（メソッドの呼び出しが失敗した場合）。 - render - について レンダー オブジェクト。このオブジェクトには、レンダリング ID を含む、レンダリングを定義するプロパティが含まれています。

stopArchive(archiveId, callback)

録画中のOpenTokアーカイブを停止します。

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

録画されていないアーカイブを停止することはできません。

パラメータ：
名称 タイプ 説明
archiveId ストリング 記録を停止したいアーカイブのアーカイブID。
callback 機能 操作の完了時に呼び出す関数。この関数には 2 つの引数が渡されます： - error — エラーオブジェクト（メソッドの呼び出しが失敗した場合）。 - archive - について アーカイブ オブジェクトがある。
リターンズ

について アーカイブ 停止中のアーカイブに対応するオブジェクト。

stopBroadcast(broadcastId, callback)

ライブ配信を停止します。

パラメータ：
名称 タイプ 説明
broadcastId ストリング ブロードキャストのID。
callback 機能 2つのパラメータを受け取るコールバックメソッド： error、これはエラー発生時にErrorオブジェクトに設定され、 broadcast, これは～に設定されており、 ブロードキャスト 成功時のオブジェクト。

stopRender(renderId, callback)

レンダリング中のエクスペリエンス・コンポーザーを停止します。

パラメータ：
名称 タイプ 説明
renderId ストリング レンダリングを停止したいレンダリングのID。
callback 機能 操作の完了時に呼び出す関数。この関数には 2 つの引数が渡されます： - error — エラーオブジェクト（メソッドの呼び出しが失敗した場合）。 - render - について レンダー オブジェクトがある。
リターンズ

について アーカイブ 停止中のアーカイブに対応するオブジェクト。

websocketConnect(sessionId, token, websocketUri, options, callback)

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

パラメータ：
名称 タイプ 説明
sessionId ストリング (必須) WebSocket ストリームに含めたい OpenTok ストリームを含む OpenTok セッション ID
token ストリング (必須) OpenTokセッションへのオーディオストリーマー接続に使用するOpenTokトークン。このトークンデータを使用して、その接続がオーディオストリーマーエンドポイントであることを識別したり、その他の識別情報として利用したりすることができます。
websocketUri ストリング (必須) オーディオストリームの送信先として使用する、一般に公開されている WebSocket URI（例：「wss://service.com/ws-endpoint」など）。
options 目的 以下のプロパティを持つオプションのオプションオブジェクト（いずれもオプションです）： - streams (配列) — WebSocket ストリームに含めたい OpenTok ストリームの ID の配列。このプロパティを省略した場合、セッション内のすべてのストリームが含まれます。 - headers (オブジェクト) — 各メッセージとともに WebSocket サーバーへ送信されるヘッダーのキーと値のペアからなるオブジェクト。最大長は 512 バイトです。
callback 機能 操作の完了時に呼び出す関数。エラーが発生した場合は、 error オブジェクトが関数の最初のパラメータとして渡されます。成功した場合、関数は（最初のパラメータとして）エラーオブジェクトが渡されることなく呼び出され、2番目のパラメータには以下のプロパティを持つオブジェクトが渡されます： - id -- オーディオストリーマーの WebSocket 接続を識別する一意の ID。 - connectionId -- OpenTok セッション内の Audio Streamer WebSocket 接続に対する OpenTok 接続 ID。