Coupures publicitaires

Présentation

Le SDK Web Receiver est compatible de façon native avec les coupures publicitaires et les annonces associées. dans un flux multimédia donné. Elle fournit des API permettant de définir la position de l'annonce, la source de l'annonce et le comportement des coupures publicitaires et de leurs clips associés. Dans ce guide, Break désigne un intervalle de lecture comportant une ou plusieurs annonces ou bumpers, et chaque annonce ou bumper est appelé BreakClip Ces coupures sont associées aux contenus multimédias en cours de chargement ou de lecture.

Types d'annonces

Le SDK Web Receiver prend en charge l'insertion d'annonces côté client (CSAI) d'insertion d'annonces intégrées. Les annonces assemblées par le client peuvent être définies manuellement par application ou extraite des fichiers de modèle VAST et VMAP. Les annonces assemblées au serveur doivent être spécifiées manuellement avant le chargement du contenu, intégrées ou de manière dynamique pendant la lecture du contenu sous forme de annonces développées intégrées annonces. Les implémentations de chacun de ces types d'annonces sont décrites en détail ci-dessous.

assemblage manuel par le client

La coupure publicitaire assemblée manuellement par le client est un type de coupure publicitaire intégrée par le client et est spécifié manuellement par l'application à l'aide de la méthode API SDK. Ce type d'annonce n'est pas intégré au flux du contenu principal. La BreakClip doit fournir le contentId qui renvoie vers le contenu de l'annonce, contentType décrivant le format du contenu de l'annonce title.

Remarque :Dans certains cas, vous devez fournir un format de contenu d'annonce supplémentaire dans le hlsSegmentFormat pour les annonces HLS lues par MPL. Semblable à celui du contenu principal prise en charge des formats de segment cette propriété indique au lecteur le format de conteneur attendu pour les segments d'annonces sous-jacents.

L'élément Break doit avoir isEmbedded et expanded définie sur la valeur par défaut false. La position peuvent être définies sur une coupure publicitaire pré-roll, mid-roll ou post-roll (pour en savoir plus, consultez positionnement des coupures). Lorsque vous préparez le annonce pour la lecture, le SDK Web Receiver génère une autre instance de lecteur à charger et lire le contenu de l'annonce. Ces pauses nécessitent un élément stitched timeline et doivent être ajouté en mode statique (pour en savoir plus, section sur l'insertion d'annonces). L'exemple ci-dessous montre un exemple L'implémentation d'une annonce assemblée manuellement par le client:

// Create the BreakClip.
let clipClient = new cast.framework.messages.BreakClip('bc_client');
clipClient.title = 'The Ad Title to be displayed during playback';
clipClient.contentId = 'https://example.com/ad.m3u8';
clipClient.contentType = 'application/vnd.apple.mpegurl';

// Optional: Used when HLS ad container formats differ from the main content's.
clipClient.hlsSegmentFormat = cast.framework.messages.HlsSegmentFormat.FMP4;

// Create the Break using the BreakClip id above.
let breakPostrollClient = new cast.framework.messages.Break(
    'break_postroll_client', ['bc_client'], -1);
breakPostrollClient.isEmbedded = false; // Optional: default is false.
breakPostrollClient.expanded = false; // Optional: default is false.

VAST

Le SDK Web Receiver accepte l'ajout de la norme VAST (Video Ad Serving modèle). Lorsqu'il est fourni, le modèle XML est analysé pour générer un extrait de coupure publicitaire assemblé par le client suivant lors du début de la coupure.

Pour créer une annonce VAST, l'application réceptrice doit créer un VastAdsRequest et spécifiez-le dans le champ BreakClip. vastAdsRequest . L'objet VastAdsRequest doit avoir le rôle adsResponse (une représentation sous forme de chaîne du modèle XML lui-même) ou adTagUrl (l'URL où le modèle XML est hébergé) est définie. Si l'URL est spécifiée, le Le SDK se chargera de récupérer le modèle. Le Break d'encapsulation suit pour les annonces assemblées par le client. Ces annonces peuvent être ajoutées manuellement assemblées par le client dans la même coupure ou dans des coupures distinctes même élément de contenu. L'exemple ci-dessous montre une implémentation de base d'un tag VAST annonce:

// Create the VastAdsRequest.
let vastTemplate = new cast.framework.messages.VastAdsRequest();
vastTemplate.adTagUrl = 'https://example.com/ads.xml'

// Create the BreakClip.
let clipVast = new cast.framework.messages.BreakClip('bc_vast');
clipVast.vastAdsRequest = vastTemplate;

// Create the Break using the BreakClip id above.
let breakPostrollVast = new cast.framework.messages.Break(
    'break_postroll_vast', ['bc_vast'], -1);
breakPostrollVast.isEmbedded = false; // Optional: default is false.
breakPostrollVast.expanded = false; // Optional: default is false.

Lorsqu'un Break contenant un BreakClip VAST est saisi, le récepteur Web Le SDK pourra éventuellement récupérer, puis analyser le modèle. Lors de l'analyse, le SDK génère un nouveau BreakClip et le renseigne avec les valeurs extraites de le modèle, comme contentId, contentType, title, duration, whenSkippable et clickThroughUrl. Le id pour l'extrait de coupure publicitaire généré est défini sur GENERATED:N, où N est un entier qui incrémente de 1 chaque nouveau Extrait de coupure publicitaire VAST créé à partir de 0. L'annonce générée est ensuite ajoutée le tableau BreakClip. La valeur id de chaque extrait de coupure vidéo VAST dans le fichier Break actuel est remplacé par le id du clip de pause généré correspondant. Les extraits ci-dessous illustrent les changements MEDIA_STATUS concernant les annonces diffusées avant et après une telle pause.

Remarque :Les tableaux BreakClip et Break sont mis à jour et accessibles dans BreakManager Ces informations sont intégrées au MEDIA_STATUS qui est diffusé vers expéditeurs.

Informations Break et BreakClip avant d'ajouter une pause dans les annonces VAST.

"breaks": [
  {
    "id": "break_postroll_vast",
    "breakClipIds": [
      "bc_vast"
    ],
    "position": 0,
    "isWatched": false
  }
],
"breakClips": [
  {
    "id": "bc_vast"
  }
]

Informations Break et BreakClip après une pause dans les annonces VAST

"breaks": [
  {
    "id": "break_postroll_vast",
    "breakClipIds": [
      "GENERATED:0"
    ],
    "position": 0,
    "isWatched": true
  }
],
"breakClips": [
  {
    "id": "bc_vast"
  },
  {
    "id": "GENERATED:0",
    "contentId": "https://example.com/break-clip-1.mpd",
    "contentType": "application/dash+xml",
    "title": "Ad Title Extracted from Template",
    "duration": 10,
    "whenSkippable": 5,
    "clickThroughUrl": "https://example.com/ad-target"
  }
]

VMAP

Le SDK Web Receiver est compatible avec la norme VMAP de l'IAB (Video Multiple Ad Playlists). standard. Lorsqu'un VMAP est fourni, le SDK Web Receiver l'analyse et générer des objets Break assemblés par le client pour tous les <AdBreak> dans la réponse. Il génère également le BreakClips approprié avec un objet vastAdsRequest pour chaque entrée <AdSource> fournie dans le VMAP. À activer la norme VMAP pour insérer des annonces dans votre contenu, l'application doit créer un VastAdsRequest et l'attribuer au vmapAdsRequest de la classe MediaInformation dans LoadRequestData. Ces annonces doivent être insérées en mode statique (pour en savoir plus, consultez les Insertion d'annonces). Vous trouverez ci-dessous un extrait du d'une requête VMAP.

Remarque :Définir manuellement des annonces Break et BreakClip conjointement avec des annonces VMAP ignore la demande d'annonce VMAP. Par conséquent, le SDK supprimera l'annonce VMAP et utilise par défaut les annonces spécifiées manuellement dans les MediaInformation.

// Create the VastAdsRequest.
let vastTemplate = new cast.framework.messages.VastAdsRequest();
vastTemplate.adTagUrl = 'https://example.com/vmap.xml'

// Add it to the MediaInformation of the LoadRequest.
loadRequestData.media.vmapAdsRequest = vastTemplate;

intégrée

La coupure publicitaire intégrée est un type de coupure publicitaire assemblée côté serveur dans le flux du contenu principal. La durée de Break est soustraite à la durée du contenu principal lors du calcul du temps multimédia.

Le BreakClip doit fournir le duration du contenu de l'annonce title L'élément Break doit avoir isEmbedded définie sur true et expanded définie sur false. La position peuvent être définies en tant que coupures publicitaires pré-roll ou mid-roll. Les coupures publicitaires post-roll pris en charge avec des valeurs position exactes positives. Pour en savoir plus, consultez positionnement des coupures. Lorsque l'annonce déclenche le SDK Web Receiver continue la lecture du flux pendant y sont intégrés. Il n'existe pas de mécanisme de chargement supplémentaire pour ce type d'annonce. Les métadonnées pertinentes de l'annonce sont présentées à l'utilisateur une fois que la tête de lecture se trouve dans la la période de coupure. Ces pauses nécessitent un élément embedded timeline et doivent être ajoutées en mode statique (pour en savoir plus, consultez la section Insertion d'annonces). La l'exemple ci-dessous illustre une implémentation de base d'une annonce embedded.

// Create the BreakClip.
let clipEmbedded = new cast.framework.messages.BreakClip('bc_embedded');
clipEmbedded.title = 'The Ad Title to be displayed during playback';
clipEmbedded.duration = 15;

// Create the Break using the BreakClip id above.
let breakPrerollEmbedded = new cast.framework.messages.Break(
    'break_preroll_embedded', ['bc_embedded'], 0);
breakPrerollEmbedded.isEmbedded = true;
breakPrerollEmbedded.expanded = false; // Optional: default is false.

intégrée développée

La coupure publicitaire agrandie intégrée est un type de coupure publicitaire intégrée au serveur dans le flux du contenu principal. La durée de Break est incluse dans la durée du contenu principal lors du calcul du temps multimédia.

Le BreakClip doit fournir le duration du contenu de l'annonce title L'élément Break doit avoir isEmbedded définie sur true et expanded définie sur true. La position peuvent être définies en tant que coupures publicitaires pré-roll ou mid-roll. Les coupures publicitaires post-roll pris en charge avec des valeurs position positives. Pour en savoir plus, consultez positionnement des coupures. Lorsque l'annonce déclenche le SDK Web Receiver continue la lecture du flux pendant y sont intégrés. Il n'existe pas de mécanisme de chargement supplémentaire pour ce type d'annonce. Les métadonnées pertinentes de l'annonce sont présentées à l'utilisateur une fois que la tête de lecture se trouve dans la la période de coupure. Ces pauses nécessitent un élément embedded timeline et peuvent être ajoutées de manière statique ou dynamique (pour en savoir plus, section sur l'insertion d'annonces). L'exemple ci-dessous montre un exemple l'implémentation d'une annonce embedded expanded:

// Create the BreakClip.
let clipEmbeddedExpanded =
    new cast.framework.messages.BreakClip('bc_embedded_expanded');
clipEmbeddedExpanded.title = 'The Ad Title to be displayed during playback';
clipEmbeddedExpanded.duration = 15;

// Create the Break using the BreakClip id above.
let breakPrerollEmbeddedExpanded = new cast.framework.messages.Break(
    'break_preroll_embedded_expanded', ['bc_embedded_expanded'], 0);
breakPrerollEmbeddedExpanded.isEmbedded = true;
breakPrerollEmbeddedExpanded.expanded = true;

Types de timeline du joueur

Lors de la création d'une instance de lecteur, le SDK Web Receiver sélectionne un type de timeline à utiliser prennent en charge la diffusion d'annonces pendant la lecture du contenu. Chaque chronologie active certaines annonces les types de coupures publicitaires à ajouter. Le type de chronologie est déterminé par types d'annonces présents lors du temps de chargement MediaInformation des LoadRequestData. En cas de coupures publicitaires intégrées, la chronologie embedded est sélectionnée. Si des coupures publicitaires assemblées par le client sont présentes, la chronologie stitched est sélectionnée. Si aucune annonce n'est présente, le SDK utilise par défaut embedded calendrier. Une fois la chronologie sélectionnée, vous ne pouvez plus la modifier pour la période actuelle élément multimédia. Le tableau ci-dessous fournit une description détaillée de chaque calendrier.

Type de chronologie	Description
chronologie intégrée	Représentation de l'heure du média qui accepte les annonces qui sont intégrés dans le contenu principal (coupures publicitaires intégrées et étendues intégrées). En cas de coupure publicitaire non agrandie, la durée de celle-ci est soustraite de la durée totale contenus. À l'inverse, lorsqu'une annonce grand format est présent, son heure est considérée comme une fait partie du contenu principal.
chronologie assemblée	Représentation de l'heure du média qui accepte les annonces provenant de fichiers multimédias externes (assemblage manuel du client, VAST et VMAP) les coupures publicitaires). Lors de l'ajout, la durée de la coupure publicitaire est de ne fait pas partie de la durée du contenu principal.

Les figures 1 à 3 ci-dessous illustrent des contenus avec des types d'annonces variés, ainsi que leurs les valeurs de chronologie respectives. Le contenu est configuré avec une coupure pré-roll. contenant deux coupures publicitaires, ainsi que des coupures publicitaires mid-roll et post-roll, avec une seule coupure. Durée d'exécution de l'horloge depuis le début de la lecture du contenu L'heure multimédia du contenu principal et l'heure de la coupure publicitaire sont alignés sous chaque image.

<ph type="x-smartling-placeholder">

</ph> <ph type="x-smartling-placeholder">

</ph> Figure 1: Chronologie représentant certains contenus et ses trois coupures publicitaires intégrées par le client.

<ph type="x-smartling-placeholder">

</ph> <ph type="x-smartling-placeholder">

</ph> Figure 2: Chronologie représentant certains contenus et ses trois coupures publicitaires intégrées assemblées au serveur

<ph type="x-smartling-placeholder">

</ph> <ph type="x-smartling-placeholder">

</ph> Figure 3: Chronologie représentant certains contenus et ses trois coupures publicitaires étendues assemblées au serveur

Positionnement de la coupure

Le SDK Web Receiver permet aux développeurs de spécifier l'emplacement des coupures publicitaires. en paramétrant le paramètre position de Break. Cette valeur correspond à l'heure de lecture du contenu principal et peuvent être utilisées pour créer des coupures publicitaires pre-roll, mid-roll et post-roll. Ils sont définis comme suit:

Position de casse	Description
pré-roll	Coupure publicitaire lue avant le contenu principal. C'est indiqué en définissant breakPosition sur 0
mid-roll	Coupure publicitaire lue au milieu d'un contenu. Cela est représenté par définir breakPosition sur une heure à laquelle la coupure la date de début est postérieure au début du contenu principal ; l'heure de fin de la coupure est inférieure à la fin du contenu principal en temps réel.
annonce vidéo post-roll	Coupure publicitaire lue après le contenu principal. C'est indiqué en définissant breakPosition sur -1 pour chronologies assemblées. Pour les intégrées chronologique breakPosition doit être définie sur la durée du contenu principal, déduite de la durée de la coupure. Non compatible avec le contenu en direct.

Matrice d'interopérabilité

Pour vous faire une idée rapide, nous vous invitons à consulter le Tableau 1 pour obtenir une vue d'ensemble des types d'annonces et des leur compatibilité avec les fonctionnalités liées aux annonces.

<ph type="x-smartling-placeholder">

</ph> Tableau 1: Matrice d'interopérabilité des annonces

Compatibilité des fonctionnalités	annonce assemblée manuellement par le client	VAST	VMAP	annonce intégrée	annonce développée intégrée
compatible avec	VAST	assemblage manuel par le client	N/A	intégrée développée	intégrée
chronologie	cousus	cousus	cousus	intégrée	intégrée
insertion d'annonces	static	static	static	static	statique, dynamique
suppression des annonces
annonce pré-roll
annonce mid-roll
annonce post-roll
ignorer l'annonce
interrompre l'intercepteur de recherche
casser l'intercepteur de chargement des extraits

Événements

Lorsque des coupures de clé se produisent, le SDK Cast envoie des événements de type BreaksEvent Une application réceptrice peut s'y abonner à l'aide de PlayerManager. addEventListener API.

Ces événements peuvent être utilisés à des fins d'analyse et de suivi de la lecture des annonces. Lorsque VMAP (Video Multiple Ad Playlist) et VAST (Video Ad Serving Template) tous les événements de suivi standards fournis dans les réponses sont automatiquement envoyé par le SDK.

Les types d'événements sont répertoriés dans le Tableau 2 avec une description détaillée quand ils sont déclenchés.

<ph type="x-smartling-placeholder">

</ph>

Figure 4: Cycle de vie des événements d'arrêt

<ph type="x-smartling-placeholder">

</ph> Tableau 2: Événements de coupure et description

Événement de pause	Description
BREAK_STARTED	Déclenché lorsque l'heure actuelle du contenu multimédia est égale à la valeur position d'une pause non visionnée.
BREAK_CLIP_LOADING	Déclenché uniquement lorsque le chargement d'un extrait vidéo associé à la chronologie assemblée commence.
BREAK_CLIP_STARTED	Déclenché lorsque la lecture d'un extrait vidéo démarre.
BREAK_CLIP_ENDED	Déclenché à la fin d'un clip d'arrêt. La <ph type="x-smartling-placeholder"></ph> endedReason est renseigné dans les cas suivants: <ph type="x-smartling-placeholder"> </ph> Lecture complète d'un extrait avec coupure de la timeline assemblée. Un extrait de transition de la timeline assemblée fait une transition vers un autre extrait. Les coupures publicitaires sont ignorées. Le dernier clip a été lu entièrement au cours d'une coupure publicitaire intégrée à une vidéo post-roll. Une erreur s'est produite.
BREAK_ENDED	Déclenché à la fin du dernier extrait dans une pause

Insertion d'annonces

Le SDK Cast permet aux applications d'insérer et de supprimer des annonces à différents moments d'une session Cast. Les deux types d'insertion d'annonces sont statiques et dynamiques. Pour insérer des annonces statiques, vous devez spécifier les annonces dans le champ LoadRequestData avant la création du joueur. L'insertion dynamique d'annonces utilise BreakManager addBreak API permettant d'insérer des coupures publicitaires dans le contenu déjà chargé. Chaque type d'insertion est compatible avec certains types d'annonces. Une compatibilité consultez la matrice d'interopérabilité.

Insertion d'annonces statiques

L'insertion statique d'annonces se caractérise par l'ajout des métadonnées d'annonce pertinentes avant à la création de joueurs. Ces informations sont fournies dans le MediaInformation de LoadRequestData. Par exemple, ils peuvent être définis dans le réseau de chargement d'origine, ou il peut être inséré par l'application réceptrice Web en interceptant la requête LOAD. Une fois que LoadRequestData est renvoyé à la Web Receiver SDK pour le traitement, le lecteur est créé. Plus d'infos sur chargement des contenus multimédias. L'exemple ci-dessous montre une annonce assemblée manuellement par le client ajoutée à la requête LOAD intercepteur.

const context = cast.framework.CastReceiverContext.getInstance();
const playerManager = context.getPlayerManager();

playerManager.setMessageInterceptor(
    cast.framework.messages.MessageType.LOAD, loadRequestData => {

  // Create the BreakClip.
  let clipClient = new cast.framework.messages.BreakClip('bc_client');
  clipClient.title = 'The Ad Title to be displayed during playback';
  clipClient.contentId = 'https://example.com/ad.mp4';
  clipClient.contentType = 'video/mp4';

  // Create the Break using the BreakClip id above.
  let breakPostrollClient = new cast.framework.messages.Break(
      'break_postroll_client', ['bc_client'], -1);

  // Set the ad information in the load request data.
  let media = loadRequestData.media;
  media.breakClips = [clipClient];
  media.breaks = [breakPostrollClient];

  return loadRequestData;
});

Insertion dynamique d'annonce

L'insertion dynamique d'annonces consiste à insérer une coupure publicitaire pendant la lecture du contenu lecture. Pour ce faire, il faut obtenir une instance de BreakManager et appeler la addBreak API. Cela nécessite au moins deux paramètres : intégrée développée Break et un tableau de BreakClip. Une troisième propriété facultative est incluse pour forcer l'envoi des modifications à expéditeurs connectés via une diffusion MediaStatus lorsqu'ils sont définis sur true. Quand ? l'ajout de coupures publicitaires et d'extraits, les ID correspondants doivent être uniques. Ces annonces ne peuvent être ajoutés qu'une fois le lecteur créé. Le SDK Web Receiver se déclenche la PLAYER_LOADING une fois le lecteur créé. L'exemple ci-dessous montre l'utilisation dans Un gestionnaire d'événements qui répond aux modifications apportées aux métadonnées ID3 d'un flux crée des objets Break et BreakClip pour l'insérer dans la timeline.

const context = cast.framework.CastReceiverContext.getInstance();
const playerManager = context.getPlayerManager();
const breakManager = playerManager.getBreakManager();

playerManager.addEventListener(cast.framework.events.EventType.ID3, (event) => {

  // Create the BreakClip.
  let clipEmbeddedExpanded = parseBreakClipFromData(event.segmentData);
  let breakEmbeddedExpanded = parseExpandedBreakFromData(event.segmentData);

  // Add the break and break clip.
  breakManager.addBreak(breakEmbeddedExpanded, [clipEmbeddedExpanded]);
});

Suppression d'annonces dynamiques

Pour supprimer les coupures dynamiques, l'application doit appeler removeBreakById pendant la lecture. La fonction utilise un identifiant de chaîne de la coupure supprimé de la chronologie. L'élément breakId spécifié doit pointer vers un élément intégré la coupure publicitaire agrandie. Si un autre type de coupure publicitaire est détecté, la coupure restent dans la chronologie. Consultez l'exemple ci-dessous pour éviter de faire une pause.

const context = cast.framework.CastReceiverContext.getInstance();
const playerManager = context.getPlayerManager();
const breakManager = playerManager.getBreakManager();

breakManager.removeBreakById('break_midroll_embedded_expanded');

Comportement des coupures publicitaires

Le SDK définit un comportement par défaut lorsque le joueur apparaît dans les pauses ou en sort. et permet de le personnaliser davantage à l'aide de certaines des API fournies dans BreakManager

Comportement par défaut des coupures publicitaires

Lorsqu'un Break est saisi lors d'une lecture normale ou en recherchant un Break, le SDK évalue si l'utilisateur l'a déjà vue en vérifiant la isWatched . Une fois créée, la valeur par défaut d'un saut pour cette propriété est false. Si la propriété est true, le saut n'est pas lu lorsque la propriété est saisie et main la lecture du contenu se poursuivra. Si la propriété est false, le saut de ligne est lu lorsque vous y avez accédé.

Remarque :Pour les coupures publicitaires avec chronologie intégrée, le SDK recherche la durée d'un utilisateur a regardé une pause pour reprendre la lecture du contenu principal.

Lorsque vous recherchez d'anciennes coupures publicitaires, l'implémentation par défaut obtient toutes les Break éléments dont position est compris entre seekFrom et seekTo valeurs. À partir de cette liste de coupures, le SDK lit les Break dont le position est la plus proche de la valeur seekTo et dont la propriété isWatched est définie sur false La propriété isWatched de cette coupure est alors définie sur true et le lecteur commence à lire les extraits vidéo. Une fois la pause regardée, le contenu principal reprendra la lecture à partir de la position seekTo. Si aucune s'affiche, la lecture du contenu principal est interrompue, et le contenu principal est réactivé. en cours de lecture en position seekTo.

Pendant la lecture des interruptions, le SDK diffusera toutes les mises à jour pertinentes aux applications émettrices du MediaStatus Ces applications utiliseront les annonces pour mettre à jour leur UI pour les annonces en lisant la breakStatus . Cette propriété n'est définie que lors de l'interruption de la lecture.

Remarque :Les applications réceptrices peuvent s'abonner à PlayerManager. MEDIA_STATUS pour surveiller les modifications apportées à MediaStatus.

Les applications réceptrices peuvent également interroger directement les informations concernant position de la tête de lecture par rapport à l'heure actuelle de l'élément BreakClip affiché en appelant PlayerManager getBreakClipCurrentTimeSec De même, les applications peuvent interroger la durée du BreakClip actuel en Appel en cours getBreakClipDurationSec

Comportement des coupures personnalisées

Le comportement par défaut pour les coupures publicitaires peuvent être modifiées à l'aide de la setBreakClipLoadInterceptor et setBreakSeekInterceptor fournies dans BreakManager.

Remarque :Si vous effectuez une opération de recherche après la fin d'une coupure, assurez-vous que la propriété playerState de MediaStatus a été remplacé par PLAYING avant d'effectuer l'opération de recherche.

Intercepteur de recherche de rupture

L'intercepteur de recherche de pause permet à l'appli de contrôler le comportement de la recherche avant les coupures publicitaires. La fonction est déclenchée lorsqu'une opération de recherche est demandée pour avancer ou reculer sur une ou plusieurs coupures. Lorsqu'elle est appelée, la méthode BreakSeekData est transmise en tant que paramètre à la fonction de rappel. L'objet BreakSeekData contient un tableau de Break objets dont la propriété position est définie sur un nombre compris entre la durée de la tête de lecture est définie comme seekFrom et l'heure de la destination de la recherche seekTo

Cet intercepteur autorise les objets Break dans les coupures respectives d'être modifiées. Une fois implémenté, cet intercepteur doit spécifier l'annonce se lance en renvoyant un objet BreakSeekData modifié en option. La le joueur lit toutes les coupures incluses dans la valeur renvoyée. Si une valeur de null ou rien n'est renvoyé par l'intercepteur de recherche de pauses, la rupture est ont été ignorées.

Remarque :La définition de l'intercepteur de recherche de saut de page remplace le comportement par défaut. Ce inclut des fonctionnalités permettant par exemple d'ignorer les pauses que vous avez déjà regardées. Pour personnaliser interrompre la recherche et ne pas lire les pauses visionnées, l'application doit spécifier cette logique dans l'intercepteur de recherche de pause en vérifiant le isWatched d'un Break. Le SDK se chargera de définir la propriété isWatched lorsque une pause est introduite quelle que soit l'utilisation de l'intercepteur du point de recherche.

L'exemple ci-dessous présente une implémentation simple de l'intercepteur remplace le comportement par défaut pour regarder toutes les coupures publicitaires recherchées avec la à l'exception des coupures publicitaires déjà visionnées.

const context = cast.framework.CastReceiverContext.getInstance();
const playerManager = context.getPlayerManager();
const breakManager = playerManager.getBreakManager();

breakManager.setBreakSeekInterceptor((breakSeekData) => {

  // Filter the breaks array by removing watched breaks.
  const unwatchedBreaks =
      breakSeekData.breaks.filter(adBreak => !adBreak.isWatched);
  breakSeekData.breaks = unwatchedBreaks;

  return breakSeekData;
});

Intercepteur de chargement des extraits

Vous pouvez modifier un objet BreakClip à l'aide de l'intercepteur de chargement des extraits avant le début de la lecture.

L'intercepteur de chargement des extraits vidéo n'est appelé que pour un saut dans la chronologie assemblée et peuvent être définis à l'aide setBreakClipLoadInterceptor Avant d'entrer dans un Break, cet intercepteur est appelé une fois pour chaque personne BreakClip défini dans cette coupure. Le SDK transmet l'original BreakClip comme paramètre de la fonction de rappel. L'application peut alors modifier ce BreakClip et le renvoyer afin que le SDK puisse récupérer et afficher la coupure avec la configuration mise à jour. Si la valeur null ou rien n'est renvoyée, le saut de ligne l'extrait est passé.

Remarque :En cas d'interruption d'une annonce vidéo pré-roll, l'intercepteur de chargement des extraits vidéo est appelé. pour la coupure publicitaire pré-roll dès le début de la lecture. Immédiatement après la une coupure pré-roll, l'intercepteur de chargement du clip pour la prochaine coupure est appelé s'il existe.

Vous trouverez ci-dessous un exemple qui modifie le contentUrl des coupures publicitaires avec Une fonction utilitaire appelle getUrlFromClipId, où le id de BreakClip est mappée à une URL.

const context = cast.framework.CastReceiverContext.getInstance();
const playerManager = context.getPlayerManager();
const breakManager = playerManager.getBreakManager();

breakManager.setBreakClipLoadInterceptor(
    (breakClip, breakClipLoadInterceptorContext) => {

  // Obtains the URL of a break clip id from a function call.
  breakClip.contentUrl = getUrlFromClipId(breakClip.id);

  return breakClip;
});

Omission de l'annonce

Le SDK Web Receiver fournit des API permettant d'ignorer les coupures publicitaires et les coupures publicitaires individuelles pendant une coupure publicitaire. Le SDK permet également aux utilisateurs d'ignorer interagissant avec leurs applications émettrices ou leurs écrans connectés.

Extraits de coupures désactivables par l'utilisateur

Définir des coupures publicitaires comme désactivables permet aux utilisateurs d'interagir avec l'expéditeur connecté et les écrans connectés pour pouvoir ignorer le reste d'une l'extrait d'arrêt en cours de lecture. Définir le paramètre whenSkippable sur un nombre non négatif de secondes permet d'activer la fonctionnalité BreakClip. Le lecteur considère que l'extrait de la coupure est désactivable une fois que d'arrêt a été lu pendant ce nombre de secondes. Définir cette valeur sur 0 permet aux utilisateurs d'ignorer immédiatement l'extrait vidéo.

// Create the BreakClip.
let clip = new cast.framework.messages.BreakClip('bc');
clip.title = 'The Ad Title to be displayed during playback';
clip.whenSkippable = 10; // Users can skip the clip after 10 seconds of playback.

Ces informations peuvent être définies dans la requête de chargement initiale de l'expéditeur ou dans la application réceptrice. Extrait d'une coupure publicitaire dans une coupure publicitaire de la chronologie assemblée s'il est ignoré arrêtera la lecture de l'extrait actuel. Le lecteur charge soit casser l'extrait s'il est présent ou charger le contenu principal. Lorsqu'il est ignoré, un extrait vidéo faisant une pause dans une la coupure publicitaire chronologie intégrée recherche la fin de l'extrait et pour poursuivre la lecture du flux à ce stade.

Remarque :En plus d'implémenter l'extrait ci-dessus, les applications Web Sender ajouter request logic pour permettre à l'utilisateur d'ignorer une annonce. Cela n'est pas nécessaire sur les plates-formes d'envoi mobile, car la fonctionnalité est fournie par le SDK.

Ignorer les annonces à l'aide d'un programme

Les annonces peuvent également être ignorées automatiquement sans aucune intervention de l'utilisateur.

Pour ignorer une pause complète de la lecture, une application doit définir le paramètre isWatched d'un Break à true. Cette opération peut être effectuée à tout moment pendant le chargement la séquence ou la lecture de contenu. La propriété isWatched est évaluée par la joueur lorsque la valeur position d'une pause est atteinte dans l'heure actuelle du contenu principal. À À ce stade, le joueur détermine s'il convient ou non de faire une pause. Reportez-vous à l'exemple ci-dessous, qui parcourt toutes les coupures et modifie le lors du chargement du lecteur.

const context = cast.framework.CastReceiverContext.getInstance();
const playerManager = context.getPlayerManager();
const breakManager = playerManager.getBreakManager();

playerManager.addEventListener(cast.framework.events.EventType.PLAYER_LOADING,
    (event) => {

  // Obtain the breaks and iterate through each item to skip all ad breaks.
  let breaks = breakManager.getBreaks();
  breaks.forEach((brk) => {
    brk.isWatched = true;
  });
});

Pour ignorer un extrait vidéo spécifique de manière programmatique, Utilisez l'intercepteur de chargement des extraits. Par renvoie null ou ne renvoie pas de valeur dans la fonction de rappel, l'extrait cette coupure est ignorée.

Remarque :L'intercepteur de chargement d'extrait de coupure n'est appelé que pour la chronologie assemblée et les pauses. Si vous souhaitez ignorer des coupures publicitaires dans une chronologie intégrée, consultez suppression des annonces dynamiques.

const context = cast.framework.CastReceiverContext.getInstance();
const playerManager = context.getPlayerManager();
const breakManager = playerManager.getBreakManager();

breakManager.setBreakClipLoadInterceptor(
      (breakClip, breakClipLoadInterceptorContext) => {
  return null;
});