オープントーク

java.lang.Object

com.opentok.OpenTok

public class OpenTok extends 目的

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

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

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

ネストされたクラスの概要

ネストされたクラス

修飾子と型

クラス

説明

static class

OpenTok.Builder

詳細設定を指定して OpenTok オブジェクトを作成するために使用します。

コンストラクタの概要

コンストラクタ

説明

OpenTok(int apiKey, String apiSecret)

OpenTok オブジェクトを作成します。

OpenTok(String applicationId, Path privateKeyPath)

と組み合わせて使用する OpenTok オブジェクトを作成します。ビデオAPI.

方法の概要

すべてのメソッド　インスタンスメソッド　具体的なメソッド

修飾子と型

方法

説明

void

addArchiveStream(String archiveId, String streamId, boolean hasAudio, boolean hasVideo)

OpenTokのアーカイブにストリームを追加します。

void

addBroadcastStream(String broadcastId, String streamId, boolean hasAudio, boolean hasVideo)

Opentokの放送にストリームを追加します。

void

close()

OpenTok オブジェクトの使用が終了したら、ファイルディスクリプタのリークを防ぐために、このメソッドを呼び出してください。

AudioConnector

connectAudioStream(String sessionId, String token, AudioConnectorProperties properties)

Vonage Video API セッションからの音声を WebSocket に送信します。

Session

createSession()

デフォルト設定で OpenTok セッションを作成します：

Session

createSession(SessionProperties properties)

新しい OpenTok セッションを作成します。

void

deleteArchive(String archiveId)

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

Sip

dial(String sessionId, String token, SipProperties properties)

SIPゲートウェイに接続し、OpenTokセッションに接続します。

void

disableForceMute(String sessionId)

セッションのアクティブなミュート状態を解除します。

void

forceDisconnect(String sessionId, String connectionId)

OpenTokセッションからクライアントを切断する

void

forceMuteAll(String sessionId, MuteAllProperties properties)

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

void

forceMuteStream(String sessionId, String streamId)

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

String

generateToken(String sessionId)

デフォルト設定を使用して、OpenTokセッションに接続するためのトークンを作成します。

String

generateToken(String sessionId, TokenOptions tokenOptions)

OpenTokセッションに接続するためのトークンを作成します。

Archive

getArchive(String archiveId)

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

Broadcast

getBroadcast(String broadcastId)

を取得します Broadcast 指定されたブロードキャストIDに対応するオブジェクト。

Render

getRender(String renderId)

エクスペリエンス・コンポーザーの詳細を含む Render オブジェクトを取得します。

Stream

getStream(String sessionId, String streamId)

を取得します Stream 指定されたセッションIDおよびストリームIDに対応するオブジェクト。

ArchiveList

listArchives()

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

ArchiveList

listArchives(int offset, int count)

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

ArchiveList

listArchives(String sessionId)

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

ArchiveList

listArchives(String sessionId, int offset, int count)

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

List<Render>

listRenders()

OpenTok プロジェクトに関連付けられたエクスペリエンス・コンポーザーを表す、 Render オブジェクトのリストを取得します。

List<Render>

listRenders(Integer offset, Integer count)

OpenTok プロジェクトに関連付けられた Experience Composer のリストを表す、 Render オブジェクトのリストを取得します。

StreamList

listStreams(String sessionId)

のリストを取得します Stream 指定されたセッションIDに対応するオブジェクト。

void

playDTMF(String sessionId, String dtmfDigits)

セッション内のすべてのクライアントにDTMF番号を送信します。

void

playDTMF(String sessionId, String connectionId, String dtmfDigits)

セッション中の特定のクライアントにDTMF番号を送信する。

void

removeArchiveStream(String archiveId, String streamId)

Opentokアーカイブからストリームを削除します。

void

removeBroadcastStream(String broadcastId, String streamId)

Opentokの放送からストリームを削除します。

void

setArchiveLayout(String archiveId, ArchiveProperties properties)

構成済みアーカイブのレイアウトタイプを設定します。

void

setBroadcastLayout(String broadcastId, BroadcastProperties properties)

放送のレイアウトタイプを設定します。

void

setStreamLayouts(String sessionId, StreamListProperties properties)

セッション内のストリームのレイアウトクラス一覧を設定します。

void

signal(String sessionId, SignalProperties props)

セッションに接続しているすべてのクライアントにシグナルを送信します。

void

signal(String sessionId, String connectionId, SignalProperties props)

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

Archive

startArchive(String sessionId)

Archive

startArchive(String sessionId, ArchiveProperties properties)

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

Archive

startArchive(String sessionId, String name)

Broadcast

startBroadcast(String sessionId, BroadcastProperties properties)

OpenTokセッションのライブストリーミング配信を開始します。

Caption

startCaptions(String sessionId, String token, CaptionProperties properties)

Live Captions APIを使用して、オーディオストリームをトランスクライブし、アプリケーション用にリアルタイムのキャプションを生成します。

Render

startRender(String sessionId, String token, RenderProperties properties)

OpenTok セッションの Experience Composer レンダリングを開始します。

Archive

stopArchive(String archiveId)

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

Broadcast

stopBroadcast(String broadcastId)

OpenTok セッションのライブ配信を停止します。

void

stopCaptions(String captionsId)

セッションのライブキャプションを停止するには、この方法を使用してください。

void

stopRender(String renderId)

OpenTok セッションの Experience Composer を停止します。

java.lang クラスから継承されたメソッド。目的

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

オープントーク

public OpenTok(int apiKey, ストリング apiSecret)

OpenTok オブジェクトを作成します。

パラメータ： : apiKey - OpenTok API キー。（詳細については、 Vonage Video API アカウントページ.) : apiSecret - OpenTok APIのシークレット。（詳細は Vonage Video API アカウントページ.)

オープントーク

public OpenTok(ストリング applicationId, パス privateKeyPath)

と組み合わせて使用する OpenTok オブジェクトを作成します。ビデオAPI. これは、Vonageへの完全移行に向けた短期的な措置として意図されています。詳しくは、 Java SDK 移行ガイド詳細については。

パラメータ： : applicationId - ビデオ機能が有効になっている、お客様のVonage ApplicationsのUUID。 privateKeyPath - アプリケーションの秘密鍵への絶対パス。

バージョン: : 4.15.0

メソッドの詳細

generateToken

public ストリング generateToken(ストリング sessionId, TokenOptions tokenOptions) throws OpenTokException

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

次の例は、「subscriber」というロールを持ち、接続メタデータ文字列を含むトークンを取得する方法を示しています：


 import com.opentok.Role;
 import com.opentok.TokenOptions;

 class Test {
     public static void main(String args[]) throws OpenTokException {
         int API_KEY = 0; // Replace with your OpenTok API key (see https://tokbox.com/account).
         String API_SECRET = ""; // Replace with your OpenTok API secret.
         OpenTok sdk = new OpenTok(API_KEY, API_SECRET);

         //Generate a basic session. Or you could use an existing session ID.
         String sessionId = System.out.println(sdk.createSession());

         // Replace with meaningful metadata for the connection.
         String connectionMetadata = "username=Bob,userLevel=4";

         // Use the Role value appropriate for the user.
         String role = Role.SUBSCRIBER;

         // Generate a token:
         TokenOptions options = new TokenOptions.Buider().role(role).data(connectionMetadata).build();
         String token = sdk.generateToken(sessionId, options);
         System.out.println(token);
     }
 }

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

パラメータ： : sessionId - ユーザーが接続するセッションに対応するセッションID。 : tokenOptions - この TokenOptions オブジェクトは、トークンのオプションを定義します。これには、以下のものが含まれます：

- The role of the token (subscriber, publisher, or moderator)
- The expiration time of the token
- Connection data describing the end-user

戻り値： : トークン文字列。

投球： : OpenTokException

generateToken

public ストリング generateToken(ストリング sessionId) throws OpenTokException

デフォルト設定を使用して、OpenTok セッションに接続するためのトークンを作成します。デフォルト設定は以下の通りです：

このトークンには「パブリッシャー」の役割が割り当てられます。
トークンは作成から24時間後に失効します。
このトークンには接続データは含まれていません。

次の例は、デフォルト設定のトークンを生成する方法を示しています：


 import com.opentok.OpenTok;

 class Test {
     public static void main(String argv[]) throws OpenTokException {
         int API_KEY = 0; // Replace with your OpenTok API key (see https://tokbox.com/account).
         String API_SECRET = ""; // Replace with your OpenTok API secret.
         OpenTok sdk = new OpenTok(API_KEY, API_SECRET);

         //Generate a basic session. Or you could use an existing session ID.
         String sessionId = System.out.println(sdk.createSession().getSessionId());

         String token = sdk.generateToken(sessionId);
         System.out.println(token);
     }
 }

パラメータ： : sessionId - ユーザーが接続するセッションに対応するセッションID。

戻り値： : トークン文字列。

投球： : OpenTokException

関連項目： : - generateToken(String, TokenOptions)

createSession

public セッション createSession(SessionProperties プロパティ) スローする OpenTokException

新しい OpenTok セッションを作成します。

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

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

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

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

以下のコードは、クライアント間でストリームを直接送信しようとするセッションを作成します（クライアントが接続できない場合は、OpenTok TURNサーバーを使用してストリームを中継するようにフォールバックします）：


 import com.opentok.MediaMode;
 import com.opentok.OpenTok;
 import com.opentok.Session;
 import com.opentok.SessionProperties;

 class Test {
     public static void main(String argv[]) throws OpenTokException {
         int API_KEY = 0; // Replace with your OpenTok API key.
         String API_SECRET = ""; // Replace with your OpenTok API secret.
         OpenTok sdk = new OpenTok(API_KEY, API_SECRET);

         SessionProperties sp = new SessionProperties().Builder()
           .mediaMode(MediaMode.RELAYED).build();

         Session session = sdk.createSession(sp);
         System.out.println(session.getSessionId());
     }
 }

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

パラメータ： : properties - この SessionProperties オブジェクトは、セッションのオプションを定義します。これには、以下のものが含まれます：

- Whether the session's streams will be transmitted directly between peers or
  using the OpenTok Media Router.
- A location hint for the location of the OpenTok server to use for the session.

戻り値： : 新しいセッションを表す Session オブジェクト。 getSessionId() Session オブジェクトのメソッドを使用して、セッションを一意に識別するセッション ID を取得します。このセッション ID は、クライアント SDK でセッションを識別するために使用します。

投球： : OpenTokException

createSession

public セッション createSession() throws OpenTokException

デフォルト設定で OpenTok セッションを作成します：

メディアモードは「中継」です。このセッションでは、クライアント間でストリームを直接送信しようとします。クライアントのネットワーク上のファイアウォールなどの理由により、2つのクライアントが互いのストリームを送受信できない場合、それらのストリームは OpenTok TURNサーバーを介して中継されます。
このセッションでは、最初に接続したクライアントに基づいて、使用する OpenTokサーバーの場所を決定します。

次の例では、デフォルト設定を使用するセッションを作成します。


 import com.opentok.OpenTok;
 import com.opentok.SessionProperties;

 class Test {
     public static void main(String argv[]) throws OpenTokException {
         int API_KEY = 0; // Replace with your OpenTok API key.
         String API_SECRET = ""; // Replace with your OpenTok API secret.
         OpenTok sdk = new OpenTok(API_KEY, API_SECRET);

         String sessionId = sdk.createSession();
         System.out.println(sessionId);
     }
 }

投球： : OpenTokException

関連項目： : - createSession(SessionProperties)

信号

public void signal(ストリング sessionId, シグナルプロパティ props) throws OpenTokException

セッションに接続しているすべてのクライアントにシグナルを送信します。

詳細はシグナリング開発者ガイド.

パラメータ： : sessionId - セッションID。 : props - シグナルのデータと型を定義する SignalProperties オブジェクト。

投球： : OpenTokException

信号

public void signal(ストリング sessionId, ストリング connectionId, シグナルプロパティ props) throws OpenTokException

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

詳細はシグナリング開発者ガイド.

パラメータ： : sessionId - セッションID。 : connectionId - 信号を受信するクライアントの接続ID。 : props - シグナルのデータと型を定義する SignalProperties オブジェクト。

投球： : OpenTokException

getArchive

public アーカイブ getArchive(ストリング archiveId) throws OpenTokException

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

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

戻り値： : The Archive オブジェクトがある。

投球： : OpenTokException

アーカイブ一覧

public アーカイブ一覧 listArchives() throws OpenTokException

以下のリストを返します。 Archive APIキーに対応する、完了済みおよび進行中のアーカイブを表すオブジェクト。このリストは、最初に記録されたアーカイブから順に 1000件までとなります。特定の範囲のアーカイブを取得するには、 listArchives(int offset, int count).

戻り値： : 以下のリスト： Archive オブジェクトがある。

投球： : OpenTokException

アーカイブ一覧

public アーカイブ一覧 listArchives(ストリング sessionId) throws OpenTokException

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

パラメータ： : sessionId - アーカイブを開始した、または自動的にアーカイブを有効にしたセッションのセッションID。セッションがnullまたは空の場合、省略されます。

戻り値： : 以下のリスト： Archive オブジェクトがある。

投球： : OpenTokException

アーカイブ一覧

public アーカイブ一覧 listArchives(int offset, int count) throws OpenTokException

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

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

戻り値： : 以下のリスト： Archive オブジェクトがある。

投球： : OpenTokException

アーカイブ一覧

public アーカイブ一覧 listArchives(ストリング sessionId, int offset, int count) throws OpenTokException

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

パラメータ： : offset - 最初のアーカイブのインデックスオフセット。0 は、最も最近開始されたアーカイブのオフセットです。 1 は、最も最近のアーカイブより前に開始されたアーカイブのオフセットです。 : count - 返すアーカイブの数。返されるアーカイブの最大数は 1000です。 : sessionId - アーカイブを開始した、またはアーカイブを自動的に有効化したセッションのセッションID。

戻り値： : 以下のリスト： Archive オブジェクトがある。

投球： : OpenTokException

startArchive

public アーカイブ startArchive(ストリング sessionId, アーカイブのプロパティプロパティ) スローする OpenTokException

OpenTok セッションのアーカイブを開始します。このバージョンの startArchive() このメソッドを使用すると、音声または動画の録音を無効にできます。

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

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

アーカイブに関する詳細については、以下の OpenTokのアーカイブ機能開発者ガイド

パラメータ： : sessionId - アーカイブ対象の OpenTok セッションのセッション ID。 : properties - この ArchiveProperties オブジェクトは、アーカイブのオプションを定義します。

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

投球： : OpenTokException

startArchive

public アーカイブ startArchive(ストリング sessionId) throws OpenTokException

投球： : OpenTokException

startArchive

public アーカイブ startArchive(ストリング sessionId, ストリング name) throws OpenTokException

投球： : OpenTokException

stopArchive

public アーカイブ stopArchive(ストリング archiveId) throws OpenTokException

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

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

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

戻り値： : 停止されるアーカイブに対応する Archive オブジェクト。

投球： : OpenTokException

deleteArchive

public void deleteArchive(ストリング archiveId) throws OpenTokException

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

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

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

投球： : OpenTokException

addArchiveStream

public void addArchiveStream(ストリング archiveId, ストリング streamId, boolean hasAudio, boolean hasVideo) throws OpenTokException

OpenTokのアーカイブにストリームを追加します。

この方法は、 Archive.StreamMode set to StreamMode.MANUAL.

このメソッドを同じストリームIDで繰り返し呼び出すことで、以下の条件に基づいて、音声または映像の再生を有効または無効にすることができます。 hasAudio そして hasVideo パラメータ値。

パラメータ： : archiveId - アーカイブID。 : streamId - ストリームID。 : hasAudio - アーカイブ内の配信で音声を有効にするかどうか。 : hasVideo - アーカイブにおいて、そのストリームの動画機能を有効にするかどうか。

投球： : OpenTokException

removeArchiveStream

public void removeArchiveStream(ストリング archiveId, ストリング streamId) throws OpenTokException

Opentokアーカイブからストリームを削除します。

この方法は、 Archive.StreamMode set to StreamMode.MANUAL.

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

投球： : OpenTokException

setArchiveLayout

public void setArchiveLayout(ストリング archiveId, アーカイブのプロパティプロパティ) スローする OpenTokException

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

パラメータ： : archiveId - {String} アーカイブID。 : properties - アーカイブのレイアウトを定義する ArchiveProperties オブジェクト。

投球： : OpenTokException

startBroadcast

public ブロードキャスト startBroadcast(ストリング sessionId, BroadcastProperties プロパティ) スローする OpenTokException

OpenTokセッションのライブストリーミング配信を開始します。これにより、セッションがHLS（HTTPライブストリーミング）またはRTMPストリームに配信されます。

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

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

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

パラメータ： : sessionId - 配信対象の OpenTok セッションのセッション ID。 : properties - BroadcastProperties オブジェクトは、ブロードキャストのオプションを定義します。

戻り値： : Broadcast オブジェクト。このオブジェクトには、ブロードキャストを定義するプロパティ（ブロードキャスト ID を含む）が含まれています。

投球： : OpenTokException

stopBroadcast

public ブロードキャスト stopBroadcast(ストリング broadcastId) throws OpenTokException

OpenTok セッションのライブ配信を停止します。なお、配信は開始から 120 分後に自動的に停止します。

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

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

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

投球： : OpenTokException

getBroadcast

public ブロードキャスト getBroadcast(ストリング broadcastId) throws OpenTokException

を取得します Broadcast 指定されたブロードキャストIDに対応するオブジェクト。

パラメータ： : broadcastId - 放送ID。

戻り値： : The Broadcast オブジェクトがある。

投球： : OpenTokException

setBroadcastLayout

public void setBroadcastLayout(ストリング broadcastId, BroadcastProperties プロパティ) スローする OpenTokException

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

パラメータ： : broadcastId - {String} ブロードキャスト ID。 : properties - 放送のレイアウトオプションを定義する、この BroadcastProperties オブジェクト。

投球： : OpenTokException

addBroadcastStream

public void addBroadcastStream(ストリング broadcastId, ストリング streamId, boolean hasAudio, boolean hasVideo) throws OpenTokException

Opentokの放送にストリームを追加します。

この方法は、 Archive.StreamMode set to StreamMode.MANUAL.

パラメータ： : broadcastId - 放送ID。 : streamId - ストリームID。 : hasAudio - 配信中にストリームの音声を有効にするかどうか。 : hasVideo - 配信において、そのストリームの動画機能を有効にするかどうか。

投球： : OpenTokException

removeBroadcastStream

public void removeBroadcastStream(ストリング broadcastId, ストリング streamId) throws OpenTokException

Opentokの放送からストリームを削除します。

この方法は、 Archive.StreamMode set to StreamMode.MANUAL.

パラメータ： : broadcastId - 放送ID。 : streamId - ストリームID。

投球： : OpenTokException

setStreamLayouts

public void setStreamLayouts(ストリング sessionId, StreamListProperties プロパティ) スローする OpenTokException

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

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

パラメータ： : sessionId - {String} ストリームが属するセッションのセッションID。 : properties - この StreamListProperties オブジェクトは、セッション内の 1 つ以上のストリームに対するクラス一覧を定義します。

投球： : OpenTokException

forceDisconnect

public void forceDisconnect(ストリング sessionId, ストリング connectionId) throws OpenTokException

OpenTokセッションからクライアントを切断する

このAPIを使用して、セッションの接続を強制的に終了させます。

パラメータ： : sessionId - 接続のセッションID : connectionId - 切断する接続ID

投球： : OpenTokException

forceMuteStream

public void forceMuteStream(ストリング sessionId, ストリング streamId) throws OpenTokException

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

詳細については、以下を参照してください。セッション内のストリームの音声をミュートする.

パラメータ： : sessionId - セッションID。 : streamId - ストリームID。

投球： : OpenTokException

関連項目： : - forceMuteAll(String, MuteAllProperties)

forceMuteAll

public void forceMuteAll(ストリング sessionId, すべてのプロパティをミュートプロパティ) スローする OpenTokException

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

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

詳細については、以下を参照してください。セッション内のストリームの音声をミュートする.

パラメータ： : sessionId - セッションID。 : properties - ミュート操作の対象から除外すべきストリームのストリーム ID のリストを定義します。 -

投球： : OpenTokException

disableForceMute

public void disableForceMute(ストリング sessionId) throws OpenTokException

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

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

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

投球： : OpenTokException

関連項目： : - forceMuteAll(String, MuteAllProperties)

getStream

public ストリーム getStream(ストリング sessionId, ストリング streamId) throws OpenTokException

を取得します Stream 指定されたセッションIDおよびストリームIDに対応するオブジェクト。

パラメータ： : sessionId - セッションID。 : streamId - ストリームID。

戻り値： : The Stream オブジェクトがある。

投球： : OpenTokException

listStreams

public ストリームリスト listStreams(ストリング sessionId) throws OpenTokException

のリストを取得します Stream 指定されたセッションIDに対応するオブジェクト。

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

戻り値： : 以下のリスト： Stream オブジェクトがある。

投球： : OpenTokException

ダイヤル

public ひと口 dial(ストリング sessionId, ストリングトークン、 SipProperties プロパティ) スローする OpenTokException

SIPゲートウェイに接続し、OpenTokセッションに接続します。

パラメータ： : sessionId - セッションID。 : token - 呼び出し先の参加者に使用する OpenTok トークン。トークンデータに、その参加者が SIP エンドポイントであるかどうかを識別するための情報や、電話番号などのその他の識別情報を追加することができます。（OpenTok クライアントライブラリには、セッションに接続しているクライアントの接続データを検査するためのプロパティが含まれています。）詳細は、トークン作成開発者ガイド. : properties - その SipProperties SIP通話のオプションを定義するオブジェクト。

戻り値： : The Sip オブジェクトがある。

投球： : OpenTokException

DTMFを再生

public void playDTMF(ストリング sessionId, ストリング (dtmfDigits) スローする OpenTokException

セッション内のすべてのクライアントにDTMF番号を送信します。

パラメータ： : sessionId - セッションID。 : dtmfDigits - 送信するDTMF数字の文字列。0～9、"*"、"#"、および"p"を含めることができます。"p"は500msの休止を意味します（数字の送信に遅延を加える必要がある場合）。

投球： : OpenTokException

DTMFを再生

public void playDTMF(ストリング sessionId, ストリング connectionId, ストリング (dtmfDigits) スローする OpenTokException

セッション中の特定のクライアントにDTMF番号を送信する。

パラメータ： : sessionId - セッションID。 : connectionId - DTMF信号を受信するクライアントのセッションID。 : dtmfDigits - 送信するDTMF数字の文字列。0～9、"*"、"#"、および"p"を含めることができます。"p"は500msの休止を意味します（数字の送信に遅延を加える必要がある場合）。

投球： : OpenTokException

connectAudioStream

public AudioConnector connectAudioStream(ストリング sessionId, ストリングトークン、 AudioConnectorProperties プロパティ) スローする OpenTokException

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

パラメータ： : sessionId - セッションID。 : token - OpenTokセッションへのAudio Connector接続に使用するOpenTokトークン。接続がAudio Connectorエンドポイントであることを識別するため、またはその他の識別情報として、トークンデータを追加できます。 : properties - ConnectProperties オブジェクトは、Audio Connector API エンドポイントへのリクエストで使用されるオプションを定義します。 -

戻り値： : サーバーからの Audio Connect レスポンスオブジェクト。

投球： : OpenTokException

startRender

public レンダー startRender(ストリング sessionId, ストリングトークン、 RenderProperties プロパティ) スローする OpenTokException

OpenTok セッションの Experience Composer レンダリングを開始します。詳細については、 Experience Composer 開発者ガイド.

パラメータ： : sessionId - セッションID。 : properties - その RenderProperties Render呼び出しのプロパティを定義するオブジェクト。

戻り値： : The Render レスポンスオブジェクト。

投球： : OpenTokException

getRender

public レンダー getRender(ストリング renderId) throws OpenTokException

エクスペリエンス・コンポーザーの詳細を含む Render オブジェクトを取得します。

パラメータ： : renderId - 取得するエクスペリエンス・コンポーザーのID。

戻り値： : The Render 指定されたIDに関連付けられたレスポンスオブジェクト。

投球： : OpenTokException

stopRender

public void stopRender(ストリング renderId) throws OpenTokException

OpenTok セッションの「エクスペリエンス・コンポーザー」を停止します。なお、デフォルトでは、エクスペリエンス・コンポーザーは開始から2時間後に自動的に停止します。また、エクスペリエンス・コンポーザーの作成時に、別の maxDuration 値を設定することも可能です。エクスペリエンス・コンポーザーが終了すると、プロジェクトに対してコールバックURLが設定されている場合、そのURLにイベントが送信されます。

パラメータ： : renderId - 停止するエクスペリエンス・コンポーザーのID。

投球： : OpenTokException

listRenders

public 一覧<レンダー> listRenders() 例外が発生します OpenTokException

OpenTok プロジェクトに関連付けられたエクスペリエンス・コンポーザーを表す、 Render オブジェクトのリストを取得します。

戻り値： : 以下のリスト： Render オブジェクトがある。

投球： : OpenTokException

listRenders

public 一覧<レンダー> listRenders(整数オフセット、整数 count) throws OpenTokException

OpenTok プロジェクトに関連付けられた Experience Composer のリストを表す、 Render オブジェクトのリストを取得します。

パラメータ： : offset - (任意) 既存のレンダリング一覧における開始オフセット。 : count - (オプション) オフセットから取得するレンダリングの数。最大1000。

戻り値： : 以下のリスト： Render オブジェクトがある。

投球： : OpenTokException

startCaptions

public キャプション startCaptions(ストリング sessionId, ストリングトークン、キャプションのプロパティプロパティ) スローする OpenTokException

Live Captions API を使用して、オーディオストリームを文字起こしし、Applications 向けにリアルタイムのキャプションを生成します。 Live Captions はすべてのプロジェクトでデフォルトで有効になっており、使用量に応じた課金制の製品です。Live Captions 機能は、ルーティングされたセッション（OpenTok Media Router を使用するセッション）でのみサポートされています。1 つの Vonage セッションから、一度に最大 50 のオーディオストリームを文字起こしサービスに送信し、キャプションを生成することができます。

パラメータ： : sessionId - OpenTok セッションのセッション ID。このセッションに配信を行っているパブリッシャーからの音声は、字幕の生成に使用されます。 : token - ロールが「モデレーター」に設定された有効な OpenTok トークン。 : properties - その CaptionProperties ライブ字幕のオプションプロパティを定義するオブジェクト。

戻り値： : A Caption この呼び出しのキャプションIDを含む応答。

投球： : OpenTokException

stopCaptions

public void stopCaptions(ストリング captionsId) throws OpenTokException

セッションのライブキャプションを停止するには、この方法を使用してください。

パラメータ： : captionsId - 音声字幕セッションの一意のID。これは、以下の場所から取得したものです。 Caption.getCaptionsId().

投球： : OpenTokException

閉じる

public void close()

OpenTok オブジェクトの使用が終了したら、ファイルディスクリプタのリークを防ぐために、このメソッドを呼び出してください。