OpenTok
Enthält Methoden zum Erstellen von OpenTok-Sitzungen, zum Generieren von Tokens und zum Arbeiten mit Archiven.
Um ein neues OpenTok-Objekt zu erstellen, rufen Sie den Konstruktor OpenTok() mit Ihrem OpenTok-API-Schlüssel und dem API-Geheimnis für Ihre OpenTok Video API-Account. Geben Sie Ihr API-Geheimnis nicht öffentlich weiter. Sie verwenden es mit dem OpenTok()-Konstruktor (ausschließlich auf Ihrem Webserver ), um OpenTok-Sitzungen zu erstellen.
Wenn Sie „api_key“ auf eine VONAGE_APPLICATION_ID und „api_secret“ auf einen VONAGE_PRIVATE_KEY_PATH setzen, wird das SDK stattdessen über „Vonage Auth“ eine Anfrage an Vonage Video senden.
Stellen Sie sicher, dass das gesamte OpenTok-Server-SDK auf Ihrem Webserver installiert ist.
Inhaltsverzeichnis
$vonage : bool
connectAudio() : array<string|int, mixed> : Startet ein Audio-Anschluss WebSocket-Verbindung. Zum Senden von Audio aus einer Vonage Video API-Sitzung an einen WebSocket.
createSession() : Sitzung : Erstellt eine neue OpenTok-Sitzung und gibt die Sitzungs-ID zurück, die die Sitzung eindeutig identifiziert.
deleteArchive() : bool : Löscht ein OpenTok-Archiv.
dial() : SipCall : Leitet einen ausgehenden SIP-Anruf ein.
disableForceMute() : bool : Deaktiviert den aktiven Stummschaltungsstatus der Sitzung. Nach dem Aufruf dieser Methode wird bei neuen Streams, die in der Sitzung veröffentlicht werden, der Ton nicht mehr stummgeschaltet.
forceDisconnect() : gemischt : Trennt einen bestimmten Client von einer OpenTok-Sitzung.
forceMuteAll() : bool : Alle Streams (mit Ausnahme einer optionalen Liste von Streams) in einer OpenTok-Sitzung zwingen, das veröffentlichte Audio stummzuschalten.
forceMuteStream() : bool : Den Herausgeber eines bestimmten Streams dazu zwingen, den von ihm veröffentlichten Ton stummzuschalten.
generateToken() : string : Erstellt ein Token für die Verbindung zu einer OpenTok-Sitzung.
getArchive() : Archiv : Ruft ein Archivobjekt für die angegebene Archiv-ID ab.
getBroadcast() : Sendung : Ruft Informationen zu einer OpenTok-Übertragung ab.
getRender() : Rendering : Ein vorhandenes Rendering abrufen, um den Status anzuzeigen. Der Status kann einer der folgenden sein: <UL> <LI><CODE>starting</CODE> — Die Vonage Video API-Plattform stellt gerade eine Verbindung zur Remote-Anwendung unter der angegebenen URL her. Dies ist der Anfangszustand.</LI> <LI><CODE>started</CODE> — Die Vonage Video API-Plattform hat erfolgreich eine Verbindung zum Remote-Anwendungsserver hergestellt und veröffentlicht diese Medien erneut auf der Vonage Video API-Plattform.</LI> <LI><CODE>stopped</CODE> — Der Render-Vorgang wurde beendet.</LI> <LI><CODE>failed</CODE> — Es ist ein Fehler aufgetreten, und der Render-Vorgang konnte nicht fortgesetzt werden. Dies kann beim Start auftreten, wenn der Opentok-Server keine Verbindung zum Remote-Anwendungsserver herstellen oder den Stream nicht erneut veröffentlichen kann. Es kann auch zu einem beliebigen Zeitpunkt während des Render-Vorgangs aufgrund eines Fehlers in der Vonage Video API-Plattform auftreten.</LI> </ul>
getStream() : Stream : Ruft ein Stream-Objekt ab, das Informationen zu einem bestimmten Stream liefert.
listArchives() : Archivliste : Gibt eine Liste der Archive für eine Sitzung zurück.
listRenders() : gemischt : Gibt eine Liste der Experience Composer-Renderer für ein OpenTok-Projekt zurück.
listStreams() : StreamList : Gibt ein StreamList-Objekt für die angegebene Sitzungs-ID zurück.
playDTMF() : void : Spielt eine DTMF-Zeichenkette in einer Sitzung oder an eine bestimmte Verbindung ab
setArchiveLayout() : void : Aktualisiert das Stream-Layout in einem OpenTok-Archiv.
setStreamClassLists() : gemischt : Legt die Liste der Layout-Klassen für Streams in einer Sitzung fest.
signal() : gemischt : Sendet ein Signal an Clients (oder einen bestimmten Client), die mit einer OpenTok-Sitzung verbunden sind.
startArchive() : Archiv : Beginnt mit der Archivierung einer OpenTok-Sitzung.
startBroadcast() : Sendung : Startet eine Live-Streaming-Übertragung einer OpenTok-Sitzung.
startCaptions() : array<string|int, mixed> : Verwenden Sie diese Methode, um Echtzeit-Live-Untertitel für eine OpenTok-Sitzung zu starten.
startRender() : Rendering : Startet einen Experience Composer-Renderer für eine OpenTok-Sitzung.
stopArchive() : Archiv : Beendet die Aufzeichnung eines OpenTok-Archivs, das gerade aufgezeichnet wird.
stopBroadcast() : Sendung : Beendet eine Übertragung.
stopCaptions() : gemischt : Verwenden Sie diese Methode, um die Live-Untertitel für eine Sitzung zu deaktivieren.
stopRender() : gemischt : Bricht einen laufenden Rendervorgang ab.
updateBroadcastLayout() : void : Aktualisiert das Layout der Sendung.
updateStream() : gemischt : Legt die Liste der Layout-Klassen für einen Stream fest.
returnLegacyToken() : Zeichenfolge
Eigenschaften
$vonage
private bool $vonage = false
Überschreibung, um festzulegen, ob bei Anfragen die Vonage-Server mit „Vonage Auth“ angesprochen werden sollen
Methoden
connectAudio()
Startet ein Audio-Anschluss WebSocket-Verbindung. Zum Senden von Audio aus einer Vonage Video API-Sitzung an einen WebSocket.
public connectAudio(string $sessionId, string $token, array<string|int, mixed> $websocketOptions) : array<string|int, mixed>
Parameter
$sessionId : string : Die Sitzungs-ID.
$token : string : Das OpenTok-Token, das für den Audio-Connector zur OpenTok-Sitzung verwendet werden soll. Sie können Token-Daten hinzufügen, um zu kennzeichnen, dass es sich bei der Verbindung um den Endpunkt des Audio-Connectors handelt, oder um andere identifizierende Daten bereitzustellen.
$websocketOptions : array<string|int, mixed> : Konfiguration für den WebSocket. Enthält die folgenden Schlüssel:
- `'uri'` (string) — A publically reachable WebSocket URI controlled by the customer for the destination of the connect call. (f.e. wss://service.com/wsendpoint)
- `'streams'` (array) — (Optional) The stream IDs of the participants' whose audio is going to be connected. If not provided, all streams in session will be selected.
- `'headers'` (array) — (Optional) An object of key/val pairs with additional properties to send to your Websocket server, with a maximum length of 512 bytes.
Rückgabewerte
array<string|int, mixed> —
$response Antwort der API, die wie folgt aufgebaut ist:
'id'(Zeichenkette) — Eine eindeutige ID, die den Audio-Connector- WebSocket identifiziert.'connectionId'(Zeichenkette) — Die ID der erstellten Opentok-Client-Verbindung. Diese Verbindung abonniert die in der Nutzlast definierten Streams und leitet sie an den WebSocket weiter; wie bei jedem anderen Teilnehmer wird dabei ein „connectionCreated“-Ereignis für die Sitzung ausgelöst.
createSession()
Erstellt eine neue OpenTok-Sitzung und gibt die Sitzungs-ID zurück, die die Sitzung eindeutig identifiziert.
public createSession([array<string|int, mixed> $options = array() ]) : Session
Wenn Sie beispielsweise die OpenTok-JavaScript-Bibliothek verwenden, geben Sie beim Aufruf der OT.initSession() Methode (zum Initialisieren einer OpenTok-Sitzung).
OpenTok-Sitzungen laufen nicht ab. Authentifizierungstoken verfallen jedoch (siehe die Methode `generateToken()`). Beachten Sie außerdem, dass Sitzungen nicht explizit beendet werden können.
Eine Sitzungs-ID-Zeichenkette kann bis zu 255 Zeichen lang sein.
Der Aufruf dieser Methode führt im Fehlerfall zu einer OpenTokException. Weitere Informationen finden Sie in der Fehlermeldung.
Sie können eine Sitzung auch erstellen, indem Sie sich bei Ihrem OpenTok Video API-Account.
Parameter
$options : array<string|int, mixed> = array() : (Optional) Dieses Array definiert Optionen für die Sitzung. Das Array enthält die folgenden Schlüssel (die alle optional sind):
- `'archiveMode'` (ArchiveMode) — Whether the session is automatically
archived (`ArchiveMode::ALWAYS`) or not (`ArchiveMode::MANUAL`).
By default, the setting is `ArchiveMode.MANUAL`, and you must call the
`OpenTok->startArchive()` method to start archiving. To archive the session
(either automatically or not), you must set the `mediaMode` key to
`MediaMode::ROUTED`.
- `'e2ee'` (Boolean) — Whether to enable
[end-to-end encryption](https://tokbox.com/developer/guides/end-to-end-encryption)
for a routed session.
- `archiveName` (String) — Name of the archives in auto archived sessions
- `archiveResolution` (Enum) — Resolution of the archives in
auto archived sessions. Can be one of "480x640", "640x480", "720x1280", "1280x720", "1080x1920", "1920x1080"
- `'location'` (String) — An IP address that the OpenTok servers
will use to situate the session in its global network. If you do not set a location hint,
the OpenTok servers will be based on the first client connecting to the session.
- `'mediaMode'` (MediaMode) — Whether the session will transmit
streams using the OpenTok Media Router (`MediaMode.ROUTED`) or not
(`MediaMode.RELAYED`). By default, the `mediaMode` property
is set to `MediaMode.RELAYED`.
With the `mediaMode` parameter set to `MediaMode.RELAYED`, the
session will attempt to transmit streams directly between clients. If clients cannot
connect due to firewall restrictions, the session uses the OpenTok TURN server to relay
audio-video streams.
The
[OpenTok Media Router](/opentok/guides/create-session/#media-mode) provides the following benefits:
- The OpenTok Media Router can decrease bandwidth usage in multiparty sessions.
(When the `mediaMode` parameter is set to `MediaMode.ROUTED`,
each client must send a separate audio-video stream to each client subscribing to
it.)
- The OpenTok Media Router can improve the quality of the user experience through
recovery. With these features, if a client's connectivity degrades to a degree
that it does not support video for a stream it's subscribing to, the video is dropped
on that client (without affecting other clients), and the client receives audio only.
If the client's connectivity improves, the video returns.
- The OpenTok Media Router supports the
[archiving](/opentok/guides/archiving)
feature, which lets you record, save, and retrieve OpenTok sessions.
Rückgabewerte
Sitzung —
Ein Session-Objekt, das die neue Sitzung repräsentiert. Rufen Sie die
getSessionId() Methode dieses Objekts, um die Sitzungs-ID abzurufen. Wenn Sie beispielsweise
die OpenTok.js-Bibliothek verwenden, nutzen Sie diese Sitzungs-ID beim Aufruf der
OT.initSession() Methode.
deleteArchive()
Löscht ein OpenTok-Archiv.
public deleteArchive(string $archiveId) : bool
Sie können nur ein Archiv löschen, dessen Status „verfügbar“, „hochgeladen“ oder „gelöscht“ lautet. Durch das Löschen eines Archivs wird dessen Eintrag aus der Liste der Archive entfernt. Bei einem „verfügbaren“ Archiv wird zudem die Archivdatei entfernt, sodass sie nicht mehr zum Herunterladen zur Verfügung steht. Bei einem „gelöschten“ Archiv bleibt das Archiv gelöscht.
Parameter
$archiveId : string : Die Archiv-ID des Archivs, das Sie löschen möchten.
Stichwörter
löst : ArchiveException
There archive status is not "available", "updated",
or "deleted".
Rückgabewerte
bool —
Gibt bei Erfolg „true“ zurück.
dial()
Leitet einen ausgehenden SIP-Anruf ein.
public dial(string $sessionId, string $token, string $sipUri[, array<string|int, mixed> $options = [] ]) : SipCall
Weitere Informationen finden Sie in der OpenTok SIP Interconnect Entwicklerhandbuch.
Parameter
$sessionId : string : Die ID der OpenTok-Sitzung, an der der angerufene Teilnehmer teilnehmen wird.
$token : string : Das OpenTok-Token, das für den angerufenen Teilnehmer verwendet werden soll. Sie können Token-Daten hinzufügen, um zu kennzeichnen, dass sich der Teilnehmer an einem SIP-Endpunkt befindet, oder um andere identifizierende Daten wie beispielsweise Telefonnummern anzugeben. Generieren Sie ein Token mithilfe der OpenTok::generateToken() oder Session::generateToken() Methode.
$sipUri : string : Die SIP-URI, die als Ziel des von OpenTok an die SIP-Plattform eines Drittanbieters initiierten SIP-Anrufs verwendet werden soll.
If the URI contains a transport=tlsheader, the negotiation between TokBox and
the SIP endpoint will be done securely. Note that this will only apply to the negotiation
itself, and not to the transmission of audio. To have audio transmission be encrypted,
see the "secure" property of the `options` parameter.
This is an example of secure call negotiation: "sip:access@thirparty.com;transport=tls".
This is an example of insecure call negotiation: "sip:access@thirparty.com".
$options : array<string|int, mixed> = [] : Dieses Array definiert Optionen für den SIP-Anruf. Es enthält die folgenden Schlüssel, die alle optional sind:
- `'headers'` (array) — Headers: Custom Headers to be added to the
SIP INVITE request initiated from OpenTok to the Third Party SIP Platform.
- `'auth'` (array) — Auth: Username and Password to be used in the SIP
INVITE request for HTTP Digest authentication in case this is required by the Third Party
SIP Platform.
- `'username'` (string) — The username to be used
in the the SIP INVITE request for HTTP digest authentication (if one
is required).
- `'password'` (string) — The password to be used
in the the SIP INVITE request for HTTP digest authentication.
- `'secure'` (Boolean) — Indicates whether the media
must be transmitted encrypted (true, the default) or not (false).
- `'observeForceMute'` (Boolean) — Whether the SIP endpoint should honor
[force mute moderation](https://tokbox.com/developer/guides/moderation/#force_mute)
(True) or not (False, the default).
- `'from'` (string) — The number or string that will be sent to
the final SIP number as the caller. It must be a string in the form of
"from@example.com", where from can be a string or a number. If from is set to a number
(for example, "14155550101@example.com"), it will show up as the incoming number
on PSTN phones. If from is undefined or set to a string (for example, "joe@example.com"),
+00000000 will show up as the incoming number on PSTN phones.
- `'streams'` (array) — The Stream IDs of the participants which will included in the SIP
call. If not provided, all streams in session will be selected.
Rückgabewerte
SipCall —
Ein Objekt enthält die OpenTok-Verbindungs-ID und die Stream-ID für die Verbindung des SIP-Anrufs in der OpenTok-Sitzung. Sie können die Verbindungs-ID verwenden, um den SIP-Anruf zu beenden, und zwar mithilfe der OpenTok::method_forceDisconnect() Methode.
disableForceMute()
Hebt den aktiven Stummschaltungsstatus der Sitzung auf. Nachdem Sie diese Methode aufgerufen haben, wird bei neuen Streams, die in der Sitzung veröffentlicht werden, der Ton nicht mehr stummgeschaltet.
public disableForceMute(string $sessionId, array<string|int, string> $options) : bool
Nachdem Sie die OpenTok->forceMuteAll() Methode Alle nach dem Aufruf veröffentlichten Streams werden mit stummgeschaltetem Ton veröffentlicht. Rufen Sie die Methode `disableForceMute()` auf, um den Stummschaltungsstatus einer Sitzung aufzuheben, damit neu veröffentlichte Streams nicht automatisch stummgeschaltet werden.
Parameter
$sessionId : string : Die OpenTok-Sitzungs-ID.
$options : Array<Zeichenkette|Ganzzahl, Zeichenkette> : Dieses Array definiert Optionen und enthält die folgenden Schlüssel:
- `'excludedStreams'` (array, optional) — An array of stream IDs
corresponding to streams that should not be muted. This is an optional property.
If you omit this property, all streams in the session will be muted.
Rückgabewerte
bool —
Ob der Anruf erfolgreich war oder fehlgeschlagen ist.
forceDisconnect()
Trennt einen bestimmten Client von einer OpenTok-Sitzung.
public forceDisconnect(string $sessionId, string $connectionId) : mixed
Parameter
$sessionId : string : Die OpenTok-Sitzungs-ID, mit der der Client verbunden ist.
$connectionId : string : Die Verbindungs-ID der Verbindung in der Sitzung.
Rückgabewerte
gemischt —
forceMuteAll()
Alle Streams (mit Ausnahme einer optionalen Liste von Streams) in einer OpenTok-Sitzung dazu zwingen, das veröffentlichte Audio stummzuschalten.
public forceMuteAll(string $sessionId, array<string|int, string> $options) : bool
Zusätzlich zu den bereits bestehenden Streams werden alle Streams, die nach dem Aufruf dieser Methode veröffentlicht werden, mit stummgeschaltetem Ton veröffentlicht. Sie können den Stummschaltungsstatus einer Sitzung aufheben OpenTok->disableForceMute() Methode.
Siehe auch die OpenTok->forceMuteStream() Methode.
Parameter
$sessionId : string : Die OpenTok-Sitzungs-ID.
$options : Array<Zeichenkette|Ganzzahl, Zeichenkette> : Dieses Array definiert Optionen und enthält die folgenden Schlüssel:
- `'excludedStreams'` (array, optional) — An array of stream IDs
corresponding to streams that should not be muted. This is an optional property.
If you omit this property, all streams in the session will be muted.
Rückgabewerte
bool —
Ob der Anruf erfolgreich war oder fehlgeschlagen ist.
forceMuteStream()
Den Herausgeber eines bestimmten Streams dazu zwingen, den von ihm veröffentlichten Ton stummzuschalten.
public forceMuteStream(string $sessionId, string $streamId) : bool
Siehe auch die OpenTok->forceMuteAll() Methode.
Parameter
$sessionId : string : Die OpenTok-Sitzungs-ID, die den Stream enthält.
$streamId : string : Die Stream-ID.
Rückgabewerte
bool —
Ob der Anruf erfolgreich war oder fehlgeschlagen ist.
generateToken()
Erstellt ein Token für die Verbindung zu einer OpenTok-Sitzung.
public generateToken(string $sessionId[, array<string|int, mixed> $payload = array() ][, bool $legacy = false ]) : string
Um einen Benutzer zu authentifizieren, der eine Verbindung zu einer OpenTok-Sitzung herstellt, übermittelt der Client bei der Verbindungsherstellung ein Token.
Zu Testzwecken generieren Sie Tokens oder melden sich bei Ihrem OpenTok Video API-Account.
Parameter
$sessionId : string : Die Sitzungs-ID der Sitzung, mit der sich der Benutzer verbinden wird.
$payload : 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.
- `initialLayoutClassList` (array) — An array of class names (strings)
to be used as the initial layout classes for streams published by the client. Layout
classes are used in customizing the layout of videos in
[live streaming
broadcasts](https://tokbox.com/developer/guides/broadcast/live-streaming/) and
[composed
archives](https://tokbox.com/developer/guides/archiving/layout-control.html).
$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.
getArchive()
Ruft ein Archivobjekt für die angegebene Archiv-ID ab.
public getArchive(string $archiveId) : Archive
Parameter
$archiveId : string : Die Archiv-ID.
Stichwörter
löst : ArchiveException
There is no archive with the specified ID.
wirft : InvalidArgumentException
The archive ID provided is null or an empty string.
Rückgabewerte
Archiv —
Das Archiv-Objekt.
getBroadcast()
Ruft Informationen zu einer OpenTok-Übertragung ab.
public getBroadcast(string $broadcastId) : Broadcast
Parameter
$broadcastId : string : Die ID der Übertragung.
Rückgabewerte
Sendung —
Ein Objekt mit Eigenschaften, die die Übertragung definieren.
getRender()
Rufen Sie einen vorhandenen Render ab, um den Status anzuzeigen. Der Status kann einer der folgenden sein: <UL> <LI><CODE>starting</CODE> — Die Vonage Video API-Plattform stellt gerade eine Verbindung zur Remote-Anwendung unter der angegebenen URL her. Dies ist der Anfangszustand.</LI> <LI><CODE>started</CODE> — Die Vonage Video API-Plattform hat erfolgreich eine Verbindung zum Remote-Anwendungsserver hergestellt und veröffentlicht diese Medien erneut auf der Vonage Video API-Plattform.</LI> <LI><CODE>stopped</CODE> — Der Render-Vorgang wurde beendet.</LI> <LI><CODE>failed</CODE> — Es ist ein Fehler aufgetreten, und der Render-Vorgang konnte nicht fortgesetzt werden. Dies kann beim Start auftreten, wenn der Opentok-Server keine Verbindung zum Remote-Anwendungsserver herstellen oder den Stream nicht erneut veröffentlichen kann. Es kann auch zu einem beliebigen Zeitpunkt während des Render-Vorgangs aufgrund eines Fehlers in der Vonage Video API-Plattform auftreten.</LI> </UL>
public getRender( $renderId) : Render
Parameter
$renderId :
Rückgabewerte
getStream()
Ruft ein Stream-Objekt ab, das Informationen zu einem bestimmten Stream liefert.
public getStream(string $sessionId, string $streamId) : Stream
Parameter
$sessionId : string : Die Sitzungs-ID der OpenTok-Sitzung, die den Stream enthält.
$streamId : string : Die Stream-ID.
Rückgabewerte
Stream —
Das Stream-Objekt.
listArchives()
Gibt eine Liste der Archive für eine Sitzung zurück.
public listArchives(int $offset[, int $count = null ][, string $sessionId = null ]) : ArchiveList
Die items() Die Methode dieses Objekts gibt eine Liste der
abgeschlossenen und noch laufenden Archive für Ihren API-Schlüssel zurück.
Parameter
$offset : int : Optional. Der Index-Offset des ersten Archivs. 0 ist der Offset des zuletzt gestarteten Archivs. 1 ist der Offset des Archivs, das vor dem zuletzt gestarteten Archiv gestartet wurde. Wenn Sie keinen Offset angeben, wird 0 verwendet.
$count : int = null : Optional. Die Anzahl der zurückzugebenden Archive. Die maximale Anzahl der zurückgegebenen Archive beträgt 1000.
$sessionId : string = null : Optional. Die OpenTok-Sitzungs-ID, für die Sie Archive abrufen möchten. Wenn keine Sitzungs-ID angegeben wird, gibt die Methode Archive aus allen Sitzungen zurück, die mit dem API-Schlüssel erstellt wurden.
Rückgabewerte
Ein „ArchiveList“-Objekt. Rufen Sie die Methode „items()“ des „ArchiveList“-Objekts auf, um ein Array von „Archive“-Objekten zurückzugeben.
listRenders()
Gibt eine Liste der Experience Composer-Renderer für ein OpenTok-Projekt zurück.
public listRenders(int $offset[, int $count = 50 ]) : mixed
Parameter
$offset : int
$count : int = 50
Rückgabewerte
gemischt —
listStreams()
Gibt ein StreamList-Objekt für die angegebene Sitzungs-ID zurück.
public listStreams(string $sessionId) : StreamList
Parameter
$sessionId : string : Die Sitzungs-ID.
Rückgabewerte
Ein StreamList-Objekt. Rufen Sie die Methode items() des StreamList-Objekts auf, um ein Array von Stream-Objekten zurückzugeben.
playDTMF()
Spielt eine DTMF-Zeichenkette in eine Sitzung oder an eine bestimmte Verbindung ein
public playDTMF(string $sessionId, string $digits[, string $connectionId = null ]) : void
Parameter
$sessionId : string : Die ID der OpenTok-Sitzung, an der der angerufene Teilnehmer teilnehmen wird.
$digits : string : Zu spielende DTMF-Ziffern Gültige DTMF-Ziffern sind 0–9, p, # und *. „p“ steht für eine Pause von 500 ms, falls während des Eingabevorgangs eine Verzögerung erforderlich ist.
$connectionId : string = null : Ein optionaler Parameter, der dazu dient, die DTMF-Töne an eine bestimmte Verbindung innerhalb einer Sitzung zu senden.
Rückgabewerte
void —
setArchiveLayout()
Aktualisiert das Stream-Layout in einem OpenTok-Archiv.
public setArchiveLayout(string $archiveId, Layout $layoutType) : void
Parameter
$archiveId: Zeichenfolge
$layoutType : Layout
Rückgabewerte
void —
setStreamClassLists()
Legt die Liste der Layoutklassen für Streams in einer Sitzung fest.
public setStreamClassLists(string $sessionId[, array<string|int, mixed> $classListArray = array() ]) : mixed
Layout-Klassen werden im Layout für zusammengesetzte Archive und Live-Streaming-Übertragungen verwendet. Weitere Informationen finden Sie unter Anpassung des Video-Layouts für zusammengestellte Archive und Konfigurieren des Video-Layouts für OpenTok-Live-Streaming-Übertragungen.
Parameter
$sessionId : string : Die Sitzungs-ID der Sitzung, zu der die Streams gehören.
$classListArray : array<string|int, mixed> = array() : Die connectionId der Verbindung innerhalb einer Sitzung.
Rückgabewerte
gemischt —
signal()
Sendet ein Signal an Clients (oder einen bestimmten Client), die mit einer OpenTok-Sitzung verbunden sind.
public signal(string $sessionId, array<string|int, mixed> $payload[, string $connectionId = null ]) : mixed
Parameter
$sessionId : string : Die OpenTok-Sitzungs-ID, an die das Signal gesendet wird.
$payload : array<string|int, mixed> : Dieses Array definiert die Nutzlast für das Signal. Dieses Array enthält die folgenden Schlüssel, deren Typ optional ist:
- `'data'` (string) — The data string for the signal. You can send a maximum of 8kB.
- `'type'` (string) — (Optional) The type string for the signal. You can send a maximum of 128 characters, and only the following characters are allowed: A-Z, a-z, numbers (0-9), '-', '\_', and '~'.
$connectionId : string = null : Ein optionaler Parameter, der verwendet wird, um das Signal an eine bestimmte Verbindung innerhalb einer Sitzung zu senden.
Rückgabewerte
gemischt —
startArchive()
Beginnt mit der Archivierung einer OpenTok-Sitzung.
public startArchive(string $sessionId[, array<string|int, mixed> $options = [] ]) : Archive
Die Teilnehmer müssen aktiv mit der OpenTok-Sitzung verbunden sein, damit Sie erfolgreich mit der Aufzeichnung eines Archivs beginnen können.
Sie können pro Sitzung jeweils nur ein Archiv aufzeichnen. Sie können nur Archive von Sitzungen aufzeichnen, die den OpenTok Media Router verwenden (Sitzungen mit dem Medienbetrieb (auf „routed“ gesetzt); Sie können keine Sitzungen archivieren, bei denen der Medienmodus auf „relayed“ gesetzt ist.
Weitere Informationen zur Archivierung finden Sie unter OpenTok-Archivierung Programmübersicht .
Parameter
$sessionId : string : Die Sitzungs-ID der zu archivierenden OpenTok-Sitzung.
$options : array<string|int, mixed> = [] : (Optional) Dieses Array definiert Optionen für das Archiv. Das Array enthält die folgenden Schlüssel (die alle optional sind):
- `'name'` (String) — The name of the archive. You can use this name to
identify the archive. It is a property of the Archive object, and it is a property of
archive-related events in the OpenTok client SDKs.
- `'hasVideo'` (Boolean) — Whether the archive will record video
(true, the default) or not (false). If you set both `hasAudio` and
`hasVideo` to false, the call to the `startArchive()` method results
in an error.
- `'streamMode'` (String) — Whether streams included in the archive are
selected automatically (`StreamMode.AUTO`, the default) or manually
(`StreamMode.MANUAL`). When streams are selected automatically
(`StreamMode.AUTO`), all streams in the session can be included in the archive.
When streams are selected manually (`StreamMode.MANUAL`), you specify streams
to be included based on calls to the `Archive.addStreamToArchive()` and
`Archive.removeStreamFromArchive()`. methods. With manual mode, you can specify
whether a stream's audio, video, or both are included in the archive. In both automatic and
manual modes, the archive composer includes streams based on
[stream
prioritization rules](https://tokbox.com/developer/guides/archive-broadcast-layout/#stream-prioritization-rules).
- `'hasAudio'` (Boolean) — Whether the archive will record audio
(true, the default) or not (false). If you set both `hasAudio` and
`hasVideo` to false, the call to the `startArchive()` method results
in an error.
- `'multiArchiveTag'` (String) (Optional) — Set this to support recording multiple archives
for the same session simultaneously. Set this to a unique string for each simultaneous archive of an ongoing
session. You must also set this option when manually starting an archive
that is {https://tokbox.com/developer/guides/archiving/#automatic automatically archived}.
Note that the `multiArchiveTag` value is not included in the response for the methods to
{https://tokbox.com/developer/rest/#listing\_archives list archives} and
{https://tokbox.com/developer/rest/#retrieve\_archive\_info retrieve archive information}.
If you do not specify a unique `multiArchiveTag`, you can only record one archive at a time for a given session.
{https://tokbox.com/developer/guides/archiving/#simultaneous-archives See Simultaneous archives}.
- `'outputMode'` (OutputMode) — Whether all streams in the
archive are recorded to a single file (`OutputMode::COMPOSED`, the default)
or to individual files (`OutputMode::INDIVIDUAL`).
- `'resolution'` (String) — The resolution of the archive, either "640x480" (SD landscape,
the default), "1280x720" (HD landscape), "1920x1080" (FHD landscape), "480x640" (SD portrait), "720x1280"
(HD portrait), or "1080x1920" (FHD portrait). This property only applies to composed archives. If you set
this property and set the outputMode property to "individual", a call to the method
results in an error.
Rückgabewerte
Archiv —
Das Archiv-Objekt, das Eigenschaften enthält, die das Archiv definieren, darunter die Archiv-ID.
startBroadcast()
Startet eine Live-Streaming-Übertragung einer OpenTok-Sitzung.
public startBroadcast(string $sessionId[, array<string|int, mixed> $options = [] ]) : Broadcast
Parameter
$sessionId : string : Die Sitzungs-ID der Sitzung, die übertragen werden soll.
$options : array<string|int, mixed> = [] : (Optional) Ein Array mit Optionen für die Übertragung. Dieses Array verfügt über die folgenden Eigenschaften:
- `layout` (Layout) — (Optional) An object defining the initial
layout type of the broadcast. If you do not specify an initial layout type,
the broadcast stream uses the Best Fit layout type. For more information, see
[Configuring
Video Layout for the OpenTok live streaming feature](https://tokbox.com/developer/guides/broadcast/live-streaming/#configuring-live-streaming-video-layout).
- `streamMode` (String) — Whether streams included in the broadcast
are selected automatically (`StreamMode.AUTO`, the default) or manually
(`StreamMode.MANUAL`). When streams are selected automatically
(`StreamMode.AUTO`), all streams in the session can be included in the broadcast.
When streams are selected manually (`StreamMode.MANUAL`), you specify streams
to be included based on calls to the `Broadcast.addStreamToBroadcast()` and
`Broadcast.removeStreamFromBroadcast()` methods. With manual mode, you can specify
whether a stream's audio, video, or both are included in the broadcast. In both automatic and
manual modes, the broadcast composer includes streams based on
[stream
prioritization rules](https://tokbox.com/developer/guides/archive-broadcast-layout/#stream-prioritization-rules).
- `multiBroadcastTag` (String) (Optional) — Set this to support multiple broadcasts for
the same session simultaneously. Set this to a unique string for each simultaneous broadcast of an ongoing session.
Note that the `multiBroadcastTag` value is \*not\* included in the response for the methods to
{https://tokbox.com/developer/rest/#list\_broadcasts list live streaming broadcasts} and
{https://tokbox.com/developer/rest/#get\_info\_broadcast get information about a live streaming broadcast}.
{https://tokbox.com/developer/guides/broadcast/live-streaming#simultaneous-broadcasts See Simultaneous broadcasts}.
- `resolution` — The resolution of the broadcast: either "640x480" (SD landscape, the default), "1280x720" (HD landscape),
"1920x1080" (FHD landscape), "480x640" (SD portrait), "720x1280" (HD portrait), or "1080x1920"
(FHD portrait).
- `maxBitRate` — Max Bitrate allowed for the broadcast composing. Must be between
400000 and 2000000.
- `outputs` (Array) —
Defines the HLS broadcast and RTMP streams. You can provide the following keys:
- `hls` (Array) — available with the following options:
- `'dvr'` (Bool) — Whether to enable
[DVR functionality](https://tokbox.com/developer/guides/broadcast/live-streaming/#dvr)
— rewinding, pausing, and resuming — in players that support it (`true`),
or not (`false`, the default). With DVR enabled, the HLS URL will include
a ?DVR query string appended to the end.
- `'lowLatency'` (Bool) — Whether to enable
[low-latency mode](https://tokbox.com/developer/guides/broadcast/live-streaming/#low-latency)
for the HLS stream. Some HLS players do not support low-latency mode. This feature
is incompatible with DVR mode HLS broadcasts.
- `rtmp` (Array) — An array of arrays defining RTMP streams to broadcast. You
can specify up to five target RTMP streams. Each RTMP stream array has the following keys:
- `id` (String) — The stream ID (optional)
- `serverUrl` (String) — The RTMP server URL
- `streamName` (String) — The stream name, such as
the YouTube Live stream name or the Facebook stream key
Rückgabewerte
Sendung —
Ein Objekt mit Eigenschaften, die die Übertragung definieren.
startCaptions()
Verwenden Sie diese Methode, um Echtzeit-Live-Untertitel für eine OpenTok-Sitzung zu aktivieren.
public startCaptions(string $sessionId, string $token[, string $languageCode = null ][, int $maxDuration = null ][, bool $partialCaptions = null ][, string $statusCallbackUrl = null ]) : array<string|int, mixed>
Die maximal zulässige Dauer beträgt 4 Stunden; danach wird die Audio-Untertitelung beendet, ohne dass dies Auswirkungen auf die laufende OpenTok-Sitzung hat. Ein Ereignis wird an Ihre Callback-URL gesendet, sofern diese beim Start der Untertitelung angegeben wurde.
Jede OpenTok-Sitzung unterstützt nur eine Audio-Untertitelungssitzung.
Weitere Informationen zur Funktion „Live Captions“ finden Sie im Entwicklerhandbuch zu „Live Captions“.
Parameter
$sessionId : string : Die Sitzungs-ID der OpenTok-Sitzung. Das Audiomaterial der Publisher, die in diese Sitzung senden, wird zur Erstellung der Untertitel verwendet.
$token : string : Ein gültiges OpenTok-Token, dessen Rolle auf „Moderator“ gesetzt ist.
$languageCode : string = null : (Optional) Der BCP-47-Code für eine gesprochene Sprache, die bei diesem Aufruf verwendet wird. Der Standardwert ist „en-US“. Die folgenden Sprachcodes werden unterstützt: „en-AU“ (Englisch, Australien), „en-GB“ (Englisch, Großbritannien), „en-US“ (Englisch, USA), „es-US“ (Spanisch, USA), „zh-CN“ (Chinesisch, vereinfacht), „fr-FR“ (Französisch), „fr-CA“ (Französisch, Kanada), „de-DE“ (Deutsch), „hi-IN“ (Hindi, Indien), „it-IT“ (Italienisch), „ja-JP“ (Japanisch), „ko-KR“ (Koreanisch), „pt-BR“ (Portugiesisch, Brasilien), „th-TH“ (Thailändisch).
$maxDuration : int = null : (Optional) Die maximale Dauer der Audio-Untertitelung in Sekunden. Der Standardwert beträgt 14.400 Sekunden (4 Stunden) – dies ist die maximal zulässige Dauer.
$partialCaptions : bool = null : (Optional) Gibt an, ob diese Option aktiviert werden soll, um die Untertitelung zu beschleunigen, wobei dies mit gewissen Ungenauigkeiten einhergeht. Der Standardwert ist „true“.
$statusCallbackUrl : string = null : (Optional) Eine öffentlich zugängliche URL, die vom Kunden verwaltet wird und in der Lage ist, den darzustellenden Inhalt ohne Benutzereingriff zu generieren. Die Mindestlänge der URL beträgt 15 Zeichen, die maximale Länge 2048 Zeichen. Weitere Informationen finden Sie unter Statusaktualisierungen zu Live-Untertiteln.
Rückgabewerte
array<string|int, mixed> —
startRender()
Startet einen Experience Composer-Renderer für eine OpenTok-Sitzung.
public startRender( $sessionId, $token, $url, $maxDuration, $resolution, $properties) : Render
Weitere Informationen finden Sie in der Experience Composer Entwicklerhandbuch.
Parameter
$sessionId : : (Zeichenkette) Die Sitzungs-ID der OpenTok-Sitzung, in die der Stream des Experience Composer eingebunden wird.
$token : : (Zeichenkette) Ein gültiges OpenTok-Token mit der Rolle „Publisher“ und (optional) Verbindungsdaten, die dem Ausgabestream zugeordnet werden sollen.
$url : : (Zeichenkette) Eine öffentlich zugängliche URL, die vom Kunden verwaltet wird und ohne Benutzereingriff den darzustellenden Inhalt generieren kann. Die Mindestlänge der URL beträgt 15 Zeichen, die Höchstlänge 2048 Zeichen.
$maxDuration : : (int) (optional) Die maximal zulässige Laufzeit des Experience Composers in Sekunden. Nach Ablauf dieser Zeit wird er automatisch beendet, sofern er noch läuft. Der Maximalwert beträgt 36000 (10 Stunden), der Minimalwert 60 (1 Minute) und der Standardwert 7200 (2 Stunden). Wenn der Experience Composer endet, wird sein Stream deaktiviert und ein Ereignis an die Callback-URL gesendet, sofern diese im Account-Portal konfiguriert wurde.
$resolution : : (Zeichenkette) (optional) Die Auflösung des Experience Composers, entweder „640x480“ (SD im Querformat), „480x640“ (SD im Hochformat), „1280x720“ (HD im Querformat), „720x1280“ (HD im Hochformat), „1920x1080“ (FHD im Querformat) oder „1080x1920“ (FHD im Hochformat). Standardmäßig beträgt diese Auflösung „1280x720“ (HD im Querformat, die Standardeinstellung).
$properties : : (Array) (optional) Die Anfangskonfiguration der Publisher-Eigenschaften für den zusammengesetzten Ausgabestrom.
- `name` (String) (optional) — Serves as the name of the composed output stream which is published to the session. The name must have a minimum length of 1 and
a maximum length of 200.
Rückgabewerte
Das Render-Objekt, das Eigenschaften enthält, die das Rendering definieren, einschließlich der Render-ID.
stopArchive()
Beendet die Aufzeichnung eines OpenTok-Archivs, das gerade aufgezeichnet wird.
public stopArchive(string $archiveId) : Archive
Die Aufzeichnung von Archiven wird automatisch nach 120 Minuten beendet oder sobald sich alle Teilnehmer aus der archivierten Sitzung abgemeldet haben.
Parameter
$archiveId : string : Die Archiv-ID des Archivs, dessen Aufzeichnung Sie beenden möchten.
Rückgabewerte
Archiv —
Das „Archive“-Objekt, das dem zu stoppenden Archiv entspricht.
stopBroadcast()
Beendet eine Übertragung.
public stopBroadcast(string $broadcastId) : Broadcast
Parameter
$broadcastId : string : Die ID der Übertragung.
Rückgabewerte
Sendung —
stopCaptions()
Verwenden Sie diese Methode, um die Live-Untertitel für eine Sitzung zu deaktivieren.
public stopCaptions(string $captionsId) : mixed
Parameter
$captionsId: Zeichenfolge
Rückgabewerte
gemischt —
stopRender()
Beendet einen laufenden Rendervorgang.
public stopRender( $renderId) : mixed
Parameter
$renderId :
Rückgabewerte
gemischt —
updateBroadcastLayout()
Aktualisiert das Layout der Sendung.
public updateBroadcastLayout(string $broadcastId, Layout $layout) : void
Siehe Konfigurieren des Video-Layouts für OpenTok-Live-Streaming-Übertragungen.
Parameter
$broadcastId : string : Die ID der Übertragung.
$layout : Layout : Ein Objekt, das den Layout-Typ für die Sendung definiert.
Rückgabewerte
void —
updateStream()
Legt die Liste der Layout-Klassen für einen Stream fest.
public updateStream(string $sessionId, string $streamId[, array<string|int, mixed> $properties = array() ]) : mixed
Layout-Klassen werden im Layout für zusammengesetzte Archive und Live-Streaming-Übertragungen verwendet.
Weitere Informationen finden Sie unter Anpassung des Video-Layouts für zusammengestellte Archive und Konfigurieren des Video-Layouts für OpenTok-Live-Streaming-Übertragungen.
Sie können die anfängliche Liste der Layout-Klassen für die von einem Client veröffentlichten Streams festlegen, wenn Sie das Token generieren, das der Client für die Verbindung zur Sitzung verwendet. Weitere Informationen finden Sie unter OpenTok::generateToken() Methode.
Parameter
$sessionId : string : Die Sitzungs-ID der Sitzung, zu der der Stream gehört.
$streamId : string : Die Stream-ID.
$properties : array<string|int, mixed> = array()
: Ein Array, das eine Eigenschaft enthält: $layoutClassList.
Diese Eigenschaft ist ein Array aus Klassennamen (Zeichenketten), die auf den
Stream angewendet werden sollen. Setzen $layoutClassList auf ein leeres Array, um die Liste der Layout-Klassen für
einen Stream zu löschen. Dieser Code legt beispielsweise fest, dass der Stream zwei Klassen verwenden soll:
```
$streamProperties = array(
'$layoutClassList' => array('bottom', 'right')
);
$opentok->updateStream($sessionId, $streamId, $streamProperties);
```
Rückgabewerte
gemischt —
returnLegacyToken()
private returnLegacyToken(string $sessionId[, array<string|int, mixed> $options = [] ]) : string
Parameter
$sessionId : string
$options : Array<Zeichenkette|Ganzzahl, gemischt> = []
Rückgabewerte
Zeichenkette —