Classe: PlayerManager

Méthodes

addEventListener

addEventListener(eventType, eventListener)

Ajoute un écouteur d'événements qui écoute les événements de lecture.

Paramètre

eventType

(cast.framework.events.EventType non nul ou tableau non nul de cast.framework.events.EventType non nul)

Type d'événement ou tableau de types d'événements

eventListener

function(non-null cast.framework.events.Event)

Génère

non-null Error Si les arguments fournis ne sont pas valides.

addSupportedMediaCommands

addSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

Ajoute de nouvelles commandes compatibles à la liste existante des commandes multimédias compatibles.

Paramètre

supportedMediaCommands

Total

Masque de bits des commandes multimédias acceptées par l'application.

broadcastStatus

Facultatif

booléen

true indique que les expéditeurs doivent être informés du changement (s'il n'est pas fourni, les expéditeurs ne seront pas informés).

Voir aussi
cast.framework.messages.Command

broadcastStatus

broadcastStatus(includeMedia, requestId, customData, includeQueueItems)

Envoie un message d'état du contenu multimédia à tous les émetteurs (diffusion). Les applications l'utilisent pour envoyer un changement d'état personnalisé.

Paramètre

includeMedia

Facultatif

booléen

true indique que le message doit inclure des informations sur le contenu multimédia.

requestId

Facultatif

Total

ID de la requête entrante qui a déclenché cette réponse.

customData

Facultatif

Objet

Données personnalisées spécifiques à l'application du message d'état.

La valeur peut être nulle.

includeQueueItems

Facultatif

booléen

Indique si les éléments de la file d'attente doivent être inclus dans le message d'état. Par défaut, ils ne sont pas inclus.

getAbsoluteTimeForMediaTime

getAbsoluteTimeForMediaTime(mediaTime) renvoie number

Convertit le temps média en temps absolu média. Le temps absolu ne s'applique qu'aux diffusions en direct.

Paramètre

mediaTime

Total

Heure du contenu multimédia.

Renvoie

nullable number Heure absolue ou null si elle n'est pas disponible.

getAudioTracksManager

getAudioTracksManager() renvoie cast.framework.AudioTracksManager

Obtient l'instance AudioTracksManager.

Renvoie

non-null cast.framework.AudioTracksManager 

getBreakClipCurrentTimeSec

getBreakClipCurrentTimeSec() renvoie un nombre

Renvoie la durée actuelle de l'extrait de coupure en cours de lecture, en secondes.

Renvoie

nullable number Heure actuelle en secondes dans le clip de la coupure en cours. null lorsque Player ne lit pas de clip de pause.

getBreakClipDurationSec

getBreakClipDurationSec() renvoie number

Renvoie la durée du clip de coupure en cours de lecture, en secondes.

Renvoie

nullable number Durée de l'extrait de la coupure actuelle. null lorsque Player ne lit pas de clip de pause.

getBreakManager

getBreakManager() renvoie cast.framework.breaks.BreakManager

Obtient l'instance BreakManager.

Renvoie

non-null cast.framework.breaks.BreakManager 

getBreaks

getBreaks() returns Array of non-null cast.framework.messages.Break

Renvoie une liste de pauses.

Renvoie

non-null Array of non-null cast.framework.messages.Break 

getCurrentSupportedMediaCommands

getCurrentSupportedMediaCommands() renvoie un nombre

Obtient les commandes multimédias compatibles avec le récepteur actuel. Contrairement à getSupportedMediaCommands(), la valeur renvoyée par cette méthode change de manière dynamique en fonction de l'état de lecture actuel. Par exemple, il est possible que la commande SEEK ne soit pas compatible pendant la lecture d'annonces. Cette méthode ne doit être appelée qu'après l'appel du récepteur CastReceiverContext#start, sinon elle renverra 0.

Voir aussi
cast.framework.messages.Command
Renvoie

number Masque de bits des commandes multimédias acceptées par l'application.

getCurrentTimeSec

getCurrentTimeSec() renvoie un nombre

Récupère la durée de lecture écoulée du contenu multimédia actuel.

Renvoie

number Temps écoulé, en secondes. Cette valeur sera 0 si aucun contenu multimédia n'est en cours de lecture.

getDurationSec

getDurationSec() renvoie un nombre

Récupère la durée du contenu multimédia en cours de lecture, en secondes.

Renvoie

number Durée du contenu multimédia. NaN si aucun contenu multimédia n'est en cours de lecture.

getLiveSeekableRange

getLiveSeekableRange() renvoie cast.framework.messages.LiveSeekableRange

Renvoie la plage de recherche en direct avec les heures de début et de fin en secondes. Les valeurs sont basées sur la durée média.

Renvoie

nullable cast.framework.messages.LiveSeekableRange 

getMediaInformation

getMediaInformation() renvoie cast.framework.messages.MediaInformation

Obtient les informations multimédias du contenu multimédia actuel.

Renvoie

nullable cast.framework.messages.MediaInformation 

getMediaTimeForAbsoluteTime

getMediaTimeForAbsoluteTime(absoluteTime) renvoie number

Convertit le temps absolu du média en temps média. Le temps absolu ne s'applique qu'aux diffusions en direct.

Paramètre

absoluteTime

Total

Heure absolue du contenu multimédia, exprimée en secondes depuis l'epoch UNIX.

Renvoie

nullable number Heure du contenu multimédia ou null si elle n'est pas disponible.

getPlaybackConfig

getPlaybackConfig() renvoie cast.framework.PlaybackConfig

Renvoie la configuration de lecture ou null si les valeurs par défaut n'ont pas été remplacées.

Renvoie

nullable cast.framework.PlaybackConfig 

getPlaybackRate

getPlaybackRate() renvoie un nombre

Renvoie la vitesse de lecture actuelle. Renvoie 1 avant l'appel du récepteur CastReceiverContext#start.

Renvoie

number Vitesse de lecture actuelle.

getPlayerState

getPlayerState() renvoie cast.framework.messages.PlayerState

Récupère l'état Player.

Renvoie

non-null cast.framework.messages.PlayerState État de l'Player actuel.

getPreferredPlaybackRate

getPreferredPlaybackRate() renvoie un nombre

Obtenez la vitesse de lecture préférée. Peut être utilisé lors de l'événement d'arrêt pour enregistrer la dernière vitesse de lecture préférée dans le stockage persistant, afin qu'elle puisse être utilisée lors de la prochaine session dans les options de diffusion.

Renvoie

number 

getPreferredTextLanguage

getPreferredTextLanguage() renvoie une chaîne

Récupère la langue préférée de la piste de texte.

Renvoie

nullable string 

getPreferredTextStyle

getPreferredTextStyle() renvoie cast.framework.messages.TextTrackStyle

Récupère le style de piste de texte préféré.

Renvoie

nullable cast.framework.messages.TextTrackStyle 

getQueueManager

getQueueManager() returns (cast.framework.QueueManager or undefined)

Obtient l'instance QueueManager.

Renvoie

(non-null cast.framework.QueueManager or undefined) 

getRawCurrentTimeSec

getRawCurrentTimeSec() renvoie un nombre.

Obtient la durée de lecture écoulée du contenu multimédia actuel, sans soustraire la durée de la coupure publicitaire.

Renvoie

number Temps écoulé, en secondes. Cette valeur sera 0 si aucun contenu multimédia n'est en cours de lecture.

getRawSeekableRange

getRawSeekableRange() renvoie cast.framework.messages.Range

Renvoie la plage de recherche du contenu multimédia actuel.

REMARQUE : Cela correspond aux unités de getRawCurrentTimeSec(), mais pas à celles de seek(). Cela ne tient pas compte des décalages des annonces ni d'aucun autre contenu multimédia. À moins que vous ne soyez sûr d'avoir besoin des valeurs brutes, vous devriez plutôt utiliser getLiveSeekableRange().

Renvoie

nullable cast.framework.messages.Range 

getStartAbsoluteTime

getStartAbsoluteTime() renvoie un nombre

Obtient l'heure de début absolue du contenu multimédia, en tant que heure de l'epoch UNIX (en secondes depuis l'epoch UNIX). Le temps absolu ne s'applique qu'aux diffusions en direct.

Renvoie

nullable number 

getStats

getStats() renvoie cast.framework.stats.Stats

Renvoie les statistiques de lecture. Les statistiques sont agrégées sur l'ensemble de la session de lecture, le cas échéant.

Renvoie

non-null cast.framework.stats.Stats 

getSupportedMediaCommands

getSupportedMediaCommands() renvoie un nombre

Obtient les commandes multimédias compatibles avec le récepteur. Ne doit être appelé qu'après CastReceiverContext#start(), sinon il renvoie 0. La valeur des commandes multimédias acceptées est contrôlée uniquement par l'application réceptrice . Il n'est pas mis à jour automatiquement en fonction d'un MediaStatus.

Voir aussi
cast.framework.messages.Command
Renvoie

number Masque de bits des commandes multimédias acceptées par l'application.

getTextTracksManager

getTextTracksManager() renvoie cast.framework.TextTracksManager

Obtient l'instance TextTracksManager.

Renvoie

non-null cast.framework.TextTracksManager 

getTimedMetadata

getTimedMetadata() renvoie un tableau de cast.framework.TimedMetadata non null.

Renvoie les métadonnées temporelles rencontrées lors de l'analyse du fichier manifeste. Il s'agit de #EXT-X-DATERANGE dans HLS et de EventStream dans DASH.

Renvoie

non-null Array of non-null cast.framework.TimedMetadata 

auto-infligée

load(loadRequest) renvoie une promesse contenant void

Lance une requête pour charger le contenu multimédia.

Paramètre

loadRequest

cast.framework.messages.LoadRequestData

Requête permettant de charger un contenu multimédia.

La valeur ne doit pas être nulle.

Renvoie

non-null Promise containing void Promesse résolue en cas de réussite de l'opération ou refusée en cas d'échec.

pause

pause()

Met en pause le contenu multimédia en cours de lecture.

lire

play()

Lit le contenu multimédia actuellement mis en pause.

removeEventListener

removeEventListener(eventType, eventListener)

Supprime l'écouteur d'événements ajouté pour un événement de lecture donné. Si aucun écouteur d'événement correspondant n'existe, cet appel est ignoré.

Paramètre

eventType

(cast.framework.events.EventType non nul ou tableau non nul de cast.framework.events.EventType non nul)

Un eventType ou un tableau de types d'événements

eventListener

function(non-null cast.framework.events.Event)

removeSupportedMediaCommands

removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

Supprimez des commandes de la liste des commandes multimédias compatibles.

Paramètre

supportedMediaCommands

Total

Masque de bits des commandes multimédias acceptées par l'application.

broadcastStatus

Facultatif

booléen

true indique que les expéditeurs doivent être informés du changement (s'il n'est pas fourni, les expéditeurs ne seront pas informés).

Voir aussi
cast.framework.messages.Command

seek

seek(seekTime)

Effectue une recherche dans le contenu multimédia actuel.

Paramètre

seekTime

Total

sendCustomState

sendCustomState(state)

Envoie un état personnalisé de la logique de lecture d'une application à la logique de l'UI. Cette méthode permet de séparer la logique de lecture et l'UI. La séparation entre la logique et l'UI permet d'utiliser la même logique d'UI pour la lecture locale et le contrôle à distance. L'état personnalisé envoyé par cette méthode est disponible pour l'UI via PlayerData.

Paramètre

state

Objet

Objet d'état personnalisé.

La valeur ne doit pas être nulle.

Voir aussi
cast.framework.ui.PlayerData#customState

sendError

sendError(senderId, requestId, type, reason, customData)

Envoie une erreur à un expéditeur spécifique.

Paramètre

senderId

chaîne

ID de l'expéditeur.

requestId

Total

ID de la requête entrante qui a provoqué cette erreur.

type

cast.framework.messages.ErrorType

Type d'erreur.

La valeur ne doit pas être nulle.

reason

Facultatif

cast.framework.messages.ErrorReason

Motif de l'erreur.

La valeur peut être nulle.

customData

Facultatif

Objet

Message d'erreur concernant les données personnalisées spécifiques à l'application.

La valeur peut être nulle.

sendLocalMediaRequest

sendLocalMediaRequest(request)

Envoie une requête média locale.

Paramètre

request

cast.framework.messages.RequestData

La valeur ne doit pas être nulle.

sendStatus

sendStatus(senderId, requestId, includeMedia, customData, includeQueueItems)

Envoie un message d'état du contenu multimédia à un expéditeur spécifique.

Paramètre

senderId

chaîne

ID de l'expéditeur.

requestId

Total

ID de la requête entrante qui a déclenché cette réponse.

includeMedia

Facultatif

booléen

true indique que le message doit inclure une instance MediaInformation.

customData

Facultatif

Objet

Données personnalisées spécifiques à l'application du message d'état.

La valeur peut être nulle.

includeQueueItems

Facultatif

booléen

Indique si les éléments de la file d'attente doivent être inclus dans le message d'état. Par défaut, ils ne sont pas inclus.

setIdleReason

setIdleReason(idleReason)

Définit la raison pour laquelle le lecteur est à l'état IDLE. Cela permet aux applications qui souhaitent forcer l'état IDLE d'indiquer la raison de cette action (par exemple, une erreur personnalisée). La raison de l'inactivité est envoyée dans le prochain message d'état. Remarque : La plupart des applications n'ont pas besoin de définir cette valeur. Elle n'est nécessaire que si l'application doit faire passer Player à l'état IDLE dans des circonstances particulières et que la valeur idleReason par défaut ne reflète pas le comportement souhaité.

Paramètre

idleReason

cast.framework.messages.IdleReason

Raison de l'état IDLE.

La valeur ne doit pas être nulle.

setMediaElement

setMediaElement(mediaElement)

Définit le HTMLMediaElement à utiliser. Si un Promise d'un HTMLMediaElement est défini, la lecture du contenu multimédia commence une fois le Promise résolu.

Paramètre

mediaElement

(HTMLMediaElement non nul ou Promise non nulle contenant HTMLMediaElement non nul)

MediaElement que le Player utilisera.

setMediaInformation

setMediaInformation(mediaInformation, opt_broadcast)

Définit les informations sur le média.

Paramètre

mediaInformation

cast.framework.messages.MediaInformation

La valeur ne doit pas être nulle.

opt_broadcast

Facultatif

booléen

setMediaPlaybackInfoHandler

setMediaPlaybackInfoHandler(handler)

Définit un gestionnaire pour renvoyer ou modifier cast.framework.PlaybackConfig pour une demande de chargement spécifique. Les paramètres du gestionnaire sont LoadRequestData et PlaybackConfig par défaut pour le récepteur (fournis dans CastReceiverOptions). Le gestionnaire doit renvoyer une configuration de lecture modifiée ou null pour empêcher la lecture du contenu multimédia. La valeur renvoyée peut également être Promise pour permettre l'attente des données du serveur.

Paramètre

handler

function(non-null cast.framework.messages.LoadRequestData, non-null cast.framework.PlaybackConfig)

Fonction permettant de fournir une configuration de lecture spécifique à une requête.

La valeur peut être nulle.

setMediaUrlResolver

setMediaUrlResolver(resolver)

Définit un gestionnaire pour renvoyer l'URL du contenu multimédia pour une requête LOAD. Ce gestionnaire peut être utilisé pour éviter que l'URL du contenu multimédia soit publiée dans l'état du contenu multimédia. Par défaut, le média contentId est utilisé comme URL du contenu.

Paramètre

résolveur

function(non-null cast.framework.messages.LoadRequestData)

Fonction permettant de résoudre l'URL du contenu multimédia.

La valeur peut être nulle.

setMessageInterceptor

setMessageInterceptor(type, interceptor)

Définit un intercepteur pour les messages entrants et sortants. L'intercepteur peut mettre à jour les données de la requête et doit renvoyer des données mises à jour, un Promise avec des données mises à jour (si les données ne peuvent pas être renvoyées immédiatement) ou null si la requête ne doit pas être traitée. Remarque : Si un intercepteur de message LOAD est fourni, mais qu'aucun intercepteur PRELOAD distinct n'est fourni, l'intercepteur LOAD sera appelé pour les messages PRELOAD.

Paramètre

type

cast.framework.messages.MessageType

La valeur ne doit pas être nulle.

intercepteur

function(non-null cast.framework.messages.RequestData)

La valeur peut être nulle.

setPlaybackConfig

setPlaybackConfig(playbackConfig)

Définit la configuration de la lecture sur PlayerManager.

Paramètre

playbackConfig

cast.framework.PlaybackConfig

La valeur ne doit pas être nulle.

setSupportedMediaCommands

setSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

Définit les commandes multimédias prises en charge par le récepteur.

Paramètre

supportedMediaCommands

Total

Masque de bits des commandes multimédias acceptées par l'application.

broadcastStatus

Facultatif

booléen

true indique que les expéditeurs doivent être informés du changement (s'il n'est pas fourni, les expéditeurs ne seront pas informés).

Voir aussi
cast.framework.messages.Command

stop

stop()

Arrête le contenu multimédia en cours de lecture.