IMAStreamRequest Class Reference

IMAStreamRequest Class Reference

Overview

Data class describing the stream request.

Inheritance diagram for IMAStreamRequest:
IMALiveStreamRequest IMAVODStreamRequest

Properties

NSString * apiKey
 The stream request API key. More...
 
NSString * streamActivityMonitorID
 The ID to be used to debug the stream with the stream activity monitor. More...
 
NSDictionary< NSString
*, NSString * > * 
adTagParameters
 You can override a limited set of ad tag parameters on your stream request. More...
 
NSString * manifestURLSuffix
 The suffix that the SDK will append to the query of the stream manifest URL. More...
 
NSTimeInterval initializationTimeout
 Override for the default stream initialization timeout. More...
 

Property Documentation

- (NSString*) apiKey
readwritenonatomiccopy

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.

- (NSString*) streamActivityMonitorID
readwritenonatomiccopy

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.

- (NSDictionary<NSString *, NSString *>*) adTagParameters
readwritenonatomiccopy

You can override a limited set of ad tag parameters on your stream request.

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.

- (NSString*) manifestURLSuffix
readwritenonatomiccopy

The suffix that the SDK will append to the query of the stream manifest URL.

Do not include the '?' separator at the start. The SDK will account for the existence of parameters in the URL already, removing existing ones that collide with ones supplied here. This suffix needs to be sanitized and encoded as the SDK will not do this.

- (NSTimeInterval) initializationTimeout
readwritenonatomicassign

Override for the default stream initialization timeout.

The default value is 8 seconds.

Send feedback about...

IMA DAI SDK for tvOS
Need help? Visit our support page.