継承元： : Object

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

概要

OpenTok Experience Composer のレンダリングを扱うためのクラスです。詳しくは / Experience Composer.

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

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

#検索(render_id) ⇒ レンダー

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

パラメータ：

  • render_id (文字列) —

    (必須) レンダリングID。

リターンズ

  • (レンダー) —

    レンダリングを定義するプロパティを含むレンダリングオブジェクト。

引き上げ：

  • (OpenTokRenderError) —

    リクエストが無効でした。

  • (OpenTok認証エラー) —

    レンダリングの停止中に認証に失敗しました。APIキーが無効です。

  • (OpenTokRenderError) —

    （指定されたIDに）一致するレンダリングが見つかりませんでした、またはすでに停止されています

  • (OpenTokエラー) —

    OpenTokサーバーエラー。

#リスト(options = {}) ⇒ RenderList

プロジェクトに関連付けられたExperience Composerのレンダリング結果の配列であるRenderListを返します。

パラメータ：

  • オプション (ハッシュ) （デフォルトは：{}） —

    どの範囲のレンダリングを取得するかを定義するキーを含むハッシュ。

オプションハッシュ (options):

  • :offset (整数)

    — デフォルト: 省略可 —

    . Experience Composer によるレンダリング結果の一覧の開始オフセット。デフォルトは 0 です。

  • :count (整数)

    -

    オプション。オフセットから開始して取得するExperience Composerのレンダリング数。デフォルト値は50で、最大値は1000です。

リターンズ

  • (RenderList) —

    RenderList オブジェクト。これは、Render オブジェクトの配列です。

引き上げ：

  • (ArgumentError)

#スタート(session_id, options = {}) ⇒ レンダー

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

パラメータ：

  • session_id (文字列) —

    (必須) Experience Composerのストリームを含むOpenTokセッションのセッションID。

  • オプション (ハッシュ) （デフォルトは：{}） —

    (必須) レンダリングのオプションを定義するハッシュ。

オプションハッシュ (options):

  • :token (文字列)

    — デフォルト: 必須 —

    「Publisher」ロールを持ち、出力ストリームに関連付ける接続データ（任意）を含む、有効な OpenTok トークン。

  • :url (文字列)

    — デフォルト: 必須 —

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

  • :max_duration (整数)

    — デフォルト: 省略可 —

    Experience Composer の最大実行時間（秒単位）。この時間が経過しても実行中の場合は、自動的に停止されます。最大値は 36000（10 時間）、最小値は 60（1 分）、デフォルト値は 7200（2 時間）です。 Experience Composerが終了すると、そのストリームの公開が解除され、Accountポータルで設定されている場合は、コールバックURLにイベントが送信されます。

  • :resolution (文字列)

    -

    Experience Composerの解像度は、「640x480」（SD横向き）、「480x640」（SD縦向き）、「1280x720」（HD横向き）、「720x1280」 （HD縦向き）、「1920x1080」（FHD横向き）、または「1080x1920」（FHD縦向き）のいずれかです。デフォルトでは、この解像度は「1280x720」（HD横向き、デフォルト）に設定されています。

  • :properties (ハッシュ)

    — デフォルト: 省略可 —

    合成された出力ストリームに対する Publisher プロパティの初期設定。このプロパティオブジェクトには、キー :name (文字列)。これは、セッションに公開される合成出力ストリームの名前として機能します。名前の長さは、1以上200以下でなければなりません。

リターンズ

  • (レンダー) —

    レンダリングオブジェクト。これには、レンダリングIDを含む、レンダリングを定義するプロパティが含まれています。

引き上げ：

  • (OpenTokRenderError) —

    レンダリングを開始できませんでした。リクエストが無効でした。

  • (OpenTok認証エラー) —

    レンダリングの開始中に認証に失敗しました。APIキーが無効です。

  • (OpenTokエラー) —

    OpenTokサーバーエラー。

#ストップ(render_id) ⇒ レンダー

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

パラメータ：

  • render_id (文字列) —

    (必須) レンダリングID。

リターンズ

  • (レンダー) —

    レンダリングを定義するプロパティを含むレンダリングオブジェクト。

引き上げ：

  • (OpenTokRenderError) —

    リクエストが無効でした。

  • (OpenTok認証エラー) —

    レンダリングの停止中に認証に失敗しました。APIキーが無効です。

  • (OpenTokRenderError) —

    （指定されたIDに）一致するレンダリングが見つかりませんでした、またはすでに停止されています

  • (OpenTokエラー) —

    OpenTokサーバーエラー。