com.ooyala.android.player.PlayerInterface Interface Reference

The interface that must be implemented in order to receive control events from Ooyala UI. More...

Inheritance diagram for com.ooyala.android.player.PlayerInterface:

Public Member Functions
void	pause ()
	This is called when pause is clicked. More...
void	play ()
	This is called when play is clicked. More...
void	stop ()
	This is called when stop is clicked. More...
int	currentTime ()
int	duration ()
int	buffer ()
boolean	seekable ()
void	seekToTime (int timeInMillis)
	Move the playhead to a new location in seconds with millisecond accuracy. More...
State	getState ()
	This returns the player state. More...
int	livePlayheadPercentage ()
void	seekToPercentLive (float percent)
	Seek to the given percent position of scrubber for live stream playback. More...
boolean	isLiveClosedCaptionsAvailable ()
void	setClosedCaptionsLanguage (String language)
	Set the displayed closed captions language. More...
OoyalaException	getError ()
void	setVolume (float volume)
	Set the volume for the player. More...
PlayerType	getPlayerType ()
	Get the player's type. More...
boolean	isMultiAudioAvailable ()
void	createBitmapScreenshot (final PlayerBitmapListener playerBitmapListener)
	Create the bitmap screenshot of the current video frame. More...

Detailed Description

The interface that must be implemented in order to receive control events from Ooyala UI.

Member Function Documentation

int com.ooyala.android.player.PlayerInterface.buffer

(

)

Returns

the buffer percentage (between 0 and 100 inclusive)

Implemented in com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.cast.CastPlayer, com.ooyala.android.player.MoviePlayer, com.ooyala.android.player.BaseStreamPlayer, and com.ooyala.android.player.Player.

void com.ooyala.android.player.PlayerInterface.createBitmapScreenshot

(

final PlayerBitmapListener

playerBitmapListener

)

Create the bitmap screenshot of the current video frame.

Parameters

playerBitmapListener

the interface that must be implemented in order to receive bitmap screenshot from Ooyala ExoPlayer

Implemented in com.ooyala.android.player.exoplayer.ExoStreamPlayer, com.ooyala.android.player.MoviePlayer, and com.ooyala.android.player.Player.

int com.ooyala.android.player.PlayerInterface.currentTime

(

)

Returns

current time

Implemented in com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.android.player.MoviePlayer, com.ooyala.cast.CastPlayer, com.ooyala.android.player.Player, and com.ooyala.android.player.BaseStreamPlayer.

int com.ooyala.android.player.PlayerInterface.duration

(

)

Returns

duration.

Implemented in com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.cast.CastPlayer, com.ooyala.android.player.MoviePlayer, com.ooyala.android.player.BaseStreamPlayer, and com.ooyala.android.player.Player.

OoyalaException com.ooyala.android.player.PlayerInterface.getError

(

)

Implemented in com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.cast.CastPlayer, com.ooyala.android.player.MoviePlayer, and com.ooyala.android.player.Player.

PlayerType com.ooyala.android.player.PlayerInterface.getPlayerType

(

)

Get the player's type.

Implemented in com.ooyala.android.player.BaseStreamPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.android.player.exoplayer.ExoStreamPlayer, com.ooyala.android.player.MoviePlayer, com.ooyala.cast.CastPlayer, and com.ooyala.android.player.Player.

State com.ooyala.android.player.PlayerInterface.getState

(

)

This returns the player state.

Returns

the state

Implemented in com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.android.player.MoviePlayer, com.ooyala.cast.CastPlayer, and com.ooyala.android.player.Player.

boolean com.ooyala.android.player.PlayerInterface.isLiveClosedCaptionsAvailable

(

)

Returns

true if the player can support live closed captions

Implemented in com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.android.player.MoviePlayer, com.ooyala.cast.CastPlayer, and com.ooyala.android.player.Player.

boolean com.ooyala.android.player.PlayerInterface.isMultiAudioAvailable

(

)

Returns

true if the current asset has several audio tracks

Implemented in com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.android.player.MoviePlayer, com.ooyala.cast.CastPlayer, com.ooyala.android.player.Player, and com.ooyala.android.player.AdMoviePlayer.

int com.ooyala.android.player.PlayerInterface.livePlayheadPercentage

(

)

Returns

the percentage of the cursor should be on scrubber for live stream playback

Implemented in com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.cast.CastPlayer, com.ooyala.android.player.MoviePlayer, and com.ooyala.android.player.Player.

void com.ooyala.android.player.PlayerInterface.pause

(

)

This is called when pause is clicked.

Implemented in com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.android.player.MoviePlayer, com.ooyala.android.ads.vast.VASTAdPlayer, com.ooyala.cast.CastPlayer, com.ooyala.android.player.Player, com.ooyala.android.imasdk.IMAAdPlayer, and com.ooyala.android.player.BaseStreamPlayer.

void com.ooyala.android.player.PlayerInterface.play

(

)

This is called when play is clicked.

Implemented in com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.android.player.MoviePlayer, com.ooyala.cast.CastPlayer, com.ooyala.android.ads.vast.VASTAdPlayer, com.ooyala.android.player.Player, com.ooyala.android.ads.ooyala.OoyalaAdPlayer, com.ooyala.android.player.BaseStreamPlayer, and com.ooyala.android.imasdk.IMAAdPlayer.

boolean com.ooyala.android.player.PlayerInterface.seekable

(

)

Returns

true if the current player is seekable, false if there is no current player or it is not seekable

Implemented in com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.android.player.MoviePlayer, com.ooyala.cast.CastPlayer, and com.ooyala.android.player.Player.

void com.ooyala.android.player.PlayerInterface.seekToPercentLive

(

float

percent

)

Seek to the given percent position of scrubber for live stream playback.

Parameters

percent

The percent of scrubber the cursor ends after seek

Implemented in com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.cast.CastPlayer, com.ooyala.android.player.MoviePlayer, and com.ooyala.android.player.Player.

void com.ooyala.android.player.PlayerInterface.seekToTime

(

int

timeInMillis

)

Move the playhead to a new location in seconds with millisecond accuracy.

Parameters

timeInMillis

time in milliseconds

Implemented in com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.android.player.MoviePlayer, com.ooyala.cast.CastPlayer, com.ooyala.android.player.BaseStreamPlayer, and com.ooyala.android.player.Player.

void com.ooyala.android.player.PlayerInterface.setClosedCaptionsLanguage

(

String

language

)

Set the displayed closed captions language.

Parameters

language

2 letter country code of the language to display or nil to hide closed captions

Implemented in com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.android.player.MoviePlayer, com.ooyala.cast.CastPlayer, and com.ooyala.android.player.Player.

void com.ooyala.android.player.PlayerInterface.setVolume

(

float

volume

)

Set the volume for the player.

Implemented in com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.player.BaseStreamPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.cast.CastPlayer, com.ooyala.android.player.MoviePlayer, and com.ooyala.android.player.Player.

void com.ooyala.android.player.PlayerInterface.stop

(

)

This is called when stop is clicked.

Implemented in com.ooyala.android.player.exoplayer.BaseExoPlayer, com.ooyala.android.freewheelsdk.FWAdPlayer, com.ooyala.android.player.MoviePlayer, com.ooyala.cast.CastPlayer, com.ooyala.android.player.Player, and com.ooyala.android.player.BaseStreamPlayer.