Radiodiffusion

Représente la diffusion d'une session OpenTok.

Table des matières

$broadcastUrls  : objet

$createdAt  : int

$id  : chaîne de caractères

$isDvr  : bool

$isHls  : bool

$isLowLatency  : bool

$isStopped  : bool

$maxBitRate  : chaîne de caractères

$multiBroadcastTag  : chaîne de caractères

$partnerId  : chaîne de caractères

$résolution  : chaîne de caractères

$sessionId  : chaîne de caractères

$status  : chaîne de caractères

$streamMode  : chaîne de caractères

$updatedAt  : int

__construct()  : mitigé

addStreamToBroadcast()  : bool : Ajoute un flux à une diffusion en cours qui a été lancée avec le paramètre streamMode défini sur StreamMode.Manual. Vous pouvez appeler cette méthode à plusieurs reprises avec le même identifiant de flux afin d'activer ou de désactiver l'audio ou la vidéo du flux dans la diffusion.

jsonSerialize()  : mitigé

removeStreamFromBroadcast()  : bool : Supprime un flux d'une diffusion en cours qui a été lancée avec le paramètre streamMode défini sur StreamMode.Manual.

stop()  : mixte : Arrête la diffusion.

updateLayout()  : mixte : Met à jour la mise en page de l'émission.

Propriétés

$broadcastUrls

public object $broadcastUrls

Informations détaillées sur les flux de diffusion HLS et RTMP. Pour un flux HLS, l'URL est indiquée. Consultez la Guide du développeur pour la diffusion en direct avec OpenTok Pour plus d'informations sur l'utilisation de cette URL. Pour chaque flux RTMP, l'URL du serveur RTMP et le nom du flux sont indiqués, ainsi que l'état du flux RTMP.

$createdAt

public int $createdAt

L'horodatage correspondant à la création de la diffusion, exprimé en secondes depuis l'époque Unix.

$id

public string $id

L'identifiant unique de la diffusion.

$isDvr

public bool $isDvr

Si la diffusion prend en charge la fonctionnalité d'enregistrement numérique (DVR) pour le flux HLS.

$isHls

public bool $isHls

Si la diffusion prend en charge le protocole HLS.

$isLowLatency

public bool $isLowLatency

Si la diffusion prend en charge le mode à faible latence pour le flux HLS.

$isStopped

public bool $isStopped

Indique si la diffusion est interrompue (vrai) ou en cours (faux).

$maxBitRate

public string $maxBitRate

Débit binaire maximal autorisé pour la composition de la diffusion. Doit être compris entre 400 000 et 2 000 000.

$multiBroadcastTag

public string $multiBroadcastTag

Si la fonction « Diffusion multiple » est activée, une chaîne de caractères unique sera attribuée à chaque diffusion simultanée d'une session en cours. Voir https://tokbox.com/developer/guides/archiving/#simultaneous-archives pour plus d'informations.

$partnerId

public string $partnerId

Votre clé API OpenTok.

$résolution

public string $resolution

La résolution de l'archive peut être « 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 opter pour un format portrait pour les archives contenant des flux vidéo provenant d'appareils mobiles (qui utilisent souvent le format portrait).

$sessionId

public string $sessionId

L'identifiant de session OpenTok.

$status

public string $status

État de diffusion. Soit started ou stopped

$streamMode

public string $streamMode

Que les flux inclus dans la diffusion soient sélectionnés automatiquement (StreamMode.AUTO) ou manuellement (StreamMode.MANUAL). Lorsque les flux sont sélectionnés automatiquement (StreamMode.AUTO), tous les flux de la session peuvent être intégrés à la diffusion. Lorsque les flux sont sélectionnés manuellement (StreamMode.MANUAL), vous spécifiez les flux à inclure en fonction des appels à la fonction Broadcast.addStreamToBroadcast() et Broadcast.removeStreamFromBroadcast() méthodes. En mode manuel, vous pouvez préciser si le flux audio, le flux vidéo ou les deux sont inclus dans la diffusion. En mode automatique comme en mode manuel, l'éditeur de diffusion inclut les flux en fonction de flux règles de priorisation.

$updatedAt

public int $updatedAt

L'heure à laquelle la diffusion a commencé ou s'est arrêtée, exprimée en secondes depuis l'époque Unix.

Méthodes

__construct()

public __construct(mixed $broadcastData[, mixed $options = array() ]) : mixed

Paramètres

$broadcastData : mixed

$options : mixed = array()

Valeurs de retour

mixte —

addStreamToBroadcast()

Ajoute un flux à une diffusion en cours qui a été lancée avec le paramètre streamMode défini sur StreamMode.Manual. Vous pouvez appeler cette méthode à plusieurs reprises avec le même identifiant de flux afin d'activer ou de désactiver l'audio ou la vidéo du flux dans la diffusion.

public addStreamToBroadcast(string $streamId, bool $hasAudio, bool $hasVideo) : bool

Paramètres

$streamId : chaîne de caractères : L'identifiant du flux.

$hasAudio : bool : Indique si la diffusion doit inclure l'audio du flux (true, valeur par défaut) ou non (false).

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

Valeurs de retour

bool —

Renvoie « true » en cas de réussite.

jsonSerialize()

public jsonSerialize() : mixed

Valeurs de retour

mixte —

removeStreamFromBroadcast()

Supprime un flux d'une diffusion en cours qui a été lancée avec le paramètre streamMode défini sur StreamMode.Manual.

public removeStreamFromBroadcast(string $streamId) : bool

Paramètres

$streamId : chaîne de caractères : L'identifiant du flux.

Valeurs de retour

bool —

Renvoie « true » en cas de réussite.

stop()

Arrête la diffusion.

public stop() : mixed

Valeurs de retour

mixte —

updateLayout()

Met à jour la mise en page de l'émission.

public updateLayout(Layout $layout) : mixed

Voir Configuration de la disposition vidéo pour les diffusions en direct via OpenTok.

Paramètres

$layout : Mise en page : Un objet définissant le type de mise en page de la diffusion.

Valeurs de retour

mixte —