Class: ima

ima

class

Constructor

ima

new ima()

Global functions that control the IMA SDK.

Classes

AdBreakInfo

Contains info about an ad break. Passed to event callbacks by the SDK.

AdEvent

Events fired by the ads manager.

AdInfo

Contains info about an ad. Passed to event callbacks by the SDK.

Companion

Contains information about companions of an ad.

CuePoint

Contains info about a cue point.

Error

Object passed to the error handler if there is an error.

ErrorEvent

All errors that the SDK might send back.

Player

StreamFormat

Defines the format of the stream.

StreamInfo

Information passed from the sdk to the player about the stream.

StreamManager

Object for managing stream playback.

StreamRequest

Used for specifying properties of the stream request.

StreamType

Defines the type of stream that the player is asked to play. Prerolls and VOD should play from the beginning of the stream.

WrapperInfo

Contains information about a wrapper.

Methods

disableLogging

static

disableLogging()

Disables the SDK logging. Logging will be on by default.

getStreamManager

static

getStreamManager() returns object

Returns a stream manager if it available. If the stream manager is not yet availbe, Invalid is returned. If there was an error creating the stream manager, an error object is returned.

Returns

object The stream manager or error object.

initSdk

static

initSdk(settings)

Initializes the SDK.

Parameter
settings	object Optional IMA settings object.

requestStream

static

requestStream(streamRequest) returns object

Starts an asynchronus stream request Control returns immediately to the player after calling this method.

Parameter
streamRequest	object

Returns

object an error or invalid if no error