IMALiveStreamRequest Class Reference

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

#import <IMALiveStreamRequest.h>

+ Inheritance diagram for IMALiveStreamRequest:

Instance Methods

(instancetype) - initWithAssetKey:adDisplayContainer:videoDisplay:
 Initializes a live stream request instance with the given assetKey. More...
 
(instancetype) - initWithAssetKey:adDisplayContainer:videoDisplay:pictureInPictureProxy:
 Initializes a live stream request instance with the given assetKey. More...
 
(instancetype) - NS_UNAVAILABLE
 :nodoc: More...
 

Properties

NSString * assetKey
 This is used to determine which stream should be played. More...
 
- Properties inherited from IMAStreamRequest
IMAAdDisplayContaineradDisplayContainer
 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 live stream request.

Method Documentation

- (instancetype) initWithAssetKey: (NSString *)  assetKey
adDisplayContainer: (IMAAdDisplayContainer *)  adDisplayContainer
videoDisplay: (id< IMAVideoDisplay >)  videoDisplay 

Initializes a live stream request instance with the given assetKey.

Uses the given ad display container to display the stream.

Parameters
assetKeythe stream assetKey
adDisplayContainerthe IMAAdDisplayContainer for rendering the ad UI
videoDisplaythe IMAVideoDisplay for playing the stream
Returns
the IMALiveStreamRequest instance
- (instancetype) initWithAssetKey: (NSString *)  assetKey
adDisplayContainer: (IMAAdDisplayContainer *)  adDisplayContainer
videoDisplay: (id< IMAVideoDisplay >)  videoDisplay
pictureInPictureProxy: (IMAPictureInPictureProxy *)  pictureInPictureProxy 

Initializes a live stream request instance with the given assetKey.

Uses the given ad display container to display the stream. Uses the picture in picture proxy to track PIP events.

Parameters
assetKeythe stream assetKey
adDisplayContainerthe IMAAdDisplayContainer for rendering the ad UI
videoDisplaythe IMAVideoDisplay for playing the stream
pictureInPictureProxythe IMAPictureInPictureProxy for tracking PIP events
Returns
the IMALiveStreamRequest instance
- (instancetype) NS_UNAVAILABLE

:nodoc:

Implements IMAStreamRequest.

Property Documentation

- (NSString*) assetKey
readnonatomiccopy

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.

{!string}


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