cast. framework. PlayerManager
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
addEventListener
addEventListener(eventType, eventListener) :
Ajoute un écouteur d'événements qui écoute les événements de lecture.
Paramètre |
|
---|---|
eventType |
(valeur cast.framework.events.EventType non nulle ou tableau non nul de valeur cast.framework.events.EventType non nulle) Type d'événement ou tableau de types d'événements |
Écouteur d'événements |
function(non nulle cast.framework.events.Event) |
- Génère
-
non-null Error
Si les arguments donné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 les commandes multimédias |
number (nombre) Masque de bits des commandes multimédias compatibles avec l'application. |
État de la diffusion |
Facultative booléen
|
- Voir aussi
- cast.framework.messages.Command
État de la diffusion
broadcastStatus(includeMedia, requestId, customData, includeQueueItems)
Envoie un message de disponibilité multimédia à tous les expéditeurs (diffusion). Les applications l'utilisent pour envoyer un changement d'état personnalisé.
Paramètre |
|
---|---|
includeMedia |
Facultative booléen
|
requestId |
Facultative number (nombre) ID de la requête entrante qui a provoqué cette réponse. |
données personnalisées |
Facultative Objet Message d'état indiquant les données personnalisées spécifiques à l'application. La valeur peut être nulle. |
includeQueueItems |
Facultative 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. |
get absoluTimeForMediaTime
getabsoluteTimeForMediaTime(mediaTime) returns number
Convertit le temps média en temps absolu. La durée absolue ne s'applique qu'aux diffusions en direct.
Paramètre |
|
---|---|
heure du média |
number (nombre) Temps média. |
- Retours
-
nullable number
Heure absolue ounull
si non disponible.
getAudioTracksManager
La fonction getAudioTracksManager() renvoie cast.framework.AudioTracksManager
Récupère l'instance AudioTracksManager
.
- Retours
-
non-null cast.framework.AudioTracksManager
getBreakClipCurrentTimeSec
La fonction getBreakClipCurrentTimeSec() renvoie le numéro
Renvoie l'heure actuelle de l'extrait de coupure vidéo en cours de lecture, en secondes.
- Retours
-
nullable number
Heure actuelle en secondes dans le clip actuel.null
lorsquePlayer
ne lit pas d'extrait de coupure publicitaire.
getBreakClipDurationSec
La méthode getBreakClipDurationSec() renvoie le numéro
Renvoie la durée de l'extrait de coupure en cours de lecture, en secondes.
- Retours
-
nullable number
Durée de l'extrait vidéo actuel.null
lorsquePlayer
ne lit pas d'extrait vidéo.
getBreakManager
getBreakManager() renvoie cast.framework.breaks.BreakManager
Récupère l'instance BreakManager
.
- Retours
-
non-null cast.framework.breaks.BreakManager
getBreaks
getBreaks() renvoie un tableau de valeurs cast.framework.messages.Break non nulles
Affiche une liste de sauts.
- Retours
-
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 manière dynamique en fonction de l'état de lecture actuel. Par exemple, pendant la lecture des annonces, il est possible que la commande SEEK
ne soit pas compatible.
Cette méthode ne doit être appelée qu'après l'appel du destinataire CastReceiverContext#start
. Sinon, elle renvoie 0
.
- Voir aussi
- cast.framework.messages.Command
- Retours
-
number
Masque binaire des commandes multimédias compatibles avec l'application.
getCurrentTimeSec
getCurrentTimeSec() affiche le numéro
Obtenir le temps de lecture écoulé du média actuel
- Retours
-
number
Temps écoulé, en secondes. Ce champ est0
si aucun contenu multimédia n'est en cours de lecture.
getDurationSec
getDurationSec() renvoie le numéro
Récupère la durée du contenu multimédia en cours de lecture, en secondes.
- Retours
-
number
Durée de l'élément multimédia.NaN
s'il n'y a pas de contenu multimédia en cours de lecture.
getLiveSeekableRange
getLiveSeekableRange() renvoie cast.framework.messages.LiveSeekableRange
Renvoie la plage accessible en direct, avec l'heure de début et l'heure de fin en secondes. Les valeurs sont basées sur le temps média.
- Retours
getMediaInformation
La fonction getMediaInformation() renvoie cast.framework.messages.MediaInformation.
Obtient des informations sur les médias actuels.
- Retours
getMediaTimeForabsoluteTime
getMediaTimeForabsoluteTime(absoluteTime) renvoie nombre
Convertit l'heure absolue du support en temps média. La durée absolue n'est applicable que pour les diffusions en direct.
Paramètre |
|
---|---|
heure absolue |
number (nombre) Heure absolue du média, au format UNIX Epoch (secondes depuis l'époque Unix). |
- Retours
-
nullable number
Multimédia ounull
si cette option n'est pas disponible
getPlaybackConfig
La fonction getPlaybackConfig() renvoie cast.framework.PlaybackConfig
Renvoie la configuration de lecture.
- Retours
-
nullable cast.framework.PlaybackConfig
getPlaybackRate (obtenir la fréquence de lecture)
La fonction getPlaybackRate() renvoie le numéro
Renvoie la vitesse de lecture actuelle.
Renvoie 1
avant que le destinataire CastRecevierContext#start
soit appelé.
- Retours
-
number
Vitesse de lecture actuelle.
getPlayerState
getPlayerState() renvoie cast.framework.messages.PlayerState
Récupère l'état Player
.
- Retours
-
non-null cast.framework.messages.PlayerState
État duPlayer
actuel.
getPreferredPlaybackRate (Taux de lecture préféré)
La méthode getPreferredPlaybackRate() renvoie les valeurs suivantes :
Obtenir la vitesse de lecture préférée Peut être utilisé 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 prochaine session dans les options de cast.
- Retours
-
number
getPreferredTextLanguage
La méthode getPreferredTextLanguage() renvoie la chaîne.
Récupère la langue de la piste de texte préférée.
- Retours
-
nullable string
getPreferredTextStyle
getPreferredTextStyle() renvoie cast.framework.messages.TextTrackStyle
Récupère le style de la piste de texte préféré.
- Retours
getQueueManager
getQueueManager() returns (cast.framework.QueueManager ou non défini)
Récupère l'instance QueueManager
.
- Retours
-
(non-null cast.framework.QueueManager or undefined)
getRawCurrentTimeSec
La méthode getRawCurrentTimeSec() renvoie le numéro
Récupère le temps de lecture écoulé du contenu multimédia actuel, sans soustraire le temps de coupure publicitaire.
- Retours
-
number
Temps écoulé, en secondes. Ce champ est0
si aucun contenu multimédia n'est en cours de lecture.
getStartabsoluteTime
La fonction getStartabsoluteTime() renvoie le numéro
Récupère l'heure de début du support absolu au format UNIX Epoch (en secondes depuis l'époque Unix). La durée absolue ne s'applique qu'aux diffusions en direct.
- Retours
-
nullable number
getStats
getStats() renvoie cast.framework.Stats
Affiche les statistiques de lecture. Les statistiques sont agrégées sur toute la session de lecture, le cas échéant.
- Retours
-
non-null cast.framework.Stats
getSupportedMediaCommands
getSupportedMediaCommands() renvoie le numéro
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, 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 automatiquement mis à jour sur la base d'un MediaStatus
.
- Voir aussi
- cast.framework.messages.Command
- Retours
-
number
Masque binaire des commandes multimédias compatibles avec l'application.
getTextTracksManager
La méthode getTextTracksManager() renvoie cast.framework.TextTracksManager.
Récupère l'instance TextTracksManager
.
- Retours
-
non-null cast.framework.TextTracksManager
getTimedMetadata
getTimedMetadata() renvoie un tableau de cast.framework.TimedMetadata non nul
Renvoie les métadonnées chronométrées rencontrées lors de l'analyse du fichier manifeste. Il s'agit de #EXT-X-DATERANGE
dans HLS, et de EventStream
dans DASH.
- Retours
-
non-null Array of non-null cast.framework.TimedMetadata
load
load(loadRequest) renvoie la promesse contenant void
Lance une demande de chargement de contenu multimédia.
Paramètre |
|
---|---|
loadRequest |
cast.framework.messages.LoadRequestData Requête permettant de charger un élément multimédia. La valeur ne doit pas être nulle. |
- Retours
-
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.
lecture
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 |
(valeur cast.framework.events.EventType non nulle ou tableau non nul de valeur cast.framework.events.EventType non nulle) Événement ou tableau de types d'événements |
Écouteur d'événements |
function(non nulle cast.framework.events.Event) |
removeSupportedMediaCommands
removeSupportedMediaCommands(supportedMediaCommands, broadcastStatus)
Supprimez des commandes de la liste des commandes multimédias compatibles.
Paramètre |
|
---|---|
pris en charge les commandes multimédias |
number (nombre) Masque de bits des commandes multimédias compatibles avec l'application. |
État de la diffusion |
Facultative booléen
|
- Voir aussi
- cast.framework.messages.Command
seek
chercher(seekTime)
Recherche les contenus multimédias actuels.
Paramètre |
|
---|---|
heure de recherche |
number (nombre) |
sendCustomState
sendCustomState(state)
Envoie un état personnalisé à partir d'une logique de lecture d'application à la logique de l'UI.
Cette méthode permet de séparer la logique de lecture et l'interface utilisateur.
Maintenir la séparation entre la logique et l'UI 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'interface utilisateur via PlayerData
.
Paramètre |
|
---|---|
state |
Objet Objet d'état personnalisé. La valeur ne doit pas être nulle. |
- 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 |
number (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 nulle. |
reason |
Facultative cast.framework.messages.ErrorReason Cause de l'erreur. La valeur peut être nulle. |
données personnalisées |
Facultative Objet Message d'erreur indiquant des données personnalisées spécifiques à une 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. |
envoyer un état
sendStatus(senderId, requestId, includeMedia, customData, includeQueueItems)
Envoie un message de disponibilité multimédia à un expéditeur spécifique.
Paramètre |
|
---|---|
id_expéditeur |
chaîne ID de l'expéditeur. |
requestId |
number (nombre) ID de la requête entrante qui a provoqué cette réponse. |
includeMedia |
Facultative booléen
|
données personnalisées |
Facultative Objet Message d'état indiquant les données personnalisées spécifiques à l'application. La valeur peut être nulle. |
includeQueueItems |
Facultative 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
à en indiquer la raison (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 si le motif d'inactivité par défaut ne reflète pas le comportement souhaité.
Paramètre |
|
---|---|
motif inactif |
cast.framework.messages.IdleReason Raison d'être à l'état La valeur ne doit pas être nulle. |
setMediaElement
setMediaElement(mediaElement)
Définit les HTMLMediaElement
à utiliser. Si une Promise
d'une HTMLMediaElement
est définie, la lecture de la lecture commence après la résolution de la Promise
.
Paramètre |
|
---|---|
MediaElement |
(Élément HTMLMediaElement non nul ou promesse Nuit contenant une valeur HTMLMediaElement non nulle)
|
setMediaInformation
setMediaInformation(mediaInformation, opt_broadcast)
Définit les informations multimédias.
Paramètre |
|
---|---|
MediaInformation |
cast.framework.messages.MediaInformation La valeur ne doit pas être nulle. |
diffusion_de_diffusion |
Facultative booléen |
setMediaPlaybackInfoHandler
setMediaPlaybackInfoHandler(handler)
Définit un gestionnaire à renvoyer ou modifier 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 (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 un Promise
pour permettre l'attente de données du serveur.
Paramètre |
|
---|---|
handler |
function(non nulle cast.framework.messages.LoadRequestData, non nulle cast.framework.PlaybackConfig) Fonction permettant de fournir une configuration de lecture spécifique aux requêtes La valeur peut être nulle. |
setMediaUrlResolver
setMediaUrlResolver(resolver)
Définit un gestionnaire à renvoyer l'URL 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 nulle cast.framework.messages.LoadRequestData) Fonction permettant de résoudre l'URL de 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 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 nulle cast.framework.messages.RequestData) La valeur peut être nulle. |
setPlaybackConfig
setPlaybackConfig(playbackConfig)
Définit la configuration de lecture sur PlayerManager
.
Paramètre |
|
---|---|
configuration de lecture |
La valeur ne doit pas être nulle. |
setSupportedMediaCommands
setSupportedMediaCommands(supportedMediaCommands, broadcastStatus)
Définit les commandes multimédias acceptées par le récepteur.
Paramètre |
|
---|---|
pris en charge les commandes multimédias |
number (nombre) Masque de bits des commandes multimédias compatibles avec l'application. |
État de la diffusion |
Facultative booléen
|
- Voir aussi
- cast.framework.messages.Command
stop
stop()
Arrêter le contenu multimédia en cours de lecture