継承元： : Object

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

概要

OpenTok セッションのライブストリーミング配信を表します。詳しくは / ライブ配信.

インスタンス属性の概要

• #broadcastUrls ⇒ ハッシュ

  は次のように定義されます。このオブジェクトは、開始したいブロードキャストストリームの種類（HLSおよびRTMPの両方）を定義します。

• #作成日時 ⇒ int

  放送が作成された時刻（UNIXエポックからの経過時間、ミリ秒単位）。

• #hasAudio ⇒ ブール値

  この放送では音声が再生されています。

• #hasVideo ⇒ ブール値

  この放送では動画が視聴可能です。

• #id ⇒ 文字列

  放送ID。

• #maxBitRate ⇒ int

  放送ストリームの最大ビットレート（ビット/秒）。

• #multi_broadcast_tag ⇒ オブジェクト 読み取り専用

  属性「multi_broadcast_tag」の値を返します。

• #project_id ⇒ 文字列

  その放送に関連付けられているAPIキー。

• #決議 ⇒ 文字列

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

• #session_id ⇒ 文字列

  この放送に関連付けられている OpenTok セッションのセッション ID。

• #ステータス ⇒ 文字列

  RTMPストリームの状態。

• #streamMode ⇒ 文字列

  放送に含まれるストリームが、自動的に選択されるか（「自動」、デフォルト設定）、手動で選択されるか（「手動」）。

• #更新日時 ⇒ int

  この起動方法の場合、このタイムスタンプは createdAt のタイムスタンプと一致します。

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

• #add_stream(stream_id, opts = {}) ⇒ オブジェクト

  streamMode が「manual」に設定されて開始されたストリームを、現在実行中の放送に追加します。

• #レイアウト(opts = {}) ⇒ オブジェクト

  OpenTokの配信のレイアウトを設定します。

• #remove_stream(stream_id) ⇒ オブジェクト

  streamMode が「manual」に設定されて開始された、現在実行中の放送からストリームを削除します。

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

  OpenTokの配信を停止します。

• #to_json ⇒ オブジェクト

  ブロードキャストをJSON形式でエンコードした文字列表現。

動的メソッド処理

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

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

インスタンス属性の詳細

#broadcastUrls ⇒ ハッシュ

は次のように定義されます。このオブジェクトは、開始したいブロードキャストストリームの種類（HLSおよびRTMPの両方）を定義します。ブロードキャストストリームとして、HLS、RTMP、あるいはその両方を含めることができます。RTMPストリーミングを含める場合、最大5つのターゲットRTMPストリーム（または1つだけ）を指定できます。（:hls) プロパティは空の [Hash] オブジェクトに設定されます。HLS URL がレスポンスとして返されます。「hlsStatus」プロパティは、以下のいずれかに設定されます：

- "connecting" — The OpenTok server is in the process of starting transcoders. This is the initial state.
- "ready" — The OpenTok server has succesfully initialized but the CDN is not consuming media.
- "live" — The OpenTok server has succesfully initialized and the CDN is consuming media.
- "ended" — The source stream has ended. If DVR is enabled and pre-recorded media is requested, then the status will transition to "live".
- "error" — There is an error in the OpenTok platform.

（:rtmp) プロパティは、Rtmp [Hash] プロパティの [Array] に設定されます。各 RTMP ストリームについて、以下を指定します (:serverUrl) RTMPサーバーのURLとして、(:streamName) 例えば、YouTubeライブ配信名やFacebookのストリームキーなど）、および（任意で）（:id)、ストリームを一意に識別するID。

リターンズ

• (ハッシュ) —

  broadcastUrls の現在の値

#作成日時 ⇒ int

放送が作成された時刻（UNIXエポックからの経過時間、ミリ秒単位）。

リターンズ

• (int) —

  created_at の現在の値

#hasAudio ⇒ ブール値

この放送では音声が再生されています

リターンズ

• (ブール値) —

  hasAudio の現在の値

#hasVideo ⇒ ブール値

この放送では動画が視聴可能です

リターンズ

• (ブール値) —

  hasVideo の現在の値

#id ⇒ 文字列

放送ID。

リターンズ

• (文字列) —

  id の現在の値

#maxBitRate ⇒ int

放送ストリームの最大ビットレート（ビット/秒）。

リターンズ

• (int) —

  maxBitRate の現在の値

#multi_broadcast_tag ⇒ オブジェクト（読み取り専用）

属性「multi_broadcast_tag」の値を返します。

#project_id ⇒ 文字列

その放送に関連付けられているAPIキー。

リターンズ

• (文字列) —

  project_id の現在の値

#決議 ⇒ 文字列

放送の解像度は、「640x480」（SD 横向き、デフォルト）、「1280x720」（HD 横向き）、「1920x1080」 （FHD 横向き）、「480x640」（SD 縦向き）、「720x1280」（HD 縦向き）、または「1080x1920」（FHD 縦向き）のいずれかです。 モバイルデバイスからの動画ストリーム（多くの場合、縦向きアスペクト比が使用されます）を含む配信では、縦向きアスペクト比を使用することをお勧めします。このプロパティはオプションです。

リターンズ

• (文字列) —

  解像度の現在の値

#session_id ⇒ 文字列

この放送に関連付けられている OpenTok セッションのセッション ID。

リターンズ

• (文字列) —

  session_id の現在の値

#ステータス ⇒ 文字列

RTMPストリームの状態。

• 「接続中」 – OpenTokプラットフォームは、リモートのRTMPサーバーへの接続を行っています。

  コピー

  This is the initial state, and it is the status if you start when there are no streams published in the session.
  It changes to "live" when there are streams (or it changes to one of the other states).
  

• 「ライブ – OpenTokプラットフォームはリモートのRTMPサーバーへの接続に成功し、メディアのストリーミングが行われています。」

• 「オフライン」 – OpenTokプラットフォームがリモートのRTMPサーバーに接続できませんでした。 これは、サーバーに接続できないか、RTMPハンドシェイクでエラーが発生したことが原因です。原因としては、RTMP接続の拒否、RTMP Applicationsが存在しない、ストリーム名の無効、認証エラーなどが挙げられます。サーバーがオンライン状態であるか、正しいサーバーURLとストリーム名が指定されているかを確認してください。

• 「エラー」 – OpenTokプラットフォームでエラーが発生しています。

リターンズ

• (文字列) —

  ステータスの現在の値

#streamMode ⇒ 文字列

放送に含まれるストリームが、自動的に選択されるか（「自動」、デフォルト設定）、手動で選択されるか（「手動」）。

リターンズ

• (文字列) —

  streamMode の現在の値

#更新日時 ⇒ int

この起動方法の場合、このタイムスタンプは createdAt のタイムスタンプと一致します。

リターンズ

• (int) —

  updated_at の現在の値

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

#add_stream(stream_id, opts = {}) ⇒ オブジェクト

streamMode が「manual」に設定されて開始された、現在実行中の放送にストリームを追加します。この機能の詳細については、<https://tokbox.com/developer/rest/#selecting-broadcast-streams>.

add_stream に同じストリーム ID を指定してこのメソッドを繰り返し呼び出すことで、配信におけるそのストリームの音声または映像の表示/非表示を切り替えることができます。has_audio と has_video の両方を false に設定すると、エラー応答が返されます。

パラメータ：

• stream_id (文字列) —

  放送に追加するストリームのID

• opts (ハッシュ) （デフォルトは：{}） —

  カスタマイズ可能なオプションのセット

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

• :has_audio (true, false)

  — デフォルト: ブール値、省略可 —

  — 配信にストリームの音声を組み込むかどうか（true：デフォルト、false：組み込まない）。

• :has_video (true, false)

  — デフォルト: ブール値、省略可 —

  — 配信にストリームの動画を組み込むかどうか（true：デフォルト、false：組み込まない）。

引き上げ：

• (OpenTokBroadcastError) —

  この放送の streamMode が「manual」に設定されていません。

#レイアウト(opts = {}) ⇒ オブジェクト

OpenTokの配信のレイアウトを設定します。

放送中の放送のレイアウトタイプを動的に変更することができます。詳細については、以下を参照してください。 OpenTokライブ配信の動画レイアウトの設定.

<を参照してくださいhttps://tokbox.com/developer/rest/#change_composed_archive_layout>

パラメータ：

• オプション (ハッシュ) —

  カスタマイズ可能なオプションのセット

引き上げ：

• (OpenTokBroadcastError) —

  放送のレイアウトを更新できませんでした。

• (OpenTok認証エラー) —

  認証に失敗しました。APIキーまたはシークレットが無効です。

• (OpenTokエラー) —

  OpenTokサーバーエラー。

• (ArgumentError) —

  broadcast_id または options パラメータが空です。

• (ArgumentError) —

  「custom」タイプが、スタイルシートオプションを指定せずに指定されました。

• (ArgumentError) —

  「custom」以外の型に対してスタイルシートが渡されました。あるいは、無効な型が渡されました。

• (ArgumentError) —

  無効なレイアウトタイプが渡されました。

#remove_stream(stream_id) ⇒ オブジェクト

streamMode が「manual」に設定されて開始された、現在配信中のストリームを削除します。この機能の詳細については、<https://tokbox.com/developer/rest/#selecting-broadcast-streams>.

パラメータ：

• stream_id (文字列) —

  放送から削除するストリームのID

引き上げ：

• (OpenTokBroadcastError) —

  この放送の streamMode が「manual」に設定されていません。

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

OpenTokの配信を停止します。

#to_json ⇒ オブジェクト

ブロードキャストをJSON形式でエンコードした文字列表現。