セッション

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

\OpenTok\OpenTok->createSession() メソッドを使用して、OpenTok セッションを作成します。 Session オブジェクトの getSessionId() メソッドを使用して、セッション ID を取得します。

方法

generateToken()

セッションに接続するためのトークンを作成します。ユーザーを認証するために、クライアントはセッションに接続する際にこのトークンを渡します。

public generateToken([array<string|int, mixed> $options = array() ][, bool $legacy = false ]) : string

テストを行うには、トークンを生成するか、またはご自身のアカウントにログインして OpenTok Video API Account.

パラメータ

$options : array<string|int, mixed> = array() : この配列は、トークンのオプションを定義します。この配列には以下のキーが含まれており、いずれもオプションです：

- `'role'` (string) — One of the constants defined in the RoleConstants
  class. The default role is publisher
- `'expireTime'` (int) — The timestamp for when the token expires,
  in milliseconds since the Unix epoch. The default expiration time is 24 hours
  after the token creation time. The maximum expiration time is 30 days after the
  token creation time.
- `'data'` (string) — A string containing connection metadata
  describing the end-user. For example, you can pass the user ID, name, or other data
  describing the end-user. The length of the string is limited to 1000 characters.
  This data cannot be updated once it is set.

$legacy : bool = false : 接続トークンは、SHA-256で署名されたJWTになりました。これを次のように設定してください true レガシーT1形式を使用してトークンを作成するには。

戻り値

文字列 —

トークンの文字列。

getArchiveMode()

セッションを自動的にアーカイブするかどうか（ArchiveMode::ALWAYS）またはアーカイブしないかどうか（ArchiveMode::MANUAL）を指定します。

public getArchiveMode() : ArchiveMode

参照 OpenTok->createSession() そしてアーカイブモード.

戻り値

アーカイブモード —

getE2EE()

いずれにせよエンドツーエンドの暗号化そのセッション用に設定されています。

public getE2EE() : bool

戻り値

bool —

getLocation()

ロケーションヒントのIPアドレスを返します。

public getLocation() : string

参照 OpenTok->createSession().

戻り値

文字列 —

getMediaMode()

セッションのストリームがピア間で直接送信される場合は MediaMode::RELAYED を返し、セッションのストリームが OpenTok Media Router を使用して送信される場合は MediaMode::ROUTED を返します。

public getMediaMode() : MediaMode

参照 OpenTok->createSession() そして MediaMode.

戻り値

MediaMode —

getSessionId()

セッションを一意に識別するセッションIDを返します。

public getSessionId() : string

戻り値

文字列 —