Sitzung

Stellt eine OpenTok-Sitzung dar.

Verwenden Sie die Methode \OpenTok\OpenTok->createSession(), um eine OpenTok-Sitzung zu erstellen. Verwenden Sie die Methode getSessionId() des Session-Objekts, um die Sitzungs-ID abzurufen.

Inhaltsverzeichnis

generateToken()  : string : Erstellt ein Token für die Verbindung zur Sitzung. Zur Authentifizierung eines Benutzers übermittelt der Client bei der Verbindung zur Sitzung ein Token.

getArchiveMode()  : Archivmodus : Legt fest, ob die Sitzung automatisch archiviert wird (ArchiveMode::ALWAYS) oder nicht (ArchiveMode::MANUAL).

getE2EE()  : bool : Ob End-to-End-Verschlüsselung ist für die Sitzung festgelegt.

getLocation()  : string : Gibt die IP-Adresse des Standorthinweises zurück.

getMediaMode()  : MediaMode : Gibt „MediaMode::RELAYED“ zurück, wenn die Streams der Sitzung direkt zwischen den Peers übertragen werden; gibt „MediaMode::ROUTED“ zurück, wenn die Streams der Sitzung über den OpenTok Media Router übertragen werden.

getSessionId()  : string : Gibt die Sitzungs-ID zurück, die die Sitzung eindeutig identifiziert.

Methoden

generateToken()

Erstellt ein Token für die Verbindung zur Sitzung. Um einen Benutzer zu authentifizieren, übermittelt der Client bei der Verbindung zur Sitzung ein Token.

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

Zu Testzwecken können Sie auch Tokens generieren oder sich bei Ihrem Konto anmelden, um OpenTok Video API-Account.

Parameter

$options : array<string|int, mixed> = array() : Dieses Array definiert Optionen für das Token. Es enthält die folgenden Schlüssel, die alle optional sind:

- `'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 : Verbindungstoken sind nun mit SHA-256 signierte JWTs. Setzen Sie diesen Wert auf true um ein Token im alten T1-Format zu erstellen.

Rückgabewerte

Zeichenkette —

Die Token-Zeichenkette.

getArchiveMode()

Legt fest, ob die Sitzung automatisch archiviert wird (ArchiveMode::ALWAYS) oder nicht (ArchiveMode::MANUAL).

public getArchiveMode() : ArchiveMode

Siehe OpenTok->createSession() und Archivmodus.

Rückgabewerte

Archivmodus —

getE2EE()

Ob End-to-End-Verschlüsselung ist für die Sitzung festgelegt.

public getE2EE() : bool

Rückgabewerte

bool —

getLocation()

Gibt die IP-Adresse des Standorthinweises zurück.

public getLocation() : string

Siehe OpenTok->createSession().

Rückgabewerte

Zeichenkette —

getMediaMode()

Gibt „MediaMode::RELAYED“ zurück, wenn die Streams der Sitzung direkt zwischen den Peers übertragen werden; gibt „MediaMode::ROUTED“ zurück, wenn die Streams der Sitzung über den OpenTok Media Router übertragen werden.

public getMediaMode() : MediaMode

Siehe OpenTok->createSession() und MediaMode.

Rückgabewerte

MediaMode —

getSessionId()

Gibt die Sitzungs-ID zurück, die die Sitzung eindeutig identifiziert.

public getSessionId() : string

Rückgabewerte

Zeichenkette —