Documentation de référence du SDK Ruby d'OpenTok
Le SDK Ruby d'OpenTok comprend les classes suivantes :
| Classe | Description |
|---|---|
| OpenTok :: Archives | Représente l'archive d'une session OpenTok. |
| OpenTok::ArchiveList | Classe permettant d'accéder à un tableau d'objets Archive. |
| OpenTok :: Archives | Une classe permettant de manipuler les archives OpenTok. |
| OpenTok::Broadcast | Correspond à une diffusion en direct d'une session OpenTok. Voir / Diffusions en direct. |
| OpenTok::BroadcastList | Classe permettant d'accéder à un tableau d'objets Broadcast. |
| OpenTok :: Diffusions | Classe permettant de gérer les diffusions en direct OpenTok. Voir / Diffusions en direct. |
| OpenTok::Sous-titres | Une classe permettant de gérer les sous-titres OpenTok. |
| OpenTok::Connexions | Une classe permettant de gérer les connexions OpenTok. |
| OpenTok::OpenTok | Contient des méthodes permettant de créer des sessions OpenTok et de générer des jetons. Il comprend également des méthodes permettant de renvoyer des objets qui vous permettent de gérer des archives, de gérer des diffusions en direct, d'utiliser l'interconnexion SIP, d'envoyer des signaux aux sessions, de déconnecter des clients des sessions et de définir la mise en page c |
| OpenTok::OpenTokArchiveError | Définit les erreurs générées par les méthodes liées à l'archivage du SDK Ruby d'OpenTok. |
| OpenTok::OpenTokAuthenticationError | Définit les erreurs générées lorsque vous tentez d'effectuer une opération à l'aide d'une clé ou d'un secret API OpenTok non valide. |
| OpenTok::OpenTokBroadcastError | Définit les erreurs générées lors de l'exécution d'opérations de diffusion. |
| OpenTok::OpenTokCaptionsError | Définit les erreurs générées lors de l'exécution d'opérations liées aux légendes. |
| OpenTok::OpenTokConnectionError | Définit les erreurs générées lorsque vous tentez de déconnecter de force un client alors que celui-ci n'est pas connecté à la session. |
| OpenTok::OpenTokError | Définit les erreurs générées par les méthodes du SDK Ruby d'OpenTok. |
| OpenTok::OpenTokRenderError | Définit les erreurs générées lors de l'exécution d'opérations de rendu dans Experience Composer. |
| OpenTok::OpenTokSipError | Définit les erreurs générées par les méthodes SIP du SDK Ruby d'OpenTok. |
| OpenTok::OpenTokStreamLayoutError | Définit les erreurs générées lorsque vous tentez d'attribuer des classes de mise en page à un flux. |
| OpenTok::OpenTokWebSocketError | Définit les erreurs générées lors de la connexion à des URI WebSocket. |
| OpenTok::Render | Représente un rendu Experience Composer d'une session OpenTok. Voir / Experience Composer. |
| OpenTok::RenderList | Classe permettant d'accéder à un tableau d'objets « Experience Composer Render ». |
| OpenTok::Renders | Classe permettant de manipuler les rendus d'OpenTok Experience Composer. Voir / Experience Composer. |
| OpenTok::Session | Représente une session OpenTok. |
| OpenTok::Signals | Une classe permettant de manipuler les signaux OpenTok. |
| OpenTok::Sip | Contacte une passerelle SIP pour intégrer un flux audio uniquement à votre session OpenTok. |
| OpenTok::Stream | Un tableau contenant les classes de mise en page du flux. |
| OpenTok::StreamList | Une classe permettant d'accéder à une liste d'objets Stream. |
| OpenTok::Streams | Classe permettant de gérer les flux OpenTok. Elle comprend des méthodes permettant d'obtenir des informations sur les flux OpenTok, de définir des classes de mise en page pour ces flux et de couper le son de ces derniers. |
| OpenTok::TokenGenerator | Modules : ClassMethods |
| OpenTok::WebSocket | Établit une connexion WebSocket via Audio Connector afin d'envoyer le flux audio d'une session de la Video API Vonage vers une URI WebSocket. |