IMAStreamManager Class Reference

The IMAStreamManager class is responsible for playing streams. More...

#import <IMAStreamManager.h>

Inheritance diagram for IMAStreamManager:

Instance Methods
(void)	- initializeWithAdsRenderingSettings:
	Initializes and loads the stream. More...
(NSTimeInterval)	- streamTimeForContentTime:
	Returns the stream time with ads for a given content time. More...
(NSTimeInterval)	- contentTimeForStreamTime:
	Returns the content time without ads for a given stream time. More...
(IMACuepoint *)	- previousCuepointForStreamTime:
	Returns the previous cuepoint for the given stream time. More...
(instancetype)	- NS_UNAVAILABLE
	:nodoc: More...
(void)	- destroy
	Cleans the stream manager's internal state for proper deallocation. More...

Properties
NSObject< IMAStreamManagerDelegate > *	delegate
	The IMAStreamManagerDelegate to notify with events during stream playback. More...
NSString *	streamId
	Identifier used during dynamic ad insertion to uniquely identify a stream. More...

Detailed Description

The IMAStreamManager class is responsible for playing streams.

Method Documentation

- (NSTimeInterval) contentTimeForStreamTime:

(NSTimeInterval)

streamTime

Returns the content time without ads for a given stream time.

Returns the given stream time for live streams.

Parameters

streamTime

the stream time with inserted ads (in seconds)

Returns

the content time that corresponds with the given stream time once ads are removed

- (void) destroy

Cleans the stream manager's internal state for proper deallocation.

- (void) initializeWithAdsRenderingSettings:

(IMAAdsRenderingSettings *)

adsRenderingSettings

Initializes and loads the stream.

Parameters

adsRenderingSettings

the IMAAdsRenderingSettings. Pass in to influence ad rendering. Use nil to default to standard rendering.

- (instancetype) NS_UNAVAILABLE

:nodoc:

- (IMACuepoint *) previousCuepointForStreamTime:

(NSTimeInterval)

streamTime

Returns the previous cuepoint for the given stream time.

Retuns nil if no such cuepoint exists. This is used to implement features like snap back, and called when the publisher detects that the user seeked in order to force the user to watch an ad break they may have skipped over.

Parameters

streamTime

the stream time that the was seeked to.

Returns

the previous IMACuepoint for the given stream time.

- (NSTimeInterval) streamTimeForContentTime:

(NSTimeInterval)

contentTime

Returns the stream time with ads for a given content time.

Returns the given content time for live streams.

Parameters

contentTime

the content time without any ads (in seconds)

Returns

the stream time that corresponds with the given content time once ads are inserted

Property Documentation

- (NSObject<IMAStreamManagerDelegate>*) delegate

readwritenonatomicweak

The IMAStreamManagerDelegate to notify with events during stream playback.

- (NSString*) streamId

readnonatomiccopy

Identifier used during dynamic ad insertion to uniquely identify a stream.

This can be used in the Stream Activity Monitor Debug Console to debug the stream session.

---

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

• IMAStreamManager.h