Subscribe to custom tags

TVSDK prepares TimedMetadata objects for subscribed tags each time these objects are encountered in the content manifest.

Before the playback starts, you must subscribe to the tags.
To subscribe to tags, assign a vector that contains the custom tag names to the subscribedTags property. If you need to also change the ad tags used by the default opportunity generator, then assign a vector that contains the custom ad tag names to the adTags property.

To be notified about custom tags in HLS manifests:

  1. Set the custom ad tag names globally by assigning a vector that contains the custom tags to subscribeTags in MediaPlayerItemConfig.

    IMPORTANT

    You must include the # prefix when working with HLS streams.

    For example:

    var subscribedTags:Vector.<String> = new Vector.<String>(); 
    subscribedTags.push("#EXT-X-ASSET"); 
    subscribedTags.push("#EXT-X-AD"); 
    PSDKConfig.subscribedTags = subscribedTags;
    
  2. To globally change the ad tags that are used by the default opportunity generator, assign a vector that contains the custom ad tag names to the adTags property in PSDKConfig.

    var adTags:Vector.<String> = new Vector.<String>(); 
    adTags.push("#EXT-X-AD"); 
    PSDKConfig.adTags = adTags; 
    
    
  3. To have all the global settings take effect, replace the current resource.

    player.replaceCurrentResource(mediaResource);
    
  4. To set the subscribed tag names for a stream, if needed:

    1. Create a media player item configuration.

      TIP

      The easiest way is to create a default media player item configuration.

    2. Assign a vector that contains the custom tags to subscribeTags in MediaPlayerItemConfig.

    var mediaPlayerItemConfig:MediaPlayerItemConfig =  
      new DefaultMediaPlayerItemConfig(); 
             
    var subscribedTags:Vector.<String> = new Vector.<String>(); 
    subscribedTags.push("#EXT-X-ASSET"); 
    subscribedTags.push("#EXT-X-AD"); 
    mediaPlayerItemConfig.subscribeTags = subscribedTags;
    
  5. To change the ad tags that are used by the default opportunity generator in the specified stream, assign a vector that contains the custom ad tag names to the adTags property in mediaPlayerItemConfig

    var adTags:Vector.<String> = new Vector.<String>(); 
    adTags.push("#EXT-X-AD"); 
    mediaPlayerItemConfig.adTags = adTags;
    
  6. To have the changes for the stream take effect, when loading the media stream, use the media player item configuration.

    player.replaceCurrentResource(mediaResource, mediaPlayerItemConfig);
    

On this page

Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Summit Banner

A virtual event April 27-28.

Expand your skills and get inspired.

Register for free
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now
Adobe Maker Awards Banner

Time to shine!

Apply now for the 2021 Adobe Experience Maker Awards.

Apply now