> Documentation-Index

FacadeBase

Kind: interface

• FacadeBase
  • .handshakeVersion(apiFacadeVersion) ⇒ string
  • .load(url, autoPlay, disableSeeking) ⇒ Boolean
  • .addEventListener(type, callback)
  • .removeEventListener(type, callback)
  • .getCurrentContentSource() ⇒ ContentSource(#ContentSource)
  • .lockContent() ⇒ ContentSource(#ContentSource)
  • .releaseContent() ⇒ Boolean
  • .getError() ⇒ MediaError
  • .getCurrentTime() ⇒ Number
  • .getDuration() ⇒ Number
  • .getPlayerSize() ⇒ ElementSize
  • .getViewportSize() ⇒ ElementSize
  • .setVolume(volume)
  • .getVolume()
  • .isMuted() ⇒ Boolean
  • .mute()
  • .unmute()
  • .isPaused() ⇒ Boolean
  • .pause()
  • .play()
  • .seek(offset)

handshakeVersion(apiFacadeVersion) ⇒ String

Requests the player facade version (API version) to ensure the particular versions of smartclientcore and player facade are supported.

Kind: instance method of FacadeBase
Returns: String - Supported API version

Param	Type	Description
apiFacadeVersion	string	Required API version

load(url, autoPlay, disableSeeking)

Requests the video player to load and play the specified media file.

Kind: instance method of FacadeBase

Param	Type	Default	Description
url	string		Media file URI
autoPlay	Boolean	true	Whether the requested media file starts playback immediately.
disableSeeking	Boolean	false	Whether the requested source can be seeked back and forth.

addEventListener(type, callback)

Sets up a function that will be called whenever the specified event is delivered to the video player.

Kind: instance method of FacadeBase

Param	Type	Description
type	string	A case-sensitive string representing the player event type to listen for.
callback	function	The function which receives a notification when an event of the specified type occurs.

removeEventListener(type, callback)

Removes an event listener from the video player that has been registered with addEventListener() Note: The event listener to be removed must match with the listener that has been added.

Kind: instance method of FacadeBase

Param	Type	Description
type	string	A case-sensitive string representing the player event type to listen for.
callback	function	The function which receives a notification when an event of the specified type occurs.

getCurrentContentSource() ⇒ ContentSource

Kind: instance method of FacadeBase
Returns: SourceObject - Current content source and playhead progress

lockContent() ⇒ ContentSource

Should freeze the current playback state (for later use with releaseContent()) and respond to the PublisherAPI once finished.

Kind: instance method of FacadeBase
Returns: ContentSource - Current content source and playhead progress for VAST tracking enrichment

releaseContent()

Should restore the last known playback state, resume playback and respond to the PublisherAPI once finished.

Kind: instance method of FacadeBase

getError() ⇒ MediaError

Requests details about the most recent error that has occurred on the video player.

Kind: instance method of FacadeBase
Returns: MediaError - Description object of the most recent error or null.

getCurrentTime() ⇒ Double

Requests the current playhead position from the video player.

Kind: instance method of FacadeBase
Returns: Double - Current time in seconds.

getDuration() ⇒ Double

Requests the content-duration from the video player.

Kind: instance method of FacadeBase
Returns: Double - Total time in seconds.

getPlayerSize() ⇒ ElementSize

Requests the current size and viewMode from the video player.

Kind: instance method of FacadeBase
Returns: ElementSize - Current player dimension specs

getViewportSize() ⇒ ElementSize

Requests the current size and viewMode from the viewport that surrounds the video player.

Kind: instance method of FacadeBase
Returns: ElementSize - The dimension specs of the element

setVolume(volume)

Requests the video player to change the volume.

Kind: instance method of FacadeBase

Param	Type	Description
volume	Number	Requested volume level between 0-1

getVolume() ⇒ Double

Requests the current volume level from the video player.

Kind: instance method of FacadeBase
Returns: Double - The current volume level between 0-1

isMuted() ⇒ Boolean

Requests the current muted state from the video player.

Kind: instance method of FacadeBase
Returns: Boolean - Muted state

mute()

Requests the video player to mute playback.

Kind: instance method of FacadeBase

unmute()

Requests the video player to unmute playback.

Kind: instance method of FacadeBase

isPaused() ⇒ Boolean

Requests the current play state from the video player.

Kind: instance method of FacadeBase
Returns: Boolean - Playback state

pause()

Requests the video player to pause playback.

Kind: instance method of FacadeBase

play()

Requests the video player to start (resume) playback.

Kind: instance method of FacadeBase

seek(offset)

Requests the video player to change the playhead position to the specified time.

Kind: instance method of FacadeBase

Param	Type	Description
offset	Number	Requested playhead position

MediaError : Object

Kind: global typedef
Properties

Name	Type	Description
code	Number	A number which represents the general type of error that occurred.
message	string	A human-readable string which provides specific diagnostic information to help the reader understand the error condition which occurred.

ElementSize : Object

Kind: global typedef
Properties

Name	Type	Description
rect	Rect	A android.graphics.Rect that holds four integer coordinates for a rectangle
viewMode	String	Either normal or fullscreen