Classe: PlayerManager

cast.framework.PlayerManager

class   static

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

Génère

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

Méthodes

/#!

/#!(eventType, eventListener)

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

Paramètre
eventType	(non nul cast.framework.events.EventType ou tableau non nul de cast.framework.events.EventType non nul Type d'événement ou tableau de types d'événements
écouteur d'événements	function(non-null cast.framework.events.Event)

Génère

non-null Error Si les arguments indiqués ne sont pas valides.

addSupportedMediaCommands

addSupportedMediaCommands(supportedMediaCommands, broadcastStatus) ;

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

Paramètre
pris en charge des commandes de support	nombre Masque de bits des commandes multimédias compatibles avec l'application.
étatdediffusion	Facultatif booléen true indique que les expéditeurs doivent être informés du changement (s'ils ne sont pas renseignés, ils en seront informés).

Voir aussi

cast.framework.messages.Command

étatdediffusion

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ètre
includeMedia	Facultatif booléen true indique que le message doit inclure des informations sur les médias.
requestId	Facultatif nombre ID de la requête entrante qui a causé cette réponse.
données personnalisées	Facultatif Objet Message personnalisé d'état des données personnalisées spécifiques à l'application. 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. Ils ne sont pas inclus par défaut.

getAbsoluteTimeForMediaTime

getAbsoluteTimeForMediaTime(mediaTime) renvoie nombre

Convertit le temps média en temps absolu. La durée absolue ne s'applique qu'aux diffusions en direct.

Paramètre
temps_média	nombre Le temps du média.

Renvoie

nullable number Heure absolue ou null si non disponible.

getAudioTracksManager (Gestionnaire audio de pistes)

getAudioTracksManager() renvoie cast.framework.AudioTracksManager

Récupère l'instance AudioTracksManager.

Renvoie

non-null cast.framework.AudioTracksManager 

getBreakClipCurrentTimeSec

La méthode getBreakClipCurrentTimeSec() renvoie le nombre

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

Renvoie

nullable number Moment actuel dans l'extrait de coupure publicitaire actuel, en secondes. null lorsque Player ne lit pas d'extrait de coupure publicitaire.

getBreakClipDurationSec

getBreakClipDurationSec() renvoie le nombre

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

Renvoie

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

getBreakManager

La méthode getBreakManager() renvoie cast.framework.breaks.BreakManager

Récupère l'instance BreakManager.

Renvoie

non-null cast.framework.breaks.BreakManager 

getBreaks

getBreaks() renvoie le tableau cast.framework.messages.Break non nul

Renvoie une liste de sauts.

Renvoie

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

getCurrentSupportedMediaCommands

getCurrentSupportedMediaCommands() renvoie le numéro

Récupère les commandes multimédias compatibles du récepteur actuel. Contrairement à getSupportedMediaCommands(), la valeur renvoyée par cette méthode change de façon dynamique en fonction de l'état de lecture actuel. Par exemple, pendant la lecture des annonces, la commande SEEK peut ne pas être compatible. Cette méthode ne doit être appelée qu'après avoir appelé le receiver CastReceiverContext#start. Sinon, elle renvoie 0.

Voir aussi

cast.framework.messages.Command

Renvoie

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

getCurrentTimeSec

getCurrentTimeSec() renvoie le nombre

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

Renvoie

number Temps écoulé, en secondes. La valeur sera 0 si aucun contenu multimédia n'est diffusé.

getDurationSec

getDurationSec() renvoie le 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)

La méthode getLiveSeekableRange() renvoie la valeur cast.framework.messages.LiveSeekableRange.

Renvoie la plage recherchée en direct, avec l'heure de début et l'heure de fin en secondes. Les valeurs sont basées sur le temps du média.

Renvoie

nullable cast.framework.messages.LiveSeekableRange 

getMediaInformation

La fonction getMediaInformation() renvoie la valeur cast.framework.messages.MediaInformation.

Récupère les informations multimédias du média actuel.

Renvoie

nullable cast.framework.messages.MediaInformation 

getMediaTimeForAbsoluteTime

getMediaTimeForAbsoluteTime(AbsoluteTime) renvoie le nombre

Convertit l'heure absolue du média en temps média. La durée absolue ne s'applique qu'aux diffusions en direct.

Paramètre
heure absolue	nombre Heure absolue du média, sous forme d'époque UNIX (secondes depuis l'epoch Unix).

Renvoie

nullable number Temps média ou null s'il n'est pas disponible.

getPlaybackConfig

La méthode getPlaybackConfig() renvoie cast.framework.PlaybackConfig.

Renvoie la configuration de la lecture.

Renvoie

nullable cast.framework.PlaybackConfig 

getPlaybackRate (taux de lecture)

La fonction getPlaybackRate() renvoie le nombre

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

Renvoie

number Vitesse de lecture actuelle.

getPlayerState

La fonction getPlayerState() renvoie la valeur cast.framework.messages.PlayerState.

Récupère l'état Player.

Renvoie

non-null cast.framework.messages.PlayerState État du Player actuel.

getPreferredPlaybackRate

La méthode getPreferredPlaybackRate() renvoie le nombre

Obtenir la vitesse de lecture préférée. Peut être utilisée lors d'un arrêt pour enregistrer la dernière vitesse de lecture préférée dans le stockage persistant, afin de pouvoir l'utiliser lors de la prochaine session dans les options de diffusion.

Renvoie

number 

getPreferredTextLanguage

La méthode getPreferredTextLanguage() renvoie une chaîne.

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

Renvoie

nullable string 

getPreferredTextStyle

La méthode getPreferredTextStyle() renvoie cast.framework.messages.TextTrackStyle

Récupère le style de piste textuelle souhaité.

Renvoie

nullable cast.framework.messages.TextTrackStyle 

getQueueManager

getQueueManager() renvoie (cast.framework.QueueManager ou undefined)

Récupère l'instance QueueManager.

Renvoie

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

getRawCurrentTimeSec

getRawCurrentTimeSec() renvoie le nombre

Récupère le temps de lecture écoulé du média actuel, sans soustraire le temps de coupure publicitaire.

Renvoie

number Temps écoulé, en secondes. La valeur sera 0 si aucun contenu multimédia n'est diffusé.

getStartAbsoluteTime

La méthode getStartAbsoluteTime() renvoie le nombre

Récupère l'heure de début du média absolu, au format UNIX Epoch (secondes depuis l'epoch Unix). La durée absolue 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 

getCompatibleMediaCommands

getSupportedMediaCommands() renvoie le numéro

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

Voir aussi

cast.framework.messages.Command

Renvoie

number Masque de 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 le tableau cast.framework.TimedMetadata non nul

Renvoie les métadonnées minutées détectées lors de l'analyse du fichier manifeste. #EXT-X-DATERANGE dans HLS et EventStream dans DASH.

Renvoie

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

load

load(loadRequest) renvoie la promesse contenant le caractère vide.

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

Paramètre
Requête de chargement	cast.framework.messages.LoadRequestData Requête de chargement d'un contenu multimédia. La valeur ne doit pas être null.

Renvoie

non-null Promise containing void Promesse 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

play()

Lire les contenus multimédias 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	(non nul cast.framework.events.EventType ou tableau non nul de cast.framework.events.EventType non nul Un événement eventType ou un tableau de types d'événements
écouteur d'événements	function(non-null cast.framework.events.Event)

removeSupportedMediaCommands

removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus) ;

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

Paramètre
pris en charge des commandes de support	nombre Masque de bits des commandes multimédias compatibles avec l'application.
étatdediffusion	Facultatif booléen true indique que les expéditeurs doivent être informés du changement (s'ils ne sont pas renseignés, ils en seront informés).

Voir aussi

cast.framework.messages.Command

seek

recherchez(seekTime)

Recherche les contenus multimédias actuels.

Paramètre
recherchez	nombre

envoyer un état personnalisé

sendCustomState(state)

Envoie un état personnalisé à une logique d'application à partir d'une logique de lecture d'application. 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'interface utilisateur permet d'utiliser la même logique d'interface utilisateur 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
final	Objet Objet d'état personnalisé. La valeur ne doit pas être null.

Voir aussi

cast.framework.ui.PlayerData#customState

Envoyer une erreur

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

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

Paramètre
id_expéditeur	chaîne ID de l'expéditeur.
requestId	nombre ID de la requête entrante à l'origine de cette erreur.
type	cast.framework.messages.ErrorType Type d'erreur. La valeur ne doit pas être null.
reason	Facultatif cast.framework.messages.ErrorReason Motif de l'erreur. La valeur peut être nulle.
données personnalisées	Facultatif Objet Message d'erreur personnalisé des donné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 null.

étatétat

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

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

Paramètre
id_expéditeur	chaîne ID de l'expéditeur.
requestId	nombre ID de la requête entrante qui a causé cette réponse.
includeMedia	Facultatif booléen true indique que le message doit inclure une instance MediaInformation.
données personnalisées	Facultatif Objet Message personnalisé d'état des données personnalisées spécifiques à l'application. 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. Ils ne sont pas inclus par défaut.

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 à indiquer la raison de cette opération (par exemple, une erreur personnalisée). Le motif d'inactivité est envoyé dans le message d'état suivant. Remarque : La plupart des applications n'ont pas besoin de définir cette valeur. Cela n'est nécessaire que si l'application doit faire en sorte que Player passe à l'état IDLE dans des circonstances spéciales et que l'attribut "Reason" (par défaut) par défaut ne reflète pas le comportement souhaité.

Paramètre
Raison Inactif	cast.framework.messages.IdleReason Motif pour lequel l'état est IDLE. La valeur ne doit pas être null.

setMediaElement

setMediaElement(mediaElement)

Définit l'élément HTMLMediaElement à utiliser. Si l'Promise d'une HTMLMediaElement est défini, la lecture du contenu multimédia commence après la résolution de l'Promise.

Paramètre
Élément multimédia	(HTMLMediaElement non nul ou promesse non nulle contenant HTMLMediaElement non nul) MediaElement que Player utilisera.

setMediaInformation

setMediaInformation(mediaInformation, opt_broadcast)

Définit les informations sur les médias.

Paramètre
MediaInformation	cast.framework.messages.MediaInformation La valeur ne doit pas être null.
diffuser_diffusion	Facultatif booléen

setMediaPlaybackInfoHandler

setMediaPlaybackInfoHandler(handler)

Définit un gestionnaire pour renvoyer ou modifier cast.framework.PlaybackConfig, pour une requête de chargement spécifique. Les paramètres du gestionnaire sont LoadRequestData et le 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 Promise pour permettre aux données du serveur d'attendre.

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 à la requête. La valeur peut être nulle.

setMediaUrlResolver

setMediaUrlResolver(resolver)

Définit un gestionnaire pour renvoyer l'URL de contenu multimédia pour une requête LOAD. Ce gestionnaire permet d'éviter que l'URL de contenu multimédia soit publiée dans le cadre de l'état du contenu multimédia. Par défaut, le support contentId est utilisé comme URL de 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, intercepteur)

Définit un intercepteur de messages entrants et sortants. L'intercepteur peut mettre à jour les données de requête et doit renvoyer les 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 null.
intercepteur	function(non-null cast.framework.messages.RequestData) La valeur peut être nulle.

setPlaybackConfig

setPlaybackConfig(playbackConfig)

Définit la configuration de la lecture sur le PlayerManager.

Paramètre
playConfig	cast.framework.PlaybackConfig La valeur ne doit pas être null.

setCompatibleMediaCommands

setCompatibleMediaCommands(supportedMediaCommands, broadcastStatus)

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

Paramètre
pris en charge des commandes de support	nombre Masque de bits des commandes multimédias compatibles avec l'application.
étatdediffusion	Facultatif booléen true indique que les expéditeurs doivent être informés du changement (s'ils ne sont pas renseignés, ils en seront informés).

Voir aussi

cast.framework.messages.Command

stop

stop()

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