IMAVODStreamRequest Class Reference

IMAVODStreamRequest Class Reference

Overview

Data object describing a VOD stream request.

Inheritance diagram for IMAVODStreamRequest:
IMAStreamRequest

Instance Methods

(instancetype) - initWithContentSourceID:videoID:
 Initializes a VOD stream request instance with the given content source ID and video ID. More...
 

Properties

NSString * contentSourceID
 The stream request content source ID. More...
 
NSString * videoID
 The stream request video ID. More...
 
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...
 

Method Documentation

- (instancetype) initWithContentSourceID: (NSString *)  contentSourceID
videoID: (NSString *)  videoID 

Initializes a VOD stream request instance with the given content source ID and video ID.

Parameters
contentSourceIDThe content source ID used to determine the content source
videoIDThe video ID used to determine the specific video
Returns
The IMAVODStreamRequest instance

Property Documentation

- (NSString*) contentSourceID
readnonatomiccopy

The stream request content source ID.

This is used to determine the content source of the stream.

- (NSString*) videoID
readnonatomiccopy

The stream request video ID.

This is used to determine which specific video stream should be played.

- (NSString*) apiKey
readwritenonatomiccopyinherited

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
readwritenonatomiccopyinherited

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
readwritenonatomiccopyinherited

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
readwritenonatomiccopyinherited

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
readwritenonatomicassigninherited

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.