Class VideoStitcherLiveStreamRequest

Extends PodStreamRequest
A class for specifying properties of the video stitcher live stream request.
Constructors
constructor
Properties
adTagParameters
You can override a limited set of ad tag parameters on your stream request.
apiKey
The stream request API key.
authToken
The stream request authorization token.
customAssetKey
The custom asset key to determine which stream to play.
enableNonce
Enables the addition of a nonce to the request.
format
The stream format to request.
liveStreamEventId
The event ID for the live stream set up in your Video Stitcher.
networkCode
The stream request network code.
oAuthToken
The OAuthToken to use for your Video Stitcher.
omidAccessModeRules
Settings object for mapping verification vendors to OMID Access Modes.
projectNumber
The project number for your Video Stitcher.
region
The region to use for your Video Stitcher.
streamActivityMonitorId
The ID to be used to troubleshoot the stream with the stream activity monitor.
videoStitcherSessionOptions
The session options set Video Stitcher-specific parameters for this Video Stitcher stream request.

Constructors

constructor

new VideoStitcherLiveStreamRequest(): VideoStitcherLiveStreamRequest

Properties

adTagParameters

adTagParameters: {
  [key: string]: string;
}
You can override a limited set of ad tag parameters on your stream request. Values added must be strings. For details, see Supply targeting parameters to your stream. You can use the dai-ot and dai-ov parameters for stream variant preference. For details, see Override Stream Variant Parameters.

apiKey

apiKey: string
The stream request API key. Configure your stream API key in the Google Ad Manager UI. For details, see Authenticate DAI video stream requests. Using the API key authenticates applications that attempt to access the stream.

authToken

authToken: string
The stream request authorization token. Used in place of the API key for more secure content authorization. You can control individual content streams authorizations based on this token.

customAssetKey

customAssetKey: string
The custom asset key to determine which stream to play. Custom asset keys are required for pod serving stream requests.

enableNonce

enableNonce: boolean
Enables the addition of a nonce to the request. You must set this parameter to transmit monetization signals to Google servers when you request ads server side from a third-party server. Defaults to a false value.

format

format: StreamFormat
The stream format to request. Accepts the following string values:
  • hls (default)
  • dash

liveStreamEventId

liveStreamEventId: string
The event ID for the live stream set up in your Video Stitcher.

networkCode

networkCode: string
The stream request network code. To find the network code, see Find Google Ad Manager account information.

oAuthToken

oAuthToken: string
The OAuthToken to use for your Video Stitcher.

omidAccessModeRules

omidAccessModeRules: {
  [key: string]: OmidAccessMode;
}
Settings object for mapping verification vendors to OMID Access Modes. The keys must be values from the OmidVerificationVendor enum, and the values must be values from the OmidAccessMode enum.

projectNumber

projectNumber: string
The project number for your Video Stitcher.

region

region: string
The region to use for your Video Stitcher.

streamActivityMonitorId

streamActivityMonitorId: string
The ID to be used to troubleshoot the stream with the stream activity monitor. Use this ID to find a stream log in the stream activity monitor tool.

videoStitcherSessionOptions

videoStitcherSessionOptions: {
  [key: string]: unknown;
}
The session options set Video Stitcher-specific parameters for this Video Stitcher stream request.