com.ooyala.android.player.StreamPlayer Class Reference

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

Public Member Functions
void	init (OoyalaPlayer parent, Set< Stream > streams)
State	getState ()
	This returns the player state. More...
OoyalaException	getError ()
void	setError (OoyalaException error)
View	getView ()
void	setParent (OoyalaPlayer parent)
OoyalaPlayer	getParent ()
int	getBufferPercentage ()
boolean	isPlaying ()
boolean	isLiveClosedCaptionsAvailable ()
	Returns if the current player has found live closed caption info in the stream. More...
SeekStyle	getSeekStyle ()
void	reset ()
	This is called when plugin should be reset. More...
void	suspend ()
	This is called when plugin should be suspended. More...
void	suspend (boolean onlyRemoveView)
	This is called when plugin should be suspended. More...
void	resume ()
	This is called when plugin should be resumed. More...
void	resume (int timeInMilliSecond, State stateToResume)
	This is called when plugin should be resumed. More...
void	destroy ()
	This is called when plugin should be destroyed. More...
void	configurationChanged (Configuration newConfig)
	This method is called when the device configuration changes while your component is running. More...
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 ()
void	seekToTime (int timeInMillis)
	Move the playhead to a new location in seconds with millisecond accuracy. More...
boolean	seekable ()
int	livePlayheadPercentage ()
void	seekToPercentLive (float percent)
	Seek to the given percent position of scrubber for live stream playback. More...
void	setClosedCaptionsLanguage (String language)
	Set the displayed closed captions language. More...
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...

Protected Member Functions
void	startPlayheadTimer ()
void	stopPlayheadTimer ()
void	notifyTimeChanged ()
void	setState (State state)

Protected Attributes
Timer	_playheadUpdateTimer = null
OoyalaPlayer	_parent = null
OoyalaException	_error = null
	The Player's current error if it exists. More...
ControlSharingSurfaceView	_view = null
int	_buffer = 0
State	_state = State.INIT

Static Protected Attributes
static final long	TIMER_DELAY = 0
static final long	TIMER_PERIOD = 250

Member Function Documentation

int com.ooyala.android.player.Player.buffer ( )

inherited

Returns

the buffer percentage (between 0 and 100 inclusive)

Implements com.ooyala.android.player.PlayerInterface.

void com.ooyala.android.player.Player.configurationChanged ( Configuration  newConfig )

inherited

This method is called when the device configuration changes while your component is running.

Parameters

newConfig

The new device configuration.

Implements com.ooyala.android.plugin.LifeCycleInterface.

void com.ooyala.android.player.Player.createBitmapScreenshot ( final PlayerBitmapListener  playerBitmapListener )

inherited

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

Implements com.ooyala.android.player.PlayerInterface.

int com.ooyala.android.player.Player.currentTime ( )

inherited

Returns

current time

Implements com.ooyala.android.player.PlayerInterface.

void com.ooyala.android.player.Player.destroy ( )

inherited

This is called when plugin should be destroyed.

Implements com.ooyala.android.plugin.LifeCycleInterface.

int com.ooyala.android.player.Player.duration ( )

inherited

Returns

duration.

Implements com.ooyala.android.player.PlayerInterface.

int com.ooyala.android.player.Player.getBufferPercentage ( )

inherited

OoyalaException com.ooyala.android.player.Player.getError ( )

inherited

Implements com.ooyala.android.player.PlayerInterface.

OoyalaPlayer com.ooyala.android.player.Player.getParent ( )

inherited

PlayerType com.ooyala.android.player.Player.getPlayerType ( )

inherited

Get the player's type.

Implements com.ooyala.android.player.PlayerInterface.

SeekStyle com.ooyala.android.player.Player.getSeekStyle ( )

inherited

State com.ooyala.android.player.Player.getState ( )

inherited

This returns the player state.

Returns

the state

Implements com.ooyala.android.player.PlayerInterface.

View com.ooyala.android.player.Player.getView ( )

inherited

void com.ooyala.android.player.Player.init ( OoyalaPlayer  parent, Set< Stream >  streams  )

inherited

boolean com.ooyala.android.player.Player.isLiveClosedCaptionsAvailable ( )

inherited

Returns if the current player has found live closed caption info in the stream.

Returns

true if the stream has embedded live closed captions

Implements com.ooyala.android.player.PlayerInterface.

boolean com.ooyala.android.player.Player.isMultiAudioAvailable ( )

inherited

Returns

true if the current asset has several audio tracks

Implements com.ooyala.android.player.PlayerInterface.

boolean com.ooyala.android.player.Player.isPlaying ( )

inherited

int com.ooyala.android.player.Player.livePlayheadPercentage ( )

inherited

Returns

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

Implements com.ooyala.android.player.PlayerInterface.

void com.ooyala.android.player.StreamPlayer.notifyTimeChanged ( )

protected

void com.ooyala.android.player.Player.pause ( )

inherited

This is called when pause is clicked.

Implements com.ooyala.android.player.PlayerInterface.

void com.ooyala.android.player.Player.play ( )

inherited

This is called when play is clicked.

Implements com.ooyala.android.player.PlayerInterface.

void com.ooyala.android.player.Player.reset ( )

inherited

This is called when plugin should be reset.

Implements com.ooyala.android.plugin.LifeCycleInterface.

void com.ooyala.android.player.Player.resume ( )

inherited

This is called when plugin should be resumed.

Implements com.ooyala.android.plugin.LifeCycleInterface.

void com.ooyala.android.player.Player.resume ( int  timeInMillisecond, State  stateToResume  )

inherited

This is called when plugin should be resumed.

Parameters

timeInMillisecond	the playhead time to set
stateToResume	the player state after resume

Implements com.ooyala.android.plugin.LifeCycleInterface.

boolean com.ooyala.android.player.Player.seekable ( )

inherited

Returns

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

Implements com.ooyala.android.player.PlayerInterface.

void com.ooyala.android.player.Player.seekToPercentLive ( float  percent )

inherited

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

Parameters

percent

The percent of scrubber the cursor ends after seek

Implements com.ooyala.android.player.PlayerInterface.

void com.ooyala.android.player.Player.seekToTime ( int  timeInMillis )

inherited

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

Parameters

timeInMillis

time in milliseconds

Implements com.ooyala.android.player.PlayerInterface.

void com.ooyala.android.player.Player.setClosedCaptionsLanguage ( String  language )

inherited

Set the displayed closed captions language.

Parameters

language

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

Implements com.ooyala.android.player.PlayerInterface.

void com.ooyala.android.player.Player.setError ( OoyalaException  error )

inherited

void com.ooyala.android.player.Player.setParent ( OoyalaPlayer  parent )

inherited

void com.ooyala.android.player.Player.setState ( State  state )

protectedinherited

void com.ooyala.android.player.Player.setVolume ( float  volume )

inherited

Set the volume for the player.

Implements com.ooyala.android.player.PlayerInterface.

void com.ooyala.android.player.StreamPlayer.startPlayheadTimer ( )

protected

void com.ooyala.android.player.Player.stop ( )

inherited

This is called when stop is clicked.

Implements com.ooyala.android.player.PlayerInterface.

void com.ooyala.android.player.StreamPlayer.stopPlayheadTimer ( )

protected

void com.ooyala.android.player.Player.suspend ( )

inherited

This is called when plugin should be suspended.

Implements com.ooyala.android.plugin.LifeCycleInterface.

void com.ooyala.android.player.Player.suspend ( boolean  onlyRemoveView )

inherited

This is called when plugin should be suspended.

Parameters

onlyRemoveView

To remove video view

Implements com.ooyala.android.plugin.LifeCycleInterface.

Member Data Documentation

int com.ooyala.android.player.Player._buffer = 0

protectedinherited

OoyalaException com.ooyala.android.player.Player._error = null

protectedinherited

The Player's current error if it exists.

OoyalaPlayer com.ooyala.android.player.Player._parent = null

protectedinherited

Timer com.ooyala.android.player.StreamPlayer._playheadUpdateTimer = null

protected

State com.ooyala.android.player.Player._state = State.INIT

protectedinherited

ControlSharingSurfaceView com.ooyala.android.player.Player._view = null

protectedinherited

final long com.ooyala.android.player.StreamPlayer.TIMER_DELAY = 0

staticprotected

final long com.ooyala.android.player.StreamPlayer.TIMER_PERIOD = 250

staticprotected