LiveStreamRequest
A class for specifying properties of the live stream request.
Constructor
LiveStreamRequest
new LiveStreamRequest()
- Extends
- StreamRequest
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
assetKey
string
This is used to determine which stream should be played. The live stream request asset key is an identifier which can be found in the DFP UI.
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
consentSettings
unknown
Settings related to regulations and consent.
- Inherited from
- StreamRequest#consentSettings
format
unknown
The stream format to request. Accepts the following string values:
hls(default)dash
- Inherited from
- StreamRequest#format
senderCanSkip
unknown
Whether or not the sender(s) display a CAF skip UI to the end user. Used to enable skippable ads.
- Inherited from
- StreamRequest#senderCanSkip
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