Coupures publicitaires
Le SDK Web Sender est compatible avec les pauses publicitaires et les annonces associées dans un flux multimédia donné.
Pour en savoir plus sur le fonctionnement des pauses publicitaires, consultez la présentation des pauses publicitaires Web Receiver.
Bien que les pauses puissent être spécifiées à la fois sur l'émetteur et le récepteur, il est recommandé de les spécifier sur le Web Receiver et le récepteur Android TV pour maintenir un comportement cohérent sur toutes les plates-formes.
Sur le Web, spécifiez les coupures publicitaires dans une commande de chargement à l'aide de BreakClip
et Break
:
let breakClip1 = new BreakClip('bc0');
breakClip1.title = 'Clip title'
breakClip1.posterUrl = 'https://www.some.url';
breakClip1.duration = 60;
breakClip.whenSKippable = 5;
let breakClip2 = ...
let breakClip3 = ...
let break1 = new Break('b0', ['bc0', 'bc1', 'bc2'], 10);
let mediaInfo = new chrome.cast.media.MediaInfo(<contentId>, '<contentType');
...
mediaInfo.breakClips = [breakClip1, breakClip2, breakClip3];
mediaInfo.breaks = [break1];
let request = new chrome.cast.media.LoadRequest(mediaInfo);
cast.framework.CastContext.getInstance().getCurrentSession().loadMedia(request)
Utiliser les API Tracks
Une piste peut être un objet texte (sous-titre ou légende), ou un objet de flux audio ou vidéo. Les API Tracks vous permettent d'utiliser ces objets dans votre application.
Un objet Track
représente une piste dans le SDK. Vous pouvez configurer une piste et lui attribuer un ID unique comme suit :
var englishSubtitle = new chrome.cast.media.Track(1, // track ID
chrome.cast.media.TrackType.TEXT);
englishSubtitle.trackContentId = 'https://some-url/caption_en.vtt';
englishSubtitle.trackContentType = 'text/vtt';
englishSubtitle.subtype = chrome.cast.media.TextTrackType.SUBTITLES;
englishSubtitle.name = 'English Subtitles';
englishSubtitle.language = 'en-US';
englishSubtitle.customData = null;
var frenchSubtitle = new chrome.cast.media.Track(2, // track ID
chrome.cast.media.TrackType.TEXT);
frenchSubtitle.trackContentId = 'https://some-url/caption_fr.vtt';
frenchSubtitle.trackContentType = 'text/vtt';
frenchSubtitle.subtype = chrome.cast.media.TextTrackType.SUBTITLES;
frenchSubtitle.name = 'French Subtitles';
frenchSubtitle.language = 'fr';
frenchSubtitle.customData = null;
var frenchAudio = new chrome.cast.media.Track(3, // track ID
chrome.cast.media.TrackType.AUDIO);
frenchAudio.trackContentId = 'trk0001';
frenchAudio.trackContentType = 'audio/mp3';
frenchAudio.subtype = null;
frenchAudio.name = 'French Audio';
frenchAudio.language = 'fr';
frenchAudio.customData = null;
Un élément multimédia peut comporter plusieurs pistes. Par exemple, il peut comporter plusieurs sous-titres (chacun dans une langue différente) ou plusieurs flux audio alternatifs (pour différentes langues).
MediaInfo
est la classe qui modélise un élément multimédia. Pour associer une collection d'objets Track
à un élément multimédia, vous devez mettre à jour sa propriété tracks
. Cette association doit être établie avant que le contenu multimédia ne soit chargé sur le récepteur :
var tracks = [englishSubtitle, frenchSubtitle, frenchAudio];
var mediaInfo = new chrome.cast.media.MediaInfo(mediaURL);
mediaInfo.contentType = 'video/mp4';
mediaInfo.metadata = new chrome.cast.media.GenericMediaMetadata();
mediaInfo.customData = null;
mediaInfo.streamType = chrome.cast.media.StreamType.BUFFERED;
mediaInfo.textTrackStyle = new chrome.cast.media.TextTrackStyle();
mediaInfo.duration = null;
mediaInfo.tracks = tracks;
Vous pouvez définir les pistes actives dans la requête média activeTrackIds
.
Vous pouvez également activer une ou plusieurs pistes associées à l'élément multimédia après le chargement du contenu multimédia en appelant EditTracksInfoRequest(opt_activeTrackIds, opt_textTrackStyle)
et en transmettant les ID des pistes à activer dans opt_activeTrackIds
. Notez que les deux paramètres sont facultatifs et que vous pouvez choisir les pistes ou les styles actifs à définir à votre discrétion. Par exemple, voici comment activer les sous-titres en français (2
) et l'audio en français (3
) :
var activeTrackIds = [2, 3];
var tracksInfoRequest = new chrome.cast.media.EditTracksInfoRequest(activeTrackIds);
media.editTracksInfo(tracksInfoRequest, successCallback, errorCallback);
Pour supprimer toutes les pistes audio ou vidéo du contenu multimédia actuel, définissez simplement mediaInfo.tracks=null
(un tableau vide) et rechargez le contenu multimédia.
Pour supprimer toutes les pistes de texte du contenu multimédia actuel (par exemple, pour désactiver les sous-titres), procédez comme suit :
- Mettez à jour
var activeTrackIds = [2, 3];
(affiché précédemment) pour qu'il n'inclue que [3], la piste audio. - Définissez
mediaInfo.tracks=null
. Notez qu'il n'est pas nécessaire de recharger le contenu multimédia pour désactiver les sous-titres (track.hidden
). L'envoi d'un tableauactiveTracksId
qui ne contient pas detrackId
précédemment activé désactive la piste de texte.
Appliquer un style aux pistes de texte
TextTrackStyle
est l'objet qui encapsule les informations de style d'une piste de texte. Après avoir créé ou mis à jour un objet TextTrackStyle
existant, vous pouvez l'appliquer à l'élément multimédia en cours de lecture en appelant sa méthode editTrackInfo
, comme suit :
var textTrackStyle = new chrome.cast.media.TextTrackStyle();
var tracksInfoRequest = new chrome.cast.media.EditTracksInfoRequest(textTrackStyle);
media.editTracksInfo(tracksInfoRequest, successCallback, errorCallback);
Vous pouvez suivre l'état de la requête avec le résultat des rappels (succès ou erreur) et mettre à jour l'expéditeur d'origine en conséquence.
Les applications doivent permettre aux utilisateurs de modifier le style des pistes de texte, soit à l'aide des paramètres fournis par le système, soit par l'application elle-même.
Vous pouvez personnaliser les éléments de style suivants des pistes de texte :
- Couleur et opacité du premier plan (texte)
- Couleur et opacité de l'arrière-plan
- Type de contour
- Couleur du bord
- Mise à l'échelle de la police
- Famille de polices
- Style de police
Par exemple, définissez la couleur du texte sur rouge avec une opacité de 75 % comme suit :
var textTrackStyle = new chrome.cast.media.TextTrackStyle();
textTrackStyle.foregroundColor = '#80FF0000';
Réglage du volume
Vous pouvez utiliser RemotePlayer
et RemotePlayerController
pour définir le volume du récepteur.
function changeVolume(newVolume) {
player.volumeLevel = newVolume;
playerController.setVolumeLevel();
// Update sender UI to reflect change
}
L'application émettrice doit respecter les consignes suivantes pour contrôler le volume :
- L'application émettrice doit se synchroniser avec le récepteur afin que l'UI de l'émetteur indique toujours le volume défini sur le récepteur. Utilisez les rappels
RemotePlayerEventType.VOLUME_LEVEL_CHANGED
etRemotePlayerEventType.IS_MUTED_CHANGED
pour maintenir le volume sur l'expéditeur. Pour en savoir plus, consultez Mises à jour de l'état. - Les applications émettrices ne doivent pas définir le niveau de volume sur un niveau spécifique prédéfini ni sur le volume de la sonnerie/du contenu multimédia de l'appareil émetteur lorsque l'application se charge sur le récepteur.
Consultez Contrôles du volume de l'expéditeur dans la Checklist de conception.
Envoyer des messages multimédias au destinataire
Media Messages
peut être envoyé de l'expéditeur au destinataire. Par exemple, pour envoyer un message SKIP_AD
au destinataire :
// Get a handle to the skip button element
const skipButton = document.getElementById('skip');
skipButton.addEventListener("click", function() {
if (castSession) {
const media = castSession.getMediaSession();
castSession.sendMessage('urn:x-cast:com.google.cast.media', {
type: 'SKIP_AD',
requestId: 1,
mediaSessionId: media.mediaSessionId
});
}
});
Informations sur votre actualité
Lorsque plusieurs expéditeurs sont connectés au même récepteur, il est important que chaque expéditeur soit informé des modifications apportées au récepteur, même si elles ont été initiées par d'autres expéditeurs.
Pour ce faire, votre application doit enregistrer tous les écouteurs nécessaires sur RemotePlayerController
.
Si le
TextTrackStyle
du contenu multimédia actuel change, tous les expéditeurs connectés seront avertis et les propriétés correspondantes de la session multimédia actuelle, telles que activeTrackIds
et textTrackStyle
du champ MediaInfo
, seront envoyées aux expéditeurs dans les rappels. Dans ce cas, le SDK Receiver ne vérifie pas si le nouveau style est différent de l'ancien et envoie une notification à tous les expéditeurs connectés, quoi qu'il arrive.
Indicateur de progression
L'affichage de la position de lecture avec un indicateur de progression sur l'expéditeur est une exigence pour la plupart des applications. Les API Cast utilisent le protocole Cast Media, qui optimise la consommation de bande passante pour ce scénario et d'autres. Vous n'avez donc pas besoin d'implémenter votre propre synchronisation d'état. Pour implémenter correctement un indicateur de progression pour la lecture de contenus multimédias à l'aide des API, consultez l'application exemple CastVideos-chrome.
Exigences CORS
Pour le streaming multimédia adaptatif, Google Cast exige la présence d'en-têtes CORS. Toutefois, même les flux multimédias mp4 simples nécessitent CORS s'ils incluent des pistes. Si vous souhaitez activer les pistes pour un contenu multimédia, vous devez activer CORS pour vos flux de pistes et vos flux multimédias. Par conséquent, si vous n'avez pas d'en-têtes CORS disponibles pour votre contenu multimédia mp4 simple sur votre serveur et que vous ajoutez ensuite une piste de sous-titres simple, vous ne pourrez pas diffuser votre contenu multimédia en streaming, sauf si vous mettez à jour votre serveur pour inclure les en-têtes CORS appropriés.
Vous avez besoin des en-têtes suivants : Content-Type
, Accept-Encoding
et Range
.
Notez que les deux derniers en-têtes, Accept-Encoding
et Range
, sont des en-têtes supplémentaires dont vous n'aviez peut-être pas besoin auparavant.
Les caractères génériques "*" ne peuvent pas être utilisés pour l'en-tête Access-Control-Allow-Origin
. Si la page contient du contenu multimédia protégé, elle doit utiliser un domaine au lieu d'un caractère générique.
Reprendre une session sans recharger la page Web
Pour reprendre un CastSession
existant, utilisez requestSessionById(sessionId)
avec le sessionId
de la session à laquelle vous essayez de participer.
Le sessionId
se trouve sur le CastSession
actif à l'aide de getSessionId()
après avoir appelé loadMedia()
.
L'approche recommandée est la suivante :
- Appelez
loadMedia()
pour démarrer la session - Stocker
sessionId
en local - Rejoindre à nouveau la session à l'aide de
requestSessionById(sessionId)
si nécessaire
let sessionId;
function rejoinCastSession() {
chrome.cast.requestSessionById(sessionId);
// Add any business logic to load new content or only resume the session
}
document.getElementById('play-button').addEventListener(("click"), function() {
if (sessionId == null) {
let castSession = cast.framework.CastContext.getInstance().getCurrentSession();
if (castSession) {
let mediaInfo = createMediaInfo();
let request = new chrome.cast.media.LoadRequest(mediaInfo);
castSession.loadMedia(request)
sessionId = CastSession.getSessionId();
} else {
console.log("Error: Attempting to play media without a Cast Session");
}
} else {
rejoinCastSession();
}
});
Étapes suivantes
Vous avez terminé d'ajouter des fonctionnalités à votre application Web Sender. Vous pouvez maintenant créer une application émettrice pour une autre plate-forme (Android ou iOS) ou créer une application réceptrice.