Declares a simple video display class used for ad playback. More...

Inheritance diagram for <IMAVideoDisplay >:

Instance Methods
(void)	- loadStream:withSubtitles:
	Called to inform the VideoDisplay to load the passed URL with the subtitles for the stream. More...

(void)	- loadUrl:
	Called to inform the VideoDisplay to load the passed URL. More...

(void)	- play
	Called to inform the VideoDisplay to play. More...

(void)	- pause
	Called to inform the VideoDisplay to pause. More...

(void)	- reset
	Called to remove all video assets from the player. More...

(void)	- seekStreamToTime:
	Called to inform that the stream needs to be seeked to the given time. More...

Properties
id< IMAVideoDisplayDelegate >	delegate
	Allows the publisher to send player events to the SDK. More...

float	volume
	Set and get the volume for the current ad. More...

Properties inherited from <IMAAdPlaybackInfo>
NSTimeInterval	currentMediaTime
	The current media time of the ad, or 0 if no ad loaded. More...

NSTimeInterval	totalMediaTime
	The total media time of the ad, or 0 if no ad loaded. More...

NSTimeInterval	bufferedMediaTime
	The buffered media time of the ad, or 0 if no ad loaded. More...

BOOL	playing
	Whether or not the ad is currently playing. More...

Detailed Description

Declares a simple video display class used for ad playback.

Method Documentation

- (void IMAVideoDisplay) loadStream:	(NSURL *)	streamURL
withSubtitles:	(NSArray *)	subtitles

Called to inform the VideoDisplay to load the passed URL with the subtitles for the stream.

Subtitles are available only for dynamic ad insertion VOD streams and can be ignored for client side ads or dynamic ad insertion live streams.

Parameters

streamURL	the URL of the stream
subtitles	the subtitles for the stream. Each entry in the subtitles array is an NSDictionary that corresponds to a language. Each dictionary will have a language key with a two letter language string value and one or more subtitle key/value pairs. Here's an example NSDictionary for English:

"language" -> "en" "webvtt" -> "https://somedomain.com/vtt/en.vtt" "ttml" -> "https://somedomain.com/ttml/en.ttml"

- (void IMAVideoDisplay) loadUrl: (NSURL *) url

Called to inform the VideoDisplay to load the passed URL.

Parameters

url	the media URL of the ad to be played

- (void IMAVideoDisplay) pause

Called to inform the VideoDisplay to pause.

- (void IMAVideoDisplay) play

Called to inform the VideoDisplay to play.

- (void IMAVideoDisplay) reset

Called to remove all video assets from the player.

- (void IMAVideoDisplay) seekStreamToTime: (NSTimeInterval) time

Called to inform that the stream needs to be seeked to the given time.

Parameters

time	the time to which the stream should be seeked

- (id<IMAVideoDisplayDelegate> IMAVideoDisplay) delegate

readwritenonatomicweak

Allows the publisher to send player events to the SDK.

- (float IMAVideoDisplay) volume

readwritenonatomicassign

Set and get the volume for the current ad.

From 0 (muted) to 1 (loudest). This volume is relative to device volume, not absolute. Default value is 1.

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