Référence du SDK PHP d'OpenTok
Le SDK PHP d'OpenTok comprend les classes suivantes :
| Classe | Description |
|---|---|
| Archives | Représente l'archive d'une session OpenTok. |
| ArchiveAuthenticationException | Définit l'exception levée lorsque vous utilisez une API ou un secret non valide et que vous appelez une méthode d'archivage. |
| ArchiveDomainException | Définit une exception levée lorsqu'un appel à une méthode d'archivage entraîne une réponse d'erreur de la part du serveur. |
| ArchiveException | L'interface utilisée par toutes les exceptions résultant d'appels à l'API d'archivage. |
| Liste des archives | Classe permettant d'accéder à un tableau d'objets Archive. |
| Mode archive | Définit les valeurs du paramètre `archiveMode` de la méthode `OpenTok->createSession` et la valeur renvoyée par la méthode `Session->getArchiveMode()`. |
| ArchiveUnexpectedValueException | Définit une exception levée lorsqu'un appel à une méthode d'archivage génère une erreur en raison d'une valeur inattendue. |
| Exception d'authentification | Définit l'exception levée lorsque vous utilisez une API ou un secret non valide. |
| Radiodiffusion | Représente la diffusion d'une session OpenTok. |
| BroadcastAuthenticationException | Définit l'exception levée lorsque vous utilisez une API ou un secret non valide et que vous appelez une méthode de diffusion. |
| BroadcastDomainException | Définit une exception levée lorsqu'un appel à une méthode de diffusion entraîne une réponse d'erreur de la part du serveur. |
| BroadcastException | L'interface utilisée par toutes les exceptions résultant d'appels à l'API de diffusion. |
| BroadcastUnexpectedValueException | Définit une exception levée lorsqu'un appel à une méthode de diffusion génère une erreur en raison d'une valeur inattendue. |
| DomainException | Définit une exception levée lorsqu'un appel d'API génère une réponse d'erreur de la part du serveur. |
| Exception | L'interface utilisée par toutes les exceptions de l'API PHP d'OpenTok. |
| ForceDisconnectAuthenticationException | Définit l'exception levée lorsque vous utilisez une API ou un secret non valide et que vous appelez la méthode de déconnexion forcée. |
| ForceDisconnectConnectionException | Définit une exception levée lorsqu'un appel à une méthode de déconnexion forcée entraîne une réponse d'erreur de la part du serveur. |
| ForceDisconnectException | L'interface utilisée par toutes les exceptions résultant d'appels à l'API des signaux. |
| ForceDisconnectUnexpectedValueException | Définit une exception levée lorsqu'un appel à la méthode « force disconnect » génère une erreur en raison d'une valeur inattendue. |
| InvalidArgumentException | Définit une exception levée lorsqu'un argument non valide est transmis à une méthode. |
| Mise en page | Définit l'objet transmis en tant que paramètre $layout des méthodes OpenTok->setArchiveLayout() et OpenTok->updateBroadcastLayout(). |
| MediaMode | Définit les valeurs du paramètre « mediaMode » de la méthode \OpenTok\OpenTok->createSession(). |
| OpenTok | Contient des méthodes permettant de créer des sessions OpenTok, de générer des jetons et de gérer les archives. |
| Mode de sortie | Définit les valeurs de l'option `outputMode` de la méthode `\OpenTok\OpenTok->startArchive()` et de la propriété `outputMode` de la classe `Archive`. |
| Rendu | Représente un rendu créé par Experience Composer d'une session OpenTok. |
| Rôle | Définit les valeurs du paramètre « role » de la méthode \OpenTok\OpenTok->generateToken(). |
| Session | Représente une session OpenTok. |
| SignalAuthenticationException | Définit l'exception levée lorsque vous utilisez une API ou un secret non valide et que vous appelez une méthode de signal. |
| SignalConnectionException | Définit une exception levée lorsqu'un appel à une méthode de signalisation entraîne une réponse d'erreur de la part du serveur. |
| SignalException | L'interface utilisée par toutes les exceptions résultant d'appels à l'API des signaux. |
| SignalNetworkConnectionException | Définit une exception levée lorsqu'un appel à une méthode de signal ne reçoit aucune réponse du serveur. |
| SignalUnexpectedValueException | Définit une exception levée lorsqu'un appel à une méthode de signalisation entraîne une erreur due à une valeur inattendue. |
| SipCall | Représente les données d'un appel SIP |
| Flux | Représente un flux dans une session OpenTok. |
| Liste des flux | Objet renvoyé par la méthode OpenTok.listStreams(), représentant une liste de flux dans une session OpenTok. |
| StreamMode | Définit les valeurs de `streamMode` pouvant être utilisées lors du lancement d'une archive ou d'une diffusion |
| Exception de valeur inattendue | Définit une exception levée lorsqu'une valeur inattendue est détectée. |