Classe: Médias

chrome.cast.contenu multimédia.Contenu multimédia

class   statique

Représente un élément multimédia chargé dans l'application réceptrice.

Constructeur

Multimédia

new Media(sessionId, mediaSessionId)

Paramètres
sessionId	chaîne Identifiant de session.
mediaSessionId	number Identifiant du support.

Propriétés

activeTrackIds

Tableau de nombres pouvant avoir une valeur nulle

Liste des ID correspondant aux pistes actives.

breakStatus

(valeur non nulle chrome.cast.media.BreakStatus ou non définie)

État des coupures en cours de lecture sur le récepteur. Ce champ est défini lorsque le destinataire lit une pause, vide lorsqu'aucune coupure n'est en cours de lecture, mais est présent dans le contenu, et non défini si le contenu ne comporte pas de pause.

currentItemId

nombre pouvant avoir une valeur nulle

ID de l'élément qui était actif dans la file d'attente (il se peut qu'il ne soit pas en cours de lecture) au moment du changement d'état du média.

currentTime

number

Position de lecture actuelle, en secondes, depuis le début du contenu multimédia. Ce membre n'est mis à jour que de manière sporadique. Sa valeur est donc souvent obsolète. Utilisez la méthode getEstimatedTime pour obtenir une estimation de la position de lecture réelle en fonction des dernières informations transmises par le récepteur.

Obsolète

Utilisez plutôt getEstimatedTime.

customData

Objet pouvant avoir une valeur nulle

Ensemble de données personnalisées par l'application réceptrice.

idleReason

peut avoir une valeur nulle pour chrome.cast.media.IdleReason

Motif d'inactivité si le destinataire le sait.

items

Tableau pouvant avoir une valeur nulle de chrome.cast.media.QueueItem non nul

Tableau des éléments triés dans la file d'attente.

liveSeekableRange

(valeur non nulle chrome.cast.media.LiveSeekableRange ou non définie)

Plage consultable d'un flux en direct ou d'événement. Il utilise le temps média relatif en secondes. Elle n'est pas définie pour les flux de vidéo à la demande.

loadingItemId

nombre pouvant avoir une valeur nulle

ID de l'élément en cours de chargement sur le récepteur. Valeur nulle si aucun élément n'est en cours de chargement.

media

peut avoir une valeur nulle pour chrome.cast.media.MediaInfo

Description du contenu multimédia.

mediaSessionId

number

Identifie l'élément multimédia.

playbackRate

number

Vitesse de lecture. 1,0 correspond à une lecture normale.

playerState

non-null chrome.cast.media.PlayerState

État du lecteur.

preloadedItemId

nombre pouvant avoir une valeur nulle

ID de l'élément suivant, disponible uniquement s'il a été préchargé. Sur le récepteur, les éléments multimédias peuvent être préchargés et mis en cache temporairement en mémoire. Ainsi, lorsqu'ils sont chargés ultérieurement, le processus est plus rapide (car les médias n'ont pas besoin d'être récupérés sur le réseau).

queueData

(valeur non nulle chrome.cast.media.QueueData ou non définie)

Données de la file d'attente

repeatMode

non-null chrome.cast.media.RepeatMode

Mode de répétition pour lire la file d'attente.

sessionId

chaîne

Identifie la session qui héberge le média.

supportedMediaCommands

non-null Array of non-null chrome.cast.media.MediaCommand

Commandes multimédias compatibles avec le lecteur multimédia.

videoInfo

(valeur non nulle chrome.cast.media.VideoInformation ou non définie)

Informations sur la vidéo.

volume

Valeur non nulle chrome.cast.Volume

Volume du flux multimédia. volume.level et volume.muted seront toujours réglés.

Méthodes

addUpdateListener

addUpdateListener(listener)

Ajoute un écouteur appelé lorsque l'état du contenu multimédia a changé. Les modifications apportées aux propriétés suivantes déclenchent l'écouteur: currentTime, volume, métadonnées, lectureRate, playerState, customData. Un appel réussi à la méthode getStatus du média déclenche également l'écouteur.

Paramètres
écouteur	function(boolean) Écouteur à ajouter. Le paramètre indique si l'objet Media est toujours actif.

editTracksInfo

editTracksInfo(editTracksInfoRequest, successCallback, errorCallback)

Modifie le style des pistes de texte ou modifie leur état. Si un trackId ne correspond pas aux trackId existants, l'ensemble de la requête échoue et aucun état ne change.

Paramètres
editTracksInfoRequest	chrome.cast.media.EditTracksInfoRequest La valeur ne doit pas être nulle.
successCallback	fonction() Appelé en cas de réussite.
errorCallback	function(non-null chrome.cast.Error) Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

getEstimatedBreakClipTime

getEstimatedBreakClipTime() returns (number or undefined)

Estime la position actuelle de l'extrait de coupure publicitaire en fonction des dernières informations transmises par le récepteur.

Renvoie

(number or undefined) Estimation de la position actuelle de l'extrait de coupure publicitaire, en secondes, depuis le début de la lecture du contenu multimédia. La valeur renvoyée est "indéfinie" si "breakStatus" ou "currentBreakClipTime" ne sont pas définis lorsqu'une coupure publicitaire n'est pas en cours de lecture.

getEstimatedBreakTime

getEstimatedBreakTime() returns (number or undefined)

Estime la position de coupure actuelle en fonction des dernières informations transmises par le récepteur.

Renvoie

(number or undefined) Estimation de la position de coupure actuelle, en secondes, depuis le début de la lecture du contenu multimédia. La valeur renvoyée est "undefined" si "breakStatus" ou "currentBreakTime" ne sont pas définis (lorsqu'une coupure n'est pas en cours de lecture).

getEstimatedLiveSeekableRange

getEstimatedLiveSeekableRange() returns (chrome.cast.media.LiveSeekableRange or undefined)

Estime le début de la valeur liveSeekableRange en secondes en fonction des dernières informations transmises par le récepteur.

Renvoie

(non-null chrome.cast.media.LiveSeekableRange or undefined) Estimation de la valeur liveSeekableRange actuelle. La valeur renvoyée est "undefined" si liveSeekableRange, liveSeekableRange.start ou liveSeekableRange.end ne sont pas définis lorsque le contenu n'est pas en ligne.

getEstimatedTime

getEstimatedTime() renvoie un nombre

Estime la position de lecture actuelle en fonction des dernières informations transmises par le récepteur.

Renvoie

number Estimation de la position de lecture actuelle, en secondes, depuis le début du contenu multimédia.

getStatus

getStatus(getStatusRequest, successCallback, errorCallback)

Récupère l'état de l'élément multimédia à partir de l'application récepteur.

Avec le successCallback donné, tous les écouteurs de mise à jour de médias ajoutés sont également appelés lorsque l'état est reçu de l'application récepteur. Au lieu d'appeler cette méthode pour interroger l'état du contenu multimédia, les applications doivent s'appuyer sur l'appel automatique des écouteurs de mise à jour des médias chaque fois qu'ils changent.

Paramètres
getStatusRequest	chrome.cast.media.GetStatusRequest Requête d'état "get" facultative.
successCallback	fonction() Appelée lorsque l'état est reçu de l'application réceptrice.
errorCallback	function(non-null chrome.cast.Error) Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

mettre en pause

pause(pauseRequest, successCallback, errorCallback)

Met en pause l'élément multimédia.

Paramètres
pauseRequest	chrome.cast.media.PauseRequest
successCallback	fonction() Appelé en cas de réussite.
errorCallback	function(non-null chrome.cast.Error) Appelée en cas d'erreur. Demande de mise en pause du contenu multimédia Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

lecture

play(playRequest, successCallback, errorCallback)

Lit l'élément multimédia.

Paramètres
playRequest	chrome.cast.media.PlayRequest Requête de lecture multimédia facultative.
successCallback	fonction() Appelé en cas de réussite.
errorCallback	function(non-null chrome.cast.Error) Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

queueAppendItem

queueAppendItem(item, successCallback, errorCallback)

Ajoute un nouvel élément multimédia à la fin de la file d'attente.

Paramètres
item	chrome.cast.media.QueueItem Élément à ajouter à la fin de la file d'attente. La valeur ne doit pas être nulle.
successCallback	fonction() Appelé en cas de réussite.
errorCallback	function(non-null chrome.cast.Error) Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

queueInsertItems

queueInsertItems(queueInsertItemsRequest, successCallback, errorCallback)

Insère une liste de nouveaux éléments multimédias dans la file d'attente.

Paramètres
queueInsertItemsRequest	chrome.cast.media.QueueInsertItemsRequest Requête d'insertion d'éléments multimédias dans la file d'attente. La valeur ne doit pas être nulle.
successCallback	fonction() Appelé en cas de réussite.
errorCallback	function(non-null chrome.cast.Error) Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

queueJumpToItem

queueJumpToItem(itemId, successCallback, errorCallback)

Lit l'élément dont l'élément itemId se trouve dans la file d'attente.

Si itemId est introuvable dans la file d'attente, soit parce qu'il n'était pas présent à l'origine, soit parce qu'un autre expéditeur l'a supprimé avant d'appeler cette fonction, celle-ci est renvoyée silencieusement sans envoyer de requête au destinataire.

Paramètres
itemId	number ID de l'élément auquel accéder.
successCallback	fonction() Appelé en cas de réussite.
errorCallback	function(non-null chrome.cast.Error) Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

queueMoveItemToNewIndex

queueMoveItemToNewIndex(itemId, newIndex, successCallback, errorCallback)

Déplace l'élément contenant itemId pour qu'il soit à la position newIndex dans la file d'attente.

Si itemId est introuvable dans la file d'attente, soit parce qu'il n'était pas présent à l'origine, soit parce qu'un autre expéditeur l'a supprimé avant d'appeler cette fonction, celle-ci est renvoyée silencieusement sans envoyer de requête au destinataire.

errorCallback sera invoqué si newIndex est négatif. Toutefois, si newIndex déborde, soit parce qu'il a été spécifié de manière incorrecte, soit parce que la file d'attente a été réduite par un autre expéditeur, l'élément est placé à la fin de la file d'attente.

Paramètres
itemId	number Identifiant de l'élément à déplacer.
newIndex	number Nouvel index de l'élément.
successCallback	fonction() Appelé en cas de réussite.
errorCallback	function(non-null chrome.cast.Error) Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

queueNext

queueNext(successCallback, errorCallback)

Passe à l'élément suivant dans la file d'attente.

Paramètres
successCallback	fonction() Appelé en cas de réussite.
errorCallback	function(non-null chrome.cast.Error) Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

queuePrev

queuePrev(successCallback, errorCallback)

Passe à l'élément précédent dans la file d'attente.

Paramètres
successCallback	fonction() Appelé en cas de réussite.
errorCallback	function(non-null chrome.cast.Error) Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

queueRemoveItem

queueRemoveItem(itemId, successCallback, errorCallback)

Supprime l'élément portant l'identifiant itemId de la file d'attente.

Si itemId est introuvable dans la file d'attente, soit parce qu'il n'était pas présent à l'origine, soit parce qu'un autre expéditeur l'a supprimé avant d'appeler cette fonction, celle-ci est renvoyée silencieusement sans envoyer de requête au destinataire.

Paramètres
itemId	number Identifiant de l'élément à supprimer.
successCallback	fonction() Appelé en cas de réussite.
errorCallback	function(non-null chrome.cast.Error) Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

queueReorderItems

queueReorderItems(queueReorderItemsRequest, successCallback, errorCallback)

Réorganisez la liste des éléments multimédias de la file d'attente.

Paramètres
queueReorderItemsRequest	chrome.cast.media.QueueReorderItemsRequest Requête de réorganisation des éléments de la file d'attente. La valeur ne doit pas être nulle.
successCallback	fonction() Appelé en cas de réussite.
errorCallback	function(non-null chrome.cast.Error) Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

queueSetRepeatMode

queueSetRepeatMode(repeatMode, successCallback, errorCallback)

Définit le mode de répétition de la file d'attente.

Paramètres
repeatMode	chrome.cast.media.RepeatMode Algorithme de sélection de l'élément suivant une fois l'élément en cours terminé. La valeur ne doit pas être nulle.
successCallback	fonction() Appelé en cas de réussite.
errorCallback	function(non-null chrome.cast.Error) Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

queueUpdateItems

queueUpdateItems(queueUpdateItemsRequest, successCallback, errorCallback)

Met à jour les propriétés de la file d'attente multimédia (par exemple, le mode de répétition) et les propriétés des éléments existants dans la file d'attente multimédia.

Paramètres
queueUpdateItemsRequest	chrome.cast.media.QueueUpdateItemsRequest Requête de mise à jour des propriétés de la file d'attente de médias. La valeur ne doit pas être nulle.
successCallback	fonction() Appelé en cas de réussite.
errorCallback	function(non-null chrome.cast.Error) Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

removeUpdateListener

removeUpdateListener(listener)

Supprime un écouteur précédemment ajouté pour ce média.

Paramètres
écouteur	function(boolean) Écouteur à supprimer.

seek

recherche(seekRequest, successCallback, errorCallback)

Recherche l'élément multimédia.

Paramètres
seekRequest	chrome.cast.media.SeekRequest Demande de recherche de contenu multimédia. La valeur ne doit pas être nulle.
successCallback	fonction() Appelé en cas de réussite.
errorCallback	function(non-null chrome.cast.Error) Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

setVolume

setVolume(volumeRequest, successCallback, errorCallback)

Définit le volume du flux multimédia. Vous devez définir au moins l'un des champs volumeRequest.level ou volumeRequest.muted. La modification de l'état de désactivation du son n'a pas d'incidence sur le volume, et inversement.

Paramètres
volumeRequest	chrome.cast.media.VolumeRequest Requête de volume défini. La valeur ne doit pas être nulle.
successCallback	fonction() Appelé en cas de réussite.
errorCallback	function(non-null chrome.cast.Error) Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

escale

stop(stopRequest, successCallback, errorCallback)

Arrête le lecteur multimédia.

Paramètres
stopRequest	chrome.cast.media.StopRequest Requête d'arrêt.
successCallback	fonction() Appelé en cas de réussite.
errorCallback	function(non-null chrome.cast.Error) Appelée en cas d'erreur. Les erreurs possibles sont TIMEOUT, API_NOT_INITIALIZED, INVALID_PARAMETER, CHANNEL_ERROR, SESSION_ERROR et EXTENSION_MISSING.

supportsCommand

supportsCommand(command) renvoie une valeur booléenne

Détermine si le lecteur multimédia prend en charge la commande multimédia donnée.

Paramètres
commande	chrome.cast.media.MediaCommand Commande à interroger. La valeur ne doit pas être nulle.

Renvoie

boolean "True" si le lecteur prend en charge la commande.