レンダー
OpenTokセッションのExperience Composerによるレンダリングを表します。
目次
$createdAt : int
$id : 文字列
$projectId : 文字列
$resolution : 文字列
$sessionId : 文字列
$status : 文字列
$streamId : 文字列
$updatedAt : int
$url : 文字列
プロパティ
$createdAt
public int $createdAt
Experience Composer が起動した時刻。Unix エポックからの経過時間をミリ秒単位で表したものです。
$id
public string $id
エクスペリエンス・コンポーザーの固有ID。
$projectId
public string $projectId
renderに関連付けられたAPIキー。
$resolution
public string $resolution
Experience Composerの解像度(「640x480」、「480x640」、「1280x720」、「720x1280」、 「1920x1080」、または「1080x1920」)の解像度。
$sessionId
public string $sessionId
このレンダリングに関連付けられている OpenTok セッションのセッション ID。
$status
public string $status
Experience Composer のステータス。ステータスの更新を確認するために、頻繁にポーリングを行ってください。このプロパティは、以下のいずれかに設定されます。
- 「開始中」 — Vonage Video API プラットフォームは、指定された URL にあるリモートアプリケーションへの接続処理を行っています。これは初期状態です。
- 「開始」 — Vonage Video API プラットフォームは、リモートアプリケーションサーバーへの接続に成功し、Web ビューを OpenTok ストリームに配信しています。
- 「停止しました」 — Experience Composer が停止しました。
- 「失敗」 — エラーが発生し、Experience Composer を続行できませんでした。これは、OpenTok サーバーがリモートの アプリケーションサーバーに接続できない場合や、ストリームを再公開できない場合に、起動時に発生することがあります。また、Vonage Video API プラットフォームのエラーにより、処理中のどの時点でも発生する可能性があります。
$streamId
public string $streamId
パブリッシュされている合成ストリームのID。statusが「starting」の場合はstreamIdは利用できず、 statusが「failed」の場合も利用できないことがあります。
$updatedAt
public int $updatedAt
Experience Composer のステータスが最後に更新された時点の UNIX タイムスタンプ。
$url
public string $url
顧客が管理し、ユーザーの操作を必要とせずに表示されるコンテンツを生成できる、一般に公開されているURL。