継承元： : Object

定義場所： : lib/opentok/render.rb

概要

OpenTok セッションの Experience Composer によるレンダリングを表しています。詳しくは / Experience Composer.

インスタンス属性の概要

  • #作成日時 ⇒ int

    Experience Composer が起動した時刻。Unix エポックからの経過時間をミリ秒単位で表したものです。

  • #id ⇒ 文字列

    エクスペリエンス・コンポーザーの固有ID。

  • #project_id ⇒ 文字列

    renderに関連付けられたAPIキー。

  • #理由 ⇒ 文字列

    「理由」フィールドは、ステータスが「停止」または「失敗」の場合にのみ利用可能です。

  • #決議 ⇒ 文字列

    Experience Composerの解像度（「640x480」、「480x640」、 「1280x720」、「720x1280」、「1920x1080」、または「1080x1920」）のいずれか。

  • #session_id ⇒ 文字列

    このレンダリングに関連付けられている OpenTok セッションのセッション ID。

  • #ステータス ⇒ 文字列

    エクスペリエンス・コンポーザーの状況。

  • #streamId ⇒ 文字列

    パブリッシュされている複合ストリームのID。

  • #更新日時 ⇒ int

    Experience Composer のステータスが最後に更新された時点の UNIX タイムスタンプ。

  • #url ⇒ 文字列

    顧客が管理し、ユーザーの操作を必要とせずに表示されるコンテンツを生成できる、一般に公開されているURL。

インスタンスメソッドの概要

動的メソッド処理

このクラスは、method_missing メソッドを通じて動的メソッドを処理します

#method_missing(method, *args, &block) ⇒ Object

インスタンス属性の詳細

#作成日時 ⇒ int

Experience Composer が起動した時刻。Unix エポックからの経過時間をミリ秒単位で表したものです。

リターンズ

  • (int) —

    created_at の現在の値

#id ⇒ 文字列

エクスペリエンス・コンポーザーの固有ID。

リターンズ

  • (文字列) —

    id の現在の値

#project_id ⇒ 文字列

renderに関連付けられたAPIキー。

リターンズ

  • (文字列) —

    project_id の現在の値

#理由 ⇒ 文字列

「理由」フィールドは、ステータスが「停止」または「失敗」の場合にのみ利用可能です。ステータスが「停止」の場合、「理由」フィールドには以下のいずれかが表示されます。

"Max Duration Exceeded" or "Stop Requested." If the status is failed, the reason will contain a more specific error message.

リターンズ

  • (文字列) —

    理性の現在の価値

#決議 ⇒ 文字列

Experience Composerの解像度（「640x480」、「480x640」、 「1280x720」、「720x1280」、「1920x1080」、または「1080x1920」）のいずれか。

リターンズ

  • (文字列) —

    解像度の現在の値

#session_id ⇒ 文字列

このレンダリングに関連付けられている OpenTok セッションのセッション ID。

リターンズ

  • (文字列) —

    session_id の現在の値

#ステータス ⇒ 文字列

Experience Composer のステータス。ステータスの更新を確認するために、頻繁にポーリングを行ってください。このプロパティは、以下のいずれかに設定されます。

- "starting" — The Vonage Video API platform is in the process of connecting to the remote application at the URL provided. This is the initial state.
- "started" — The Vonage Video API platform has successfully connected to the remote application server, and is publishing the web view to an OpenTok stream.
- "stopped" — The Experience Composer has stopped.
- "failed" — An error occurred and the Experience Composer could not proceed. It may occur at startup if the OpenTok server cannot connect to the remote
              application server or republish the stream. It may also occur at any point during the process due to an error in the Vonage Video API platform.

リターンズ

  • (文字列) —

    ステータスの現在の値

#streamId ⇒ 文字列

公開されている合成ストリームのID。statusが「starting」の場合はstreamIdは利用できず、statusが「failed」の場合も利用できないことがあります。

リターンズ

  • (文字列) —

    streamId の現在の値

#更新日時 ⇒ int

Experience Composer のステータスが最後に更新された時点の UNIX タイムスタンプ。

リターンズ

  • (int) —

    updated_at の現在の値

#url ⇒ 文字列

顧客が管理し、ユーザーの操作を必要とせずに表示されるコンテンツを生成できる、一般に公開されているURL。

リターンズ

  • (文字列) —

    URLの現在の値

インスタンスメソッドの詳細

#情報 ⇒ オブジェクト

OpenTok Experience Composer のレンダリングに関する情報を取得します。

#ストップ ⇒ オブジェクト

OpenTok Experience Composer のレンダリングを停止します。

#to_json ⇒ オブジェクト

Experience Composerのレンダリング結果をJSON形式でエンコードした文字列表現。