Class: VideoStitcherLiveStreamRequest

Constructor

VideoStitcherLiveStreamRequest

new VideoStitcherLiveStreamRequest(podStreamRequest)

Parameter

podStreamRequest

Optional

object that already has stream request properties assigned.

Value may be null.

Extends
PodStreamRequest

Properties

adTagParameters

unknown

You can override a limited set of ad tag parameters on your stream request. Values added must be strings. Supply targeting parameters to your stream provides more information. You can use the dai-ot and dai-ov parameters for stream variant preference. See Override Stream Variant Parameters for more information.

Inherited from
StreamRequest#adTagParameters

apiKey

unknown

The stream request API key. It's configured through the DFP Admin UI and provided to the publisher to unlock their content. It verifies the applications that are attempting to access the content.

Inherited from
StreamRequest#apiKey

authToken

unknown

The stream request authorization token. Used in place of the API key for stricter content authorization. The publisher can control individual content streams authorizations based on this token.

Inherited from
StreamRequest#authToken

customAssetKey

unknown

The custom asset key is used to determine which stream should be played. Custom asset keys are required for pod serving stream requests.

Inherited from
PodStreamRequest#customAssetKey

format

unknown

The stream format to request. Accepts the following string values:

  • hls (default)
  • dash
Inherited from
StreamRequest#format

liveStreamEventId

string

The Event ID for the live stream, as setup on the Video Stitcher.

networkCode

unknown

The network code for the publisher making this stream request. Network codes are required for pod serving stream requests.

Inherited from
PodStreamRequest#networkCode

oAuthToken

string

The OAuthToken to use for the Video Stitcher.

omidAccessModeRules

unknown

Settings object for mapping verification vendors to OMID Access Modes. Verification script URLs are internally matched against vendor provided regular expressions to resolve to an OmidVerificationVendor key. IMA then looks up the access mode for the given vendor using this object.

For script URLs that don't resolve to a known vendor, or if the resolved OmidVerificationVendor is not provided in this object, IMA will use the access mode provided for OmidVerificationVendor.OTHER. If OmidVerificationVendor.OTHER is not provided, then the LIMITED access mode will be used.

Inherited from
StreamRequest#omidAccessModeRules

projectNumber

string

The project number for the Video Stitcher.

region

string

The region to use for the Video Stitcher.

streamActivityMonitorId

unknown

The ID to be used to debug the stream with the stream activity monitor. This is used to provide a convenient way to allow publishers to find a stream log in the stream activity monitor tool.

Inherited from
StreamRequest#streamActivityMonitorId

videoStitcherSessionOptions

nullable Object with any type properties

The session options are used to set Video Stitcher-specific parameters for this Video Stitcher stream request.