StreamLayer References

For how to enable StreamLayer with streamLayerSetting and per-video streamLayer metadata, see StreamLayer Integration.

StreamLayer component properties

Property	Source	Description
eventId	Video metadata streamLayer.eventID	StreamLayer event ID for the current video.
vastUrl	Video metadata streamLayer.vastURL	VAST URL for the current video (ad creatives). Use this or streamLayerExternalUrlProvider, not both.
streamLayerExternalUrlProvider	Player config	Optional function that returns an external URL for StreamLayer based on the current video metadata. Use this or streamLayer.vastURL, not both.
streamLayerSetting	setting.streamLayerSetting	Object with showingDelay, isEnable, sdkKey.

caution

Use either the per-video streamLayer.vastURL metadata or the streamLayerExternalUrlProvider player config to source the StreamLayer content URL — do not use both together.

TypeScript interfaces

streamLayerSetting shape:

interface StreamLayerSetting {
  sdkKey: string;         // SDK key for the StreamLayer service.
  isEnable?: boolean;     // When true, StreamLayer is enabled. Default: disabled.
  showingDelay?: number;  // Delay in ms before showing the pause ad. Default: 0.
}

streamLayer shape returned from videoMetadataProvider:

streamLayer: {
  eventID: string;  // StreamLayer event ID for this video.
}

streamLayerExternalUrlProvider shape (optional player config function):

/**
 * Provides an external URL for StreamLayer based on the video metadata.
 * This can be used to dynamically set the URL for the StreamLayer content.
 */
streamLayerExternalUrlProvider?: (
  videoMetadata: VideoMetadataClean
) => string | undefined | Promise<string | undefined>;

Packages and imports

• Web: @deltatre-vxp/diva-sdk/diva-web-sdk for the player; @deltatre-vxp/diva-sdk/diva-web-streamlayer-plugin for StreamLayer.
• WebTV: @deltatre-vxp/diva-sdk/diva-webtv-sdk for the player; @deltatre-vxp/diva-sdk/diva-web-streamlayer-plugin for StreamLayer.