Objet représentant une diffusion en direct via OpenTok.

Ne pas appeler le new() constructor. Pour lancer une diffusion en direct, appelez la méthode OpenTok.startBroadcast() méthode.

Caractéristiques :
Nom Type Description
id Chaîne L'identifiant de diffusion.
sessionId Chaîne L'identifiant de la session OpenTok associée à cette diffusion.
projectId Chaîne La clé API associée à la diffusion.
createdAt Numbers L'instant auquel la diffusion a été créée, en millisecondes depuis l'époque UNIX.
resolution Chaîne La résolution de la diffusion : l'une des suivantes : - « 640x480 » - « 1280x720 » - « 1920x1080 » - « 480x640 » - « 720x1280 » - « 1080x1920 » 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.
broadcastUrls Objet Objet contenant des informations sur les diffusions HLS et RTMP. - hls (Chaîne) — Si vous avez spécifié un point de terminaison HLS, l'objet comprend une propriété « hls », qui est définie sur l'URL de la diffusion HLS. Notez que cette URL de diffusion HLS pointe vers un fichier d’index, une liste de lecture au format .M3U8 contenant une liste d’URL vers des fichiers de segments multimédias .ts (fichiers de flux de transport MPEG-2). Bien que les URL du fichier d’index de la liste de lecture et des fichiers de segments multimédia soient fournies dès que la réponse HTTP est renvoyée, il ne faut pas accéder à ces URL avant 15 à 20 secondes, après le démarrage de la diffusion HLS, en raison du décalage entre la diffusion HLS et les flux en direct de la session OpenTok. Voir https://developer.apple.com/library/ios/technotes/tn2288/\\_index.html Pour plus d'informations sur le fichier d'index de la liste de lecture et les fichiers de segments multimédias pour HLS. - hlsStatus (chaîne de caractères) — Les états possibles pour le champ « hlsStatus » sont les suivants : - « connecting » : le serveur OpenTok est en train de démarrer les transcodeurs. Il s’agit de l’état initial - « ready » : le serveur OpenTok s’est initialisé avec succès, mais le CDN ne consomme pas de contenu multimédia - «live » : le serveur OpenTok s’est initialisé avec succès et le CDN consomme du contenu multimédia - « ended » : le flux source s’est terminé (si le DVR est activé et qu’un contenu préenregistré est demandé, l’état passe alors à « live ») - « error » : une erreur s’est produite sur la plateforme OpenTok. - rtmp (Tableau d'objets) — Si vous avez spécifié des points de terminaison de flux RTMP, l'objet comprend une propriété « rtmp ». Il s'agit d'un tableau d'objets contenant des informations sur chacun des flux RTMP. Chacun de ces objets possède les propriétés suivantes : - id L'identifiant que vous avez attribué au flux RTMP - serverUrl L'URL du serveur - streamName Le nom du flux - status L'état du flux
maxDuration Numbers Durée maximale autorisée pour la diffusion, en secondes. Passé ce délai, la diffusion s'arrêtera automatiquement si elle est toujours en cours.
streamMode Chaîne Mode de diffusion pour la diffusion. Il peut être défini sur l'une des valeurs suivantes : - « auto » — Les flux inclus dans la diffusion sont sélectionnés automatiquement (valeur par défaut). - « manual » — Spécifiez les flux à inclure en fonction des appels à la fonction OpenTok.addBroadcastStream() et OpenTok.removeBroadcastStream() des méthodes.
streams Tableau Tableau d'objets correspondant aux flux actuellement diffusés. Il n'est défini que pour une diffusion dont le statut est « started » et dont le paramètre `streamMode` est défini sur « manual ». Chaque objet du tableau comprend les propriétés suivantes : - streamId -- L'identifiant du flux inclus dans la diffusion. - hasAudio -- Si le son du flux est inclus dans la diffusion. - hasVideo -- Si la vidéo du flux est incluse dans la diffusion.
multiBroadcastTag Chaîne Définissez ce paramètre pour prendre en charge plusieurs diffusions simultanées d'une même session. Attribuez une chaîne de caractères unique à chaque diffusion simultanée d'une session en cours. Notez que le multiBroadcastTag Cette valeur n'est pas incluse dans la réponse pour les méthodes permettant de répertorier les diffusions en direct et d'obtenir des informations sur une diffusion en direct.

Méthodes

Nom Description
stop(callback) Interrompt la diffusion en direct.

stop(callback)

Interrompt la diffusion en direct.

Les diffusions cessent automatiquement d'être enregistrées au bout de 120 minutes ou lorsque tous les clients se sont déconnectés de la session en cours de diffusion.

Paramètres :
Nom Type Description
callback fonction La fonction à appeler une fois l'opération terminée. Deux arguments sont transmis à cette fonction : - error — Un objet d'erreur (si l'appel à la méthode échoue). - broadcast — L'objet « Broadcast ».