IMAVODStreamRequest
@interface IMAVODStreamRequest : IMAStreamRequest
Data object describing a VOD stream request.
-
The stream request content source ID. This is used to determine the content source of the stream.
Declaration
Swift
var contentSourceID: String { get }
Objective-C
@property (nonatomic, copy, readonly) NSString *_Nonnull contentSourceID;
-
The stream request video ID. This is used to determine which specific video stream should be played.
Declaration
Swift
var videoID: String { get }
Objective-C
@property (nonatomic, copy, readonly) NSString *_Nonnull videoID;
-
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.
Declaration
Swift
init(contentSourceID: String, videoID: String, adDisplayContainer: IMAAdDisplayContainer, videoDisplay: any IMAVideoDisplay, userContext: Any?)
Objective-C
- (nonnull instancetype) initWithContentSourceID:(nonnull NSString *)contentSourceID videoID:(nonnull NSString *)videoID adDisplayContainer:(nonnull IMAAdDisplayContainer *)adDisplayContainer videoDisplay:(nonnull id<IMAVideoDisplay>)videoDisplay userContext:(nullable id)userContext;
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
userContext
The user context for tracking requests (optional)
Return Value
the IMAVODStreamRequest instance
-
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.
Declaration
Swift
init(contentSourceID: String, videoID: String, adDisplayContainer: IMAAdDisplayContainer, videoDisplay: any IMAVideoDisplay, pictureInPictureProxy: IMAPictureInPictureProxy?, userContext: Any?)
Objective-C
- (nonnull instancetype) initWithContentSourceID:(nonnull NSString *)contentSourceID videoID:(nonnull NSString *)videoID adDisplayContainer:(nonnull IMAAdDisplayContainer *)adDisplayContainer videoDisplay:(nonnull id<IMAVideoDisplay>)videoDisplay pictureInPictureProxy: (nullable IMAPictureInPictureProxy *)pictureInPictureProxy userContext:(nullable id)userContext;
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
userContext
The user context for tracking requests (optional)
Return Value
the IMAVODStreamRequest instance