OpenTok PHP-SDK-Referenz
Das OpenTok PHP-SDK enthält die folgenden Klassen:
| Klasse | Beschreibung |
|---|---|
| Archiv | Stellt ein Archiv einer OpenTok-Sitzung dar. |
| ArchiveAuthenticationException | Definiert die Ausnahme, die ausgelöst wird, wenn Sie eine ungültige API oder einen ungültigen Schlüssel verwenden und eine Archivierungsmethode aufrufen. |
| ArchiveDomainException | Definiert eine Ausnahme, die ausgelöst wird, wenn ein Aufruf einer Archivierungsmethode zu einer Fehlerantwort des Servers führt. |
| ArchiveException | Die Schnittstelle, die von allen Ausnahmen verwendet wird, die bei Aufrufen der Archivierungs-API auftreten. |
| Archivliste | Eine Klasse für den Zugriff auf ein Array von Archiv-Objekten. |
| Archivmodus | Legt Werte für den Parameter „archiveMode“ der Methode „OpenTok->createSession“ sowie den Rückgabewert für die Methode „Session->getArchiveMode()“ fest. |
| ArchiveUnexpectedValueException | Definiert eine Ausnahme, die ausgelöst wird, wenn ein Aufruf einer Archivierungsmethode aufgrund eines unerwarteten Werts zu einem Fehler führt. |
| AuthenticationException | Definiert die Ausnahme, die ausgelöst wird, wenn eine ungültige API oder ein ungültiges Geheimnis verwendet wird. |
| Sendung | Stellt eine Übertragung einer OpenTok-Sitzung dar. |
| BroadcastAuthenticationException | Definiert die Ausnahme, die ausgelöst wird, wenn Sie eine ungültige API oder einen ungültigen Schlüssel verwenden und eine Broadcast-Methode aufrufen. |
| BroadcastDomainException | Definiert eine Ausnahme, die ausgelöst wird, wenn ein Aufruf einer Broadcast-Methode zu einer Fehlerantwort des Servers führt. |
| BroadcastException | Die Schnittstelle, die von allen Ausnahmen verwendet wird, die durch Aufrufe der Broadcast-API verursacht werden. |
| BroadcastUnexpectedValueException | Definiert eine Ausnahme, die ausgelöst wird, wenn ein Aufruf einer Broadcast-Methode aufgrund eines unerwarteten Werts zu einem Fehler führt. |
| DomainException | Definiert eine Ausnahme, die ausgelöst wird, wenn ein API-Aufruf zu einer Fehlerantwort des Servers führt. |
| Ausnahme | Die Schnittstelle, die von allen Ausnahmen in der OpenTok-PHP-API verwendet wird. |
| ForceDisconnectAuthenticationException | Definiert die Ausnahme, die ausgelöst wird, wenn Sie eine ungültige API oder einen ungültigen Schlüssel verwenden und die Methode zur erzwungenen Trennung aufrufen. |
| ForceDisconnectConnectionException | Definiert eine Ausnahme, die ausgelöst wird, wenn ein Aufruf einer Methode zur erzwungenen Trennung zu einer Fehlerantwort des Servers führt. |
| ForceDisconnectException | Die Schnittstelle, die von allen Ausnahmen verwendet wird, die durch Aufrufe der Signal-API verursacht werden. |
| ForceDisconnectUnexpectedValueException | Definiert eine Ausnahme, die ausgelöst wird, wenn ein Aufruf der Methode „force disconnect“ aufgrund eines unerwarteten Werts zu einem Fehler führt. |
| InvalidArgumentException | Definiert eine Ausnahme, die ausgelöst wird, wenn ein ungültiges Argument an eine Methode übergeben wird. |
| Layout | Definiert das Objekt, das als $layout-Parameter an die Methoden OpenTok->setArchiveLayout() und OpenTok->updateBroadcastLayout() übergeben wird. |
| MediaMode | Legt Werte für den Parameter „mediaMode“ der Methode \OpenTok\OpenTok->createSession() fest. |
| OpenTok | Enthält Methoden zum Erstellen von OpenTok-Sitzungen, zum Generieren von Tokens und zum Arbeiten mit Archiven. |
| Ausgabemodus | Legt Werte für die Option „outputMode“ der Methode \OpenTok\OpenTok->startArchive() sowie für die Eigenschaft „outputMode“ der Klasse „Archive“ fest. |
| Rendering | Stellt eine vom Experience Composer gerenderte Darstellung einer OpenTok-Sitzung dar. |
| Rolle | Definiert Werte für den Parameter „role“ der Methode \OpenTok\OpenTok->generateToken(). |
| Sitzung | Stellt eine OpenTok-Sitzung dar. |
| SignalAuthenticationException | Definiert die Ausnahme, die ausgelöst wird, wenn Sie eine ungültige API oder einen ungültigen Schlüssel verwenden und eine Signal-Methode aufrufen. |
| SignalConnectionException | Definiert eine Ausnahme, die ausgelöst wird, wenn ein Aufruf einer Signal-Methode zu einer Fehlerantwort des Servers führt. |
| SignalException | Die Schnittstelle, die von allen Ausnahmen verwendet wird, die durch Aufrufe der Signal-API verursacht werden. |
| SignalNetworkConnectionException | Definiert eine Ausnahme, die ausgelöst wird, wenn ein Aufruf einer Signal-Methode keine Antwort vom Server zur Folge hat |
| SignalUnexpectedValueException | Definiert eine Ausnahme, die ausgelöst wird, wenn ein Aufruf einer Signal-Methode aufgrund eines unerwarteten Werts zu einem Fehler führt. |
| SipCall | Stellt Daten aus einem SIP-Anruf dar |
| Stream | Stellt einen Stream in einer OpenTok-Sitzung dar. |
| StreamList | Ein Objekt, das von der Methode „OpenTok.listStreams()“ zurückgegeben wird und eine Liste von Streams in einer OpenTok-Sitzung darstellt. |
| StreamMode | Definiert „streamMode“-Werte, die beim Starten eines Archivs oder einer Übertragung verwendet werden können |
| UnexpectedValueException | Definiert eine Ausnahme, die bei einem unerwarteten Wert ausgelöst wird. |