IMAVODStreamRequest Class Reference

Data object describing a VOD stream request. More...

#import <IMAVODStreamRequest.h>

Inheritance diagram for IMAVODStreamRequest:

Instance Methods
(instancetype)	- initWithContentSourceID:videoID:adDisplayContainer:videoDisplay:
	Initializes a stream request instance with the given content source ID and video ID. More...
(instancetype)	- initWithContentSourceID:videoID:adDisplayContainer:videoDisplay:pictureInPictureProxy:
	Initializes a stream request instance with the given content source ID and video ID. More...
(instancetype)	- NS_UNAVAILABLE
	:nodoc: More...

Properties
NSString *	contentSourceID
	The stream request content source ID. More...
NSString *	videoID
	The stream request video ID. More...
Properties inherited from IMAStreamRequest
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 object describing a VOD stream request.

Method Documentation

- (instancetype) initWithContentSourceID:		(NSString *)	contentSourceID
videoID:		(NSString *)	videoID
adDisplayContainer:		(IMAAdDisplayContainer *)	adDisplayContainer
videoDisplay:		(id< IMAVideoDisplay >)	videoDisplay

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

Uses the given ad display container to display the stream. This is used for on-demand streams.

Parameters

contentSourceID	the content source ID for this stream
videoID	the video identifier for this stream
adDisplayContainer	the IMAAdDisplayContainer for rendering the ad UI
videoDisplay	the IMAVideoDisplay for playing the stream

Returns

the IMAVODStreamRequest instance

- (instancetype) initWithContentSourceID:		(NSString *)	contentSourceID
videoID:		(NSString *)	videoID
adDisplayContainer:		(IMAAdDisplayContainer *)	adDisplayContainer
videoDisplay:		(id< IMAVideoDisplay >)	videoDisplay
pictureInPictureProxy:		(IMAPictureInPictureProxy *)	pictureInPictureProxy

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

Uses the given ad display container to display the stream. This is used for on-demand streams. Uses the picture in picture proxy to track PIP events.

Parameters

contentSourceID	the content source ID for this stream
videoID	the video identifier for this stream
adDisplayContainer	the IMAAdDisplayContainer for rendering the ad UI
videoDisplay	the IMAVideoDisplay for playing the stream
pictureInPictureProxy	the IMAPictureInPictureProxy for tracking PIP events

Returns

the IMAVODStreamRequest instance

- (instancetype) NS_UNAVAILABLE

:nodoc:

Implements IMAStreamRequest.

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.

---

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

• IMAVODStreamRequest.h