Hérite de : : Object

Défini dans : : lib/opentok/streams.rb

Vue d'ensemble

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.

Résumé des méthodes d'instance

Détails de la méthode d'instance

#tous(session_id) ⇒ Liste des flux

Utilisez cette méthode pour obtenir des informations sur tous les flux OpenTok d'une session.

Par exemple, vous pouvez appeler cette méthode pour obtenir des informations sur les classes de mise en page utilisées par les flux OpenTok. Les classes de mise en page définissent la manière dont le flux s'affiche dans la mise en page d'une diffusion en direct ou d'une archive montée. Pour plus d'informations, consultez Attribution de classes de mise en page aux flux dans les diffusions en direct et Personnalisation de la présentation vidéo pour les archives composées.

Paramètres :

  • session_id (Chaîne de caractères) —

    L'identifiant de la session OpenTok.

Retours :

Augmentations :

  • (ArgumentError) —

    L'identifiant « stream_id » ou « session_id » n'est pas valide.

  • (OpenTokAuthenticationError) —

    Vous n'êtes pas autorisé(e) à récupérer les informations relatives au flux. Vérifiez vos identifiants d'authentification.

  • (OpenTokError) —

    Une erreur du serveur OpenTok.

#désactiver_la_sourdine_forcée(session_id) ⇒ Objet

Désactive l'état de sourdine actif de la session. Une fois cette méthode appelée, les nouveaux flux publiés sur la session ne seront plus en sourdine.

Une fois que vous avez appelé la méthode `force_mute_all()`, tous les flux publiés après cet appel le sont avec le son coupé. Appelez la méthode `disable_force_mute()` pour désactiver la mise en sourdine d'une session, afin que les nouveaux flux publiés ne soient pas automatiquement mis en sourdine.

Paramètres :

  • session_id (Chaîne de caractères) —

    L'identifiant de session.

#trouver(session_id, stream_id) ⇒ Flux

Utilisez cette méthode pour obtenir des informations sur un flux OpenTok.

Par exemple, vous pouvez appeler cette méthode pour obtenir des informations sur les classes de mise en page utilisées par un flux OpenTok. Les classes de mise en page définissent la manière dont le flux s'affiche dans la mise en page d'un flux de diffusion. Pour plus d'informations, consultez Attribution de classes de mise en page aux flux dans les diffusions en direct et Personnalisation de la présentation vidéo pour les archives composées.

Paramètres :

  • session_id (Chaîne de caractères) —

    L'identifiant de la session OpenTok.

  • stream_id (Chaîne de caractères) —

    L'identifiant du flux au sein de la session.

Retours :

  • (Flux) —

    L'objet Stream.

Augmentations :

  • (ArgumentError) —

    L'identifiant « stream_id » ou « session_id » n'est pas valide.

  • (OpenTokAuthenticationError) —

    Vous n'êtes pas autorisé(e) à récupérer les informations relatives au flux. Vérifiez vos identifiants d'authentification.

  • (OpenTokError) —

    Une erreur du serveur OpenTok.

#force_mute(session_id, stream_id) ⇒ Objet

Forcer la mise en sourdine d'un flux spécifique associé à une session OpenTok.

Paramètres :

  • session_id (Chaîne de caractères) —

    L'identifiant de la session OpenTok.

  • stream_id (Chaîne de caractères) —

    L'identifiant du flux de la session.

#force_mute_all(session_id, opts = {}) ⇒ Objet

Forcer tous les flux connectés à une session OpenTok (à l'exception d'une liste facultative de flux) à couper le son publié.

Outre les flux existants, tous les flux publiés après l'appel de cette méthode sont publiés avec le son coupé. Vous pouvez désactiver la mise en sourdine d'une session en appelant la méthode `disable_force_mute()`.

Il s'agit d'une propriété facultative. Si vous omettez cette propriété, tous les flux de la session seront mis en sourdine.

Paramètres :

  • session_id (Chaîne de caractères) —

    L'identifiant de session.

  • opts (Table de hachage) (valeur par défaut : {}) —

    Un hachage facultatif définissant les options relatives à l'action de mise en sourdine. Par exemple :

    "excluded_streams" => [
  "excludedStreamId1",
  "excludedStreamId2"
]

Table de hachage des options (opts) :

  • :excluded_streams (Tableau)

    -

    Les identifiants des flux qui ne doivent pas être mis en sourdine.

#mise en page(session_id, opts) ⇒ Objet

Utilisez cette méthode pour définir la mise en page d'un flux OpenTok composé (d'archive ou de diffusion).

Par exemple, vous pouvez appeler cette méthode pour définir les classes de mise en page d'un flux OpenTok. Les classes de mise en page définissent la manière dont le flux s'affiche dans la mise en page d'une diffusion en direct ou d'une archive montée. Pour plus d'informations, consultez Attribution de classes de mise en page aux flux dans les diffusions en direct et Personnalisation de la présentation vidéo pour les archives composées.

Pour plus d'informations, consultez la section « Mise en page »<https://tokbox.com/developer/rest/#change-stream-layout-classes-composed>

Paramètres :

  • session_id (Chaîne de caractères) —

    L'identifiant de la session OpenTok.

  • opts (Hash) —

    Un hachage à une clé items et une valeur sous la forme d'un tableau d'objets contenant stream_id et layoutClassList propriétés.

Augmentations :

  • (ArgumentError) —

    L'identifiant de session (session_id) n'est pas valide.

  • (OpenTokAuthenticationError) —

    Vous n'êtes pas autorisé(e) à récupérer les informations relatives au flux. Vérifiez vos identifiants d'authentification.

  • (OpenTokStreamLayoutError) —

    L'opération de mise en page n'a pas pu être effectuée en raison de valeurs de mise en page incorrectes.

  • (OpenTokError) —

    Une erreur du serveur OpenTok.