IMAStreamRequest Class Reference

Data class describing the stream request. More...

#import <IMAStreamRequest.h>

Inheritance diagram for IMAStreamRequest:

Instance Methods
(instancetype)	- NS_UNAVAILABLE
	:nodoc: More...

Properties
IMAAdDisplayContainer *	adDisplayContainer
	The stream display container for displaying the ad UI. More...
id< IMAVideoDisplay >	videoDisplay
	The video display where the stream can be played. More...
NSString *	apiKey
	The stream request API key. More...
NSString *	authToken
	The stream request authorization token. More...
NSString *	streamActivityMonitorID
	The ID to be used to debug the stream with the stream activity monitor. More...
NSDictionary *	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...

Detailed Description

Data class describing the stream request.

Method Documentation

- (instancetype) NS_UNAVAILABLE

:nodoc:

Implemented in IMAVODStreamRequest, and IMALiveStreamRequest.

Property Documentation

- (IMAAdDisplayContainer*) adDisplayContainer

readnonatomicstrong

The stream display container for displaying the ad UI.

- (NSDictionary*) 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*) 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*) authToken

readwritenonatomiccopy

The stream request authorization token.

This is used in place of the API key for stricter content authorization. The publisher can control individual content streams authorized based on this token. :nodoc:

- (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.

- (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.

- (id<IMAVideoDisplay>) videoDisplay

readnonatomicstrong

The video display where the stream can be played.

---

The documentation for this class was generated from the following file:

• IMAStreamRequest.h