Hérite de : : Object

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

Vue d'ensemble

Correspond à une diffusion en direct d'une session OpenTok. Voir / Diffusions en direct.

Résumé des attributs d'instance

Résumé des méthodes d'instance

Gestion dynamique des méthodes

Cette classe gère les méthodes dynamiques via la méthode `method_missing`

#méthode_manquante(méthode, *args, &block) ⇒ Objet

Détails des attributs d'instance

#URL de diffusion ⇒ Hachage

est défini comme suit : cet objet définit les types de flux de diffusion que vous souhaitez lancer (HLS et RTMP). Vous pouvez inclure des flux HLS, RTMP ou les deux. Si vous incluez la diffusion RTMP, vous pouvez spécifier jusqu’à cinq flux RTMP cibles (ou un seul). Le (:hls) est définie sur un objet [Hash] vide. L'URL HLS est renvoyée dans la réponse. La propriété « hlsStatus » prend l'une des valeurs suivantes :

- "connecting" — The OpenTok server is in the process of starting transcoders. This is the initial state.
- "ready" — The OpenTok server has succesfully initialized but the CDN is not consuming media.
- "live" — The OpenTok server has succesfully initialized and the CDN is consuming media.
- "ended" — The source stream has ended. If DVR is enabled and pre-recorded media is requested, then the status will transition to "live".
- "error" — There is an error in the OpenTok platform.

Le (:rtmp) est définie sur un [Tableau] de propriétés Rtmp [Hash]. Pour chaque flux RTMP, spécifiez (:serverUrl) pour l'URL du serveur RTMP, (:streamName) telles que le nom du flux YouTube Live ou la clé du flux Facebook), et (facultativement) (:id), un identifiant unique pour le flux.

Retours :

  • (Hash) —

    la valeur actuelle de broadcastUrls

#created_at ⇒ int

L'instant auquel la diffusion a été créée, en millisecondes depuis l'époque UNIX.

Retours :

  • (int) —

    la valeur actuelle de « created_at »

#hasAudio ⇒ booléen

Le son est activé pour cette diffusion

Retours :

  • (booléen) —

    la valeur actuelle de hasAudio

#hasVideo ⇒ booléen

La diffusion prend en charge la vidéo

Retours :

  • (booléen) —

    la valeur actuelle de hasVideo

#id ⇒ chaîne de caractères

L'identifiant de diffusion.

Retours :

  • (chaîne de caractères) —

    la valeur actuelle de l'identifiant

#maxBitRate ⇒ int

Le débit binaire maximal du ou des flux de diffusion, en bits par seconde.

Retours :

  • (int) —

    la valeur actuelle de maxBitRate

#multi_broadcast_tag ⇒ Objet (en lecture seule)

Renvoie la valeur de l'attribut « multi_broadcast_tag ».

#project_id ⇒ chaîne de caractères

La clé API associée à la diffusion.

Retours :

  • (chaîne de caractères) —

    la valeur actuelle de project_id

#résolution ⇒ chaîne de caractères

La résolution de la diffusion : soit « 640x480 » (SD en mode paysage, par défaut), « 1280x720 » (HD en mode paysage), « 1920x1080 » (FHD paysage), « 480x640 » (SD portrait), « 720x1280 » (HD portrait) ou « 1080x1920 » (FHD portrait). Vous pouvez choisir d’utiliser un format portrait pour les diffusions incluant des flux vidéo provenant d’appareils mobiles (qui utilisent souvent le format portrait). Cette propriété est facultative.

Retours :

  • (chaîne de caractères) —

    la valeur actuelle de la résolution

#session_id ⇒ chaîne de caractères

L'identifiant de la session OpenTok associée à cette diffusion.

Retours :

  • (chaîne de caractères) —

    la valeur actuelle de session_id

#statut ⇒ chaîne de caractères

L'état du flux RTMP.

  • « Connexion » – La plateforme OpenTok est en train de se connecter au serveur RTMP distant.

    This is the initial state, and it is the status if you start when there are no streams published in the session.
It changes to "live" when there are streams (or it changes to one of the other states).

  • « En direct – La plateforme OpenTok s'est connectée avec succès au serveur RTMP distant, et le flux multimédia est en cours de diffusion. »

  • « hors ligne » – La plateforme OpenTok n'a pas pu se connecter au serveur RTMP distant. Cela est dû à un serveur inaccessible ou à une erreur lors de la négociation RTMP. Les causes peuvent être notamment des connexions RTMP refusées, des Applications RTMP inexistantes, des noms de flux refusés, des erreurs d'authentification, etc. Vérifiez que le serveur est en ligne et que vous avez indiqué l'URL du serveur et le nom du flux corrects.

  • « erreur » – Une erreur s'est produite sur la plateforme OpenTok.

Retours :

  • (chaîne de caractères) —

    la valeur actuelle du statut

#streamMode ⇒ chaîne de caractères

Si les flux inclus dans la diffusion sont sélectionnés automatiquement (« auto », par défaut) ou manuellement (« manuel »).

Retours :

  • (chaîne de caractères) —

    la valeur actuelle de streamMode

#date_de_mise_à_jour ⇒ int

Pour cette méthode de démarrage, cet horodatage correspond à l'horodatage « createdAt ».

Retours :

  • (int) —

    la valeur actuelle de « updated_at »

Détails de la méthode d'instance

#add_stream(stream_id, opts = {}) ⇒ Objet

Ajoute un flux à la diffusion en cours, qui a été lancée avec le paramètre `streamMode` défini sur « manual ». Pour plus d'informations sur cette fonctionnalité, consultez <https://tokbox.com/developer/rest/#selecting-broadcast-streams>.

Vous pouvez appeler cette méthode à plusieurs reprises en passant le même identifiant de flux à `add_stream`, afin d'activer ou de désactiver le son ou la vidéo du flux dans la diffusion. Si vous définissez à la fois `has_audio` et `has_video` sur `false`, vous obtiendrez une réponse d'erreur.

Paramètres :

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

    L'identifiant du flux à ajouter à la diffusion

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

    un ensemble d'options personnalisables

Table de hachage des options (opts) :

  • :has_audio (true, false)

    — par défaut : Booléen, facultatif —

    — Indique si la diffusion doit inclure le son du flux (true, valeur par défaut) ou non (false).

  • :has_video (vrai, faux)

    — par défaut : Booléen, facultatif —

    — Indique si la diffusion doit inclure la vidéo du flux (true, valeur par défaut) ou non (false).

Augmentations :

  • (OpenTokBroadcastError) —

    Le paramètre « streamMode » de la diffusion n'est pas défini sur « manual ».

#mise en page(opts = {}) ⇒ Objet

Définit la mise en page de la diffusion OpenTok.

Vous pouvez modifier de manière dynamique le type de mise en page d'une diffusion pendant celle-ci. Pour plus d'informations, consultez Configuration de la disposition vidéo pour les diffusions en direct OpenTok.

Voir <https://tokbox.com/developer/rest/#change_composed_archive_layout>

Paramètres :

  • options (Hash) —

    un ensemble d'options personnalisables

Augmentations :

  • (OpenTokBroadcastError) —

    La mise en page de l'émission n'a pas pu être mise à jour.

  • (OpenTokAuthenticationError) —

    Échec de l'authentification. Clé API ou secret non valide.

  • (OpenTokError) —

    Erreur du serveur OpenTok.

  • (ArgumentError) —

    Le paramètre « broadcast_id » ou « options » est vide.

  • (ArgumentError) —

    Le type « custom » a été spécifié sans option de feuille de style.

  • (ArgumentError) —

    Une feuille de style a été transmise pour un type autre que « custom ». Ou bien un type non valide a été transmis.

  • (ArgumentError) —

    Un type de mise en page non valide a été transmis.

#remove_stream(stream_id) ⇒ Objet

Supprime un flux de la diffusion en cours qui a été lancée avec le paramètre `streamMode` défini sur « manual ». Pour plus d'informations sur cette fonctionnalité, consultez <https://tokbox.com/developer/rest/#selecting-broadcast-streams>.

Paramètres :

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

    L'identifiant du flux à supprimer de la diffusion

Augmentations :

  • (OpenTokBroadcastError) —

    Le paramètre « streamMode » de la diffusion n'est pas défini sur « manual ».

#arrêter ⇒ Objet

Arrête la diffusion OpenTok.

#to_json ⇒ Objet

Une représentation sous forme de chaîne de caractères, encodée au format JSON, de la diffusion.