Experience Composer レンダラーを表すオブジェクト。

特性:
名称 タイプ 説明
id ストリング レンダリングインスタンスのID
projectId ストリング レンダリング対象のプロジェクトのID。
sessionId ストリング レンダリング先のセッションのID。
createdAt Numbers レンダリングが作成された時刻。UNIXエポックからの経過時間(ミリ秒単位)。
upddatedAt Numbers レンダリングが作成された時刻。UNIXエポックからの経過時間(ミリ秒単位)。
url ストリング 顧客が管理し、ユーザーの操作を必要とせずに表示されるコンテンツを生成できる、一般に公開されているURL。
reason ストリング レンダリングが失敗または停止した理由について、簡潔な説明文が表示されます。
callbackUrl ストリング コールバックを受信するカスタマーサービスのURL。
event ストリング レンダリングの最終送信イベント
resoultion ストリング コンポジションの表示領域の解像度。

方法

名称 説明
getRender(config, renderId, callback) を取得します レンダー 指定されたレンダリングIDに対応するオブジェクト。
listRenders(config, options, callback)
startRender(config, options, callback) OpenTok セッション用のエクスペリエンス・コンポーザーを起動します。
stopRender(config, renderId, callback) 現在レンダリング中の OpenTok レンダリングを停止します。

getRender(config, renderId, callback)

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

パラメータ:
名称 タイプ 説明
config 目的 APIの設定 {@see OpenTok}
renderId ストリング 取得するレンダリングID
callback 機能 コールバック関数

listRenders(config, options, callback)

以下のリストを返す レンダー 「Experience Composer」のあらゆるステータスを表すオブジェクト

パラメータ:
名称 タイプ 説明
config 目的 APIの設定 {@see OpenTok.listRenders}
options 目的 API呼び出しのオプションパラメータ {@see OpenTok.listRenders}
callback 機能 コールバック関数

startRender(config, options, callback)

OpenTok セッション用のエクスペリエンス・コンポーザーを起動します。

パラメータ:
名称 タイプ 説明
config 目的 APIの設定 {@see OpenTok.startRender}
options 目的 API呼び出しのオプションパラメータ {@see OpenTok.startRender}
callback 機能 コールバック関数

stopRender(config, renderId, callback)

現在レンダリング中の OpenTok レンダリングを停止します。

パラメータ:
名称 タイプ 説明
config 目的 APIの設定 {@see OpenTok.stopRender}
renderId ストリング 取得するレンダリングID
callback 機能 コールバック関数