継承元： : Object

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

概要

OpenTokセッションを表します。

OpenTok.createSession() メソッドを使用して、OpenTok セッションを作成します。Session オブジェクトの session_id プロパティを使用して、セッション ID を取得します。

インスタンス属性の概要

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

インスタンス属性の詳細

#:アーカイブの解像度 ⇒ 文字列（読み取り専用）

自動アーカイブセッションにおけるアーカイブの解凍。

リターンズ

  • (文字列) —

    :archive_resolution の現在の値

#archive_mode ⇒ 文字列（読み取り専用）

セッションが自動的にアーカイブされるかどうか（:always)または(:manual).

リターンズ

  • (文字列) —

    archive_mode の現在の値

#アーカイブ名 ⇒ 文字列（読み取り専用）

自動アーカイブされるセッションのアーカイブに付ける名前。

リターンズ

  • (文字列) —

    archive_name の現在の値

#アーカイブの解像度 ⇒ オブジェクト（読み取り専用）

attribute archive_resolution の値を返します。

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

属性 e2ee の値を返します。

#場所 ⇒ 文字列（読み取り専用）

ロケーションのヒントとなるIPアドレス。OpenTok.createSession() メソッドを参照してください。

リターンズ

  • (文字列) —

    その場所の現在の値

#media_mode ⇒ 文字列（読み取り専用）

セッションが OpenTok Media Router を使用する場合は :routed に、クライアント間でストリームを直接送信しようとする場合は :relayed に設定します。

リターンズ

  • (文字列) —

    media_mode の現在の値

#session_id ⇒ 文字列（読み取り専用）

セッションID。

リターンズ

  • (文字列) —

    session_id の現在の値

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

#generate_token(オプション) ⇒ 文字列

トークンを生成します。

パラメータ：

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

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

  • :token_type (文字列)

    -

    生成するトークンの種類。‘T1’ または ‘JWT’ のいずれかを指定する必要があります。デフォルトは ‘JWT’ です。

  • :role (シンボル)

    -

    トークンの役割。以下のいずれかの値に設定してください：

    • :subscriber – 加入者はストリームのみを購読できます。
    • :publisher – パブリッシャーは、ストリームの配信、ストリームの購読、およびシグナルの送信を行うことができます。（ロールを指定しない場合のデフォルト値です。）
    • :publisheronly – 「publisheronly」トークンで接続したクライアントは、ストリームを配信することはできますが、ストリームを購読することはできません。
    • :moderator – 配信者に付与される権限に加え、モデレーターは、クライアントの接続切断を強制したり、配信を停止させたり、配信中のストリームの音声をミュートしたりといったモデレーション機能を実行できます。詳しくは、 / モデレーション開発者ガイド.

  • :expire_time (整数)

    -

    有効期限は、UNIXエポックからの経過時間（秒単位）です。0を指定すると、トークン作成時から24時間というデフォルトの有効期限が適用されます。有効期限の上限は、作成時から30日間です。

  • :data (文字列)

    -

    エンドユーザーに関する接続メタデータを含む文字列です。たとえば、ユーザーID、名前、またはエンドユーザーに関するその他のデータを渡すことができます。文字列の長さは1000文字までに制限されています。このデータは、一度設定されると更新することはできません。

  • :initial_layout_class_list (配列)

    -

    クライアントによって公開されるストリームの初期レイアウトクラスとして使用されるクラス名（文字列）の配列。レイアウトクラスは、動画のレイアウトをカスタマイズする際に使用されます。 / ライブ配信 そして 整理済みのアーカイブ.

リターンズ

  • (文字列) —

    トークンの文字列。