Classe: PlayerManager

cast.framework.PlayerManager

class   statique

Contrôle et surveille la lecture des contenus multimédias.

Génère

non-null Error Si le constructeur est utilisé directement. PlayerManager n'est accessible qu'en appelant cast.framework.CastReceiverContext#getPlayerManager.

Méthodes

addEventListener

addEventListener(eventType, eventListener)

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

Paramètres
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 de commandes multimédias compatibles.

Paramètres
supportedMediaCommands	number Masque de bits des commandes multimédias compatibles avec l'application.
broadcastStatus	Facultatif boolean true indique que les expéditeurs doivent être informés du changement (s'ils ne sont pas renseignés, les expéditeurs seront avertis).

Voir aussi

cast.framework.messages.Command

broadcastStatus

broadcastStatus(includeMedia, requestId, customData, includeQueueItems)

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

Paramètres
includeMedia	Facultatif boolean true indique que le message doit inclure des informations sur le contenu multimédia.
requestId	Facultatif number ID de la requête entrante qui a causé 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 boolean Indique s'il faut inclure les éléments de la file d'attente dans le message d'état. Par défaut, elles ne sont pas incluses.

getAbsoluteTimeForMediaTime

getAbsoluteTimeForMediaTime(mediaTime) renvoie un nombre

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

Paramètres
mediaTime	number Durée de l'enregistrement.

Renvoie

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

getAudioTracksManager

getAudioTracksManager() renvoie cast.framework.AudioTracksManager

Récupère l'instance AudioTracksManager.

Renvoie

non-null cast.framework.AudioTracksManager 

getBreakClipCurrentTimeSec

getBreakClipCurrentTimeSec() renvoie un nombre.

Renvoie l'heure actuelle, en secondes, de l'extrait de coupure publicitaire en cours de lecture.

Renvoie

nullable number Heure actuelle en secondes dans l'extrait de coupure actuel. null lorsque Player n'est pas en train de lire un extrait de coupure publicitaire.

getBreakClipDurationSec

getBreakClipDurationSec() renvoie un nombre.

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

Renvoie

nullable number Durée de l'extrait actuel de la coupure publicitaire. null lorsque Player ne lit pas d'extrait de coupure publicitaire.

getBreakManager

getBreakManager() renvoie cast.framework.breaks.BreakManager.

Récupère l'instance BreakManager.

Renvoie

non-null cast.framework.breaks.BreakManager 

getBreaks

getBreaks() renvoie un tableau de valeurs non nulles cast.framework.messages.Break.

Affiche une liste de sauts de page.

Renvoie

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

getCurrentSupportedMediaCommands

getCurrentSupportedMediaCommands() renvoie un nombre

Récupère les commandes multimédias actuellement compatibles avec le récepteur. 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, lors de la lecture des annonces, la commande SEEK peut ne pas être compatible. Cette méthode ne doit être appelée qu'après l'appel du destinataire CastReceiverContext#start. Sinon, elle renverra 0.

Voir aussi

cast.framework.messages.Command

Renvoie

number Masque de bits des commandes multimédias compatibles avec l'application.

getCurrentTimeSec

getCurrentTimeSec() renvoie un nombre

Récupère le temps de lecture écoulé du contenu multimédia en cours.

Renvoie

number Temps écoulé, en secondes. Ce paramètre est défini sur 0 si aucun contenu multimédia n'est en cours de lecture.

getDurationSec

getDurationSec() renvoie un nombre

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

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 temps réel avec l'heure de début et l'heure de fin en secondes. Les valeurs sont basées sur l'heure du média.

Renvoie

nullable cast.framework.messages.LiveSeekableRange 

getMediaInformation

getMediaInformation() renvoie cast.framework.messages.MediaInformation.

Obtient des informations sur le contenu multimédia en cours de lecture.

Renvoie

nullable cast.framework.messages.MediaInformation 

getMediaTimeForAbsoluteTime

getMediaTimeForAbsoluteTime(absoluteTime) renvoie un nombre

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

Paramètres
absoluteTime	number Heure absolue du média, en heure UNIX (secondes écoulées depuis l'époque Unix).

Renvoie

nullable number Heure du mé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 destinataire 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 du Player actuel.

getPreferredPlaybackRate

getPreferredPlaybackRate() renvoie un nombre

Bénéficiez d'une vitesse de lecture préférée. Peut être utilisée lors d'un événement d'arrêt pour enregistrer la dernière vitesse de lecture préférée sur un espace de stockage persistant, afin de pouvoir l'utiliser lors de la session suivante 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)

Récupère l'instance QueueManager.

Renvoie

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

getRawCurrentTimeSec

getRawCurrentTimeSec() renvoie un nombre

Récupère le temps de lecture écoulé du contenu multimédia actuel, sans soustraire la durée de la coupure publicitaire.

Renvoie

number Temps écoulé, en secondes. Ce paramètre est défini sur 0 si aucun contenu multimédia n'est en cours de lecture.

getStartAbsoluteTime

getStartAbsoluteTime() renvoie un nombre.

Récupère l'heure de début absolue du média, en heure UNIX (en secondes depuis l'epoch Unix). Le temps absolu ne s'applique qu'aux diffusions en direct.

Renvoie

nullable number 

getStats

getStats() returns cast.framework.stats.Stats

Renvoie des statistiques de lecture. Le cas échéant, les statistiques sont agrégées pour l'ensemble de la session de lecture.

Renvoie

non-null cast.framework.stats.Stats 

getSupportedMediaCommands

getSupportedMediaCommands() renvoie un nombre

Récupère les commandes multimédias compatibles avec le récepteur. Ne doit être appelé qu'après l'appel de CastReceiverContext#start(). Sinon, la fonction renvoie 0. La valeur des commandes multimédias compatibles est contrôlée uniquement par l'application récepteur . Il n'est pas automatiquement mis à jour en fonction d'une MediaStatus.

Voir aussi

cast.framework.messages.Command

Renvoie

number Masque de bits des commandes multimédias compatibles avec l'application.

getTextTracksManager

getTextTracksManager() renvoie cast.framework.TextTracksManager.

Récupère l'instance TextTracksManager.

Renvoie

non-null cast.framework.TextTracksManager 

getTimedMetadata

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

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

Renvoie

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

load

load(loadRequest) renvoie Promise contenant vide

Lance une requête pour charger le média.

Paramètres
loadRequest	cast.framework.messages.LoadRequestData Requête permettant de charger un média. La valeur ne doit pas être nulle.

Renvoie

non-null Promise containing void Garantie qui est résolue lorsque l'opération a réussi ou refusée en cas d'échec.

mettre en pause

pause()

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

lecture

lecture()

Lit le contenu multimédia 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ètres
eventType	(cast.framework.events.EventType non nul ou tableau non nul de cast.framework.events.EventType non nul) EventType ou tableau de types d'événements
eventListener	function(non-null cast.framework.events.Event)

removeSupportedMediaCommands

removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

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

Paramètres
supportedMediaCommands	number Masque de bits des commandes multimédias compatibles avec l'application.
broadcastStatus	Facultatif boolean true indique que les expéditeurs doivent être informés du changement (s'ils ne sont pas renseignés, les expéditeurs seront avertis).

Voir aussi

cast.framework.messages.Command

seek

chercher(seekTime)

Recherche dans le contenu multimédia actuel.

Paramètres
seekTime	number

sendCustomState

sendCustomState(state)

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

Paramètres
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ètres
senderId	chaîne ID de l'expéditeur.
requestId	number ID de la requête entrante qui a causé 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 pour les données personnalisées spécifiques à l'application. La valeur peut être nulle.

sendLocalMediaRequest

sendLocalMediaRequest(request)

Envoie une requête de média local.

Paramètres
request	cast.framework.messages.RequestData La valeur ne doit pas être nulle.

sendStatus

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

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

Paramètres
senderId	chaîne ID de l'expéditeur.
requestId	number ID de la requête entrante qui a causé cette réponse.
includeMedia	Facultatif boolean 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 boolean Indique s'il faut inclure les éléments de la file d'attente dans le message d'état. Par défaut, elles ne sont pas incluses.

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'en indiquer la raison (par exemple, une erreur personnalisée). Le motif d'inactivité est envoyé dans le message d'état suivant. Remarque : Pour la plupart des applications, il n'est pas nécessaire de définir cette valeur. Elle n'est nécessaire que si l'application doit faire passer Player à l'état IDLE dans des circonstances spéciales et que l'élément "inactiveReason" par défaut ne reflète pas le comportement attendu.

Paramètres
idleReason	cast.framework.messages.IdleReason Raison pour laquelle l'état est IDLE. La valeur ne doit pas être nulle.

setMediaElement

setMediaElement(mediaElement)

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

Paramètres
mediaElement	(HTMLMediaElement non nul ou Promise non nulle contenant un HTMLMediaElement non nul) MediaElement que Player utilisera.

setMediaInformation

setMediaInformation(mediaInformation, opt_broadcast)

Définit les informations sur le contenu multimédia.

Paramètres
mediaInformation	cast.framework.messages.MediaInformation La valeur ne doit pas être nulle.
opt_broadcast	Facultatif boolean

setMediaPlaybackInfoHandler

setMediaPlaybackInfoHandler(handler)

Définit un gestionnaire pour qu'il renvoie ou modifie cast.framework.PlaybackConfig, pour une requête de chargement spécifique. Les paramètres du gestionnaire sont LoadRequestData et PlaybackConfig par défaut pour le récepteur (fourni 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 un Promise pour permettre d'attendre des données du serveur.

Paramètres
handler	function(non-null cast.framework.messages.LoadRequestData, non-null cast.framework.PlaybackConfig) Fonction permettant de fournir une configuration de lecture spécifique à la requête. La valeur peut être nulle.

setMediaUrlResolver

setMediaUrlResolver(resolver)

Définit un gestionnaire de sorte qu'il renvoie l'URL du contenu multimédia pour une requête LOAD. Ce gestionnaire permet d'éviter que l'URL du contenu multimédia ne soit publiée dans l'état du contenu multimédia. Par défaut, le contentId multimédia est utilisé comme URL de contenu.

Paramètres
résolveur	function(non-null cast.framework.messages.LoadRequestData) Fonction permettant de résoudre l'URL de contenu multimédia. La valeur peut être nulle.

setMessageInterceptor

setMessageInterceptor(type, interceptor)

Définit un intercepteur des messages entrants et sortants. L'intercepteur peut mettre à jour les données de la requête et doit renvoyer les données mises à jour, un Promise avec les 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 messages LOAD est fourni, mais qu'aucun intercepteur PRELOAD distinct n'est fourni, l'intercepteur LOAD est appelé pour les messages PRELOAD.

Paramètres
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 lecture sur PlayerManager.

Paramètres
playbackConfig	cast.framework.PlaybackConfig La valeur ne doit pas être nulle.

setSupportedMediaCommands

setSupportedMediaCommands(supportedMediaCommands, broadcastStatus)

Définit les commandes multimédias compatibles avec le récepteur.

Paramètres
supportedMediaCommands	number Masque de bits des commandes multimédias compatibles avec l'application.
broadcastStatus	Facultatif boolean true indique que les expéditeurs doivent être informés du changement (s'ils ne sont pas renseignés, les expéditeurs seront avertis).

Voir aussi

cast.framework.messages.Command

escale

stop()

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