継承元： : Object

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

概要

OpenTokストリームを操作するためのクラスです。このクラスには、OpenTokストリームに関する情報を取得するメソッド、ストリームのレイアウトクラスを設定するメソッド、およびストリームをミュートするメソッドが含まれています。

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

• #すべて(session_id) ⇒ StreamList

  このメソッドを使用すると、セッション内のすべての OpenTok ストリームに関する情報を取得できます。

• #disable_force_mute(session_id) ⇒ オブジェクト

  セッションのアクティブなミュート状態を解除します。

• #検索(session_id, stream_id) ⇒ Stream

  このメソッドを使用して、OpenTokストリームに関する情報を取得します。

• #force_mute(session_id, stream_id) ⇒ オブジェクト

  OpenTokセッションに接続されている特定のストリームを強制的にミュートにする。

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

  OpenTokセッションに接続されているすべてのストリーム（オプションで指定されたストリーム一覧を除く）について、配信中のオーディオをミュートするように強制します。

• #レイアウト(session_id, opts) ⇒ オブジェクト

  このメソッドを使用して、合成された（アーカイブまたは放送用）OpenTokストリームのレイアウトを設定します。

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

#すべて(session_id) ⇒ ストリームリスト

このメソッドを使用すると、セッション内のすべての OpenTok ストリームに関する情報を取得できます。

たとえば、このメソッドを呼び出すことで、OpenTok ストリームで使用されているレイアウトクラスに関する情報を取得できます。レイアウトクラスは、ライブストリーミング放送や編集済みアーカイブのレイアウト内で、ストリームがどのように表示されるかを定義します。詳細については、以下を参照してください。 ライブ配信において、ストリームにレイアウトクラスを割り当てる そして 構成されたアーカイブのビデオレイアウトをカスタマイズする.

パラメータ：

• session_id (文字列) —

  OpenTok セッションのセッション ID。

リターンズ

• (ストリームリスト) —

  Stream オブジェクトの StreamList。

引き上げ：

• (ArgumentError) —

  stream_id または session_id が無効です。

• (OpenTok認証エラー) —

  ストリーム情報を取得する権限がありません。認証情報を確認してください。

• (OpenTokエラー) —

  OpenTokサーバーのエラーです。

#disable_force_mute(session_id) ⇒ オブジェクト

セッションのアクティブなミュート状態を解除します。このメソッドを呼び出すと、そのセッションに配信される新しいストリームの音声はミュートされなくなります。

force_mute_all() メソッドを呼び出した後、その呼び出し後にパブリッシュされるすべてのストリームは、音声がミュートされた状態でパブリッシュされます。セッションのミュート状態を解除するには、disable_force_mute() メソッドを呼び出してください。これにより、新しくパブリッシュされるストリームが自動的にミュートされるのを防ぐことができます。

パラメータ：

• session_id (文字列) —

  セッションID。

#検索(session_id, stream_id) ⇒ ストリーム

このメソッドを使用して、OpenTokストリームに関する情報を取得します。

たとえば、このメソッドを呼び出すことで、OpenTok ストリームで使用されているレイアウトクラスに関する情報を取得できます。レイアウトクラスは、放送ストリームのレイアウト内でそのストリームがどのように表示されるかを定義します。詳細については、以下を参照してください。 ライブ配信において、ストリームにレイアウトクラスを割り当てる そして 構成されたアーカイブのビデオレイアウトをカスタマイズする.

パラメータ：

• session_id (文字列) —

  OpenTok セッションのセッション ID。

• stream_id (文字列) —

  セッション内のストリームID。

リターンズ

• (ストリーム) —

  Streamオブジェクト。

引き上げ：

• (ArgumentError) —

  stream_id または session_id が無効です。

• (OpenTok認証エラー) —

  ストリーム情報を取得する権限がありません。認証情報を確認してください。

• (OpenTokエラー) —

  OpenTokサーバーのエラーです。

#force_mute(session_id, stream_id) ⇒ オブジェクト

OpenTokセッションに接続されている特定のストリームを強制的にミュートにする。

パラメータ：

• session_id (文字列) —

  OpenTok セッションのセッション ID。

• stream_id (文字列) —

  セッション内のストリームのストリームID。

#force_mute_all(session_id, opts = {}) ⇒ オブジェクト

OpenTokセッションに接続されているすべてのストリーム（オプションで指定されたストリーム一覧を除く）について、配信中のオーディオをミュートするように強制します。

既存のストリームに加え、このメソッドの呼び出し後に公開されるすべてのストリームは、音声がミュートされた状態で公開されます。disable_force_mute() メソッドを呼び出すことで、セッションのミュート状態を解除できます。

これはオプションのプロパティです。このプロパティを省略すると、セッション内のすべてのストリームの音量がミュートされます。

パラメータ：

• session_id (文字列) —

  セッションID。

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

  ミュート操作のオプションを定義するオプションのハッシュ。例：

  コピー

  "excluded_streams" => [
    "excludedStreamId1",
    "excludedStreamId2"
  ]
  

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

• :excluded_streams (配列)

  -

  ミュートにしてはいけないストリームのストリームID。

#レイアウト(session_id, opts) ⇒ オブジェクト

このメソッドを使用して、合成された（アーカイブまたは放送用）OpenTokストリームのレイアウトを設定します。

たとえば、このメソッドを呼び出すことで、OpenTok ストリームのレイアウトクラスを設定できます。レイアウトクラスは、ライブ配信や編集済みアーカイブのレイアウト内で、ストリームがどのように表示されるかを定義します。詳細については、以下を参照してください。 ライブ配信において、ストリームにレイアウトクラスを割り当てる そして 構成されたアーカイブのビデオレイアウトをカスタマイズする.

詳細については、「レイアウト」を参照してください<https://tokbox.com/developer/rest/#change-stream-layout-classes-composed>

パラメータ：

• session_id (文字列) —

  OpenTok セッションのセッション ID。

• opts (ハッシュ) —

  キーが1つだけのハッシュ items および、以下の要素を持つオブジェクトの配列としての値 stream_id そして layoutClassList の特性を持つ。

引き上げ：

• (ArgumentError) —

  session_id が無効です。

• (OpenTok認証エラー) —

  ストリーム情報を取得する権限がありません。認証情報を確認してください。

• (OpenTokStreamLayoutError) —

  レイアウト値が正しくないため、レイアウト操作を実行できませんでした。

• (OpenTokエラー) —

  OpenTokサーバーのエラーです。