com.vdocipher.aegis.cast

Class CastVdoPlayer

java.lang.Object

com.vdocipher.aegis.cast.CastVdoPlayer

All Implemented Interfaces:

VdoPlayer

public class CastVdoPlayer
extends java.lang.Object
implements VdoPlayer

A VdoPlayer implementation that can be used to interact with the VdoCipher Cast receiver app.

In order to use this class, you must pass a CastContext to create an instance.

To track cast session availability, use isCastSessionAvailable() to get session status at start, and attach a CastSessionAvailabilityListener using setSessionAvailabilityListener(CastSessionAvailabilityListener) to get further session availability updates.

To join an existing playback session on the receiver app, use #joinSession(VdoInitParams); to load a new session, use VdoPlayer.load(VdoInitParams).

Nested Class Summary

Nested classes/interfaces inherited from interface com.vdocipher.aegis.player.VdoPlayer

VdoPlayer.InitializationListener, VdoPlayer.PlaybackEventListener, VdoPlayer.PlayerHost, VdoPlayer.PlayerHostNotReadyException, VdoPlayer.VdoInitParams

Field Summary

Fields inherited from interface com.vdocipher.aegis.player.VdoPlayer

STATE_BUFFERING, STATE_ENDED, STATE_IDLE, STATE_READY

Constructor Summary

Constructors

Constructor and Description
CastVdoPlayer(CastContext castContext)

Method Summary

Modifier and Type	Method and Description
void	addPlaybackEventListener(VdoPlayer.PlaybackEventListener listener) Register callbacks for playback events from this VdoPlayer
Track[]	getAvailableTracks() Returns the available tracks for the currently playing media.
long	getBufferedTime() Gets the time till which video is buffered
MediaInfo	getCurrentMedia() Returns a MediaInfo object containing info corresponding to the currently playing media.
long	getCurrentTime() Gets the current playback time of the video from the beginning.
long	getDuration() Gets the duration of the current video.
java.lang.Object	getPlaybackProperty(java.lang.String propertyName) Returns values of additional properties specific to current playback session.
float	getPlaybackSpeed() Returns the currently active playback speed.
int	getPlaybackState() Returns the current state of the player.
boolean	getPlayWhenReady() Whether playback will proceed when VdoPlayer.getPlaybackState() == VdoPlayer.STATE_READY.
Track[]	getSelectedTracks() Returns the selected tracks for the currently playing media.
boolean	isAdaptive() Returns if the current playback is adaptive.
boolean	isCastSessionAvailable()
boolean	isSpeedControlSupported() Returns if the current player supports changing the playback speed.
boolean	joinSession(VdoPlayer.VdoInitParams vdoParams) Join an existing cast session if the provided VdoInitParams is being played.
void	load(VdoPlayer.VdoInitParams vdoParams) Immediately starts loading a media for the player to play.
void	release() Release system resources used by this VdoPlayer.
void	removePlaybackEventListener(VdoPlayer.PlaybackEventListener listener) Remove a registered playback event listener from this VdoPlayer
void	seekTo(long timeInMillis) Seeks to a particular time in the video.
void	setPlaybackSpeed(float speed) Sets the playback speed.
void	setPlayWhenReady(boolean playWhenReady) Sets whether playback should proceed when VdoPlayer.getPlaybackState() == VdoPlayer.STATE_READY.
void	setSelectedTracks(Track[] tracks) Sets a fixed (non-adaptive) selection of tracks.
void	setSessionAvailabilityListener(CastSessionAvailabilityListener listener)
void	stop() Stops the currently loaded video.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CastVdoPlayer

public CastVdoPlayer(CastContext castContext)

Method Detail

isCastSessionAvailable

public boolean isCastSessionAvailable()

setSessionAvailabilityListener

public void setSessionAvailabilityListener(CastSessionAvailabilityListener listener)

joinSession

public boolean joinSession(VdoPlayer.VdoInitParams vdoParams)

Join an existing cast session if the provided VdoInitParams is being played.

Parameters:

vdoParams -

Returns:

true if joined an existing session, false otherwise

getPlaybackState

public int getPlaybackState()

Description copied from interface: VdoPlayer

Returns the current state of the player.

Specified by:

getPlaybackState in interface VdoPlayer

Returns:

One of the VdoPlayer.STATE_IDLE, VdoPlayer.STATE_BUFFERING, VdoPlayer.STATE_READY, VdoPlayer.STATE_ENDED.

setPlayWhenReady

public void setPlayWhenReady(boolean playWhenReady)

Description copied from interface: VdoPlayer

Sets whether playback should proceed when VdoPlayer.getPlaybackState() == VdoPlayer.STATE_READY. If the player is already in the ready state then this method can be used to pause and resume playback.

Specified by:

setPlayWhenReady in interface VdoPlayer

Parameters:

playWhenReady - Whether playback should proceed when ready.

getPlayWhenReady

public boolean getPlayWhenReady()

Description copied from interface: VdoPlayer

Whether playback will proceed when VdoPlayer.getPlaybackState() == VdoPlayer.STATE_READY.

Specified by:

getPlayWhenReady in interface VdoPlayer

Returns:

Whether playback will proceed when ready.

load

public void load(VdoPlayer.VdoInitParams vdoParams)

Description copied from interface: VdoPlayer

Immediately starts loading a media for the player to play.

Specified by:

load in interface VdoPlayer

Parameters:

vdoParams - parameters for the playback

getCurrentTime

public long getCurrentTime()

Description copied from interface: VdoPlayer

Gets the current playback time of the video from the beginning.

Specified by:

getCurrentTime in interface VdoPlayer

Returns:

the current playback time of the video in milliseconds

getBufferedTime

public long getBufferedTime()

Description copied from interface: VdoPlayer

Gets the time till which video is buffered

Specified by:

getBufferedTime in interface VdoPlayer

Returns:

buffer time in milliseconds

getDuration

public long getDuration()

Description copied from interface: VdoPlayer

Gets the duration of the current video.

Specified by:

getDuration in interface VdoPlayer

Returns:

duration of the current video in milliseconds

isSpeedControlSupported

public boolean isSpeedControlSupported()

Description copied from interface: VdoPlayer

Returns if the current player supports changing the playback speed.

Specified by:

isSpeedControlSupported in interface VdoPlayer

Returns:

true if speed control is supported

setPlaybackSpeed

public void setPlaybackSpeed(float speed)

Description copied from interface: VdoPlayer

Sets the playback speed. Passing 0 or a negative value will reset player to use default playback speed of 1. VdoPlayer.PlaybackEventListener.onPlaybackSpeedChanged(float) will be called when the currently active playback speed changes.

Specified by:

setPlaybackSpeed in interface VdoPlayer

Parameters:

speed - factor by which playback speed should be changed

getPlaybackSpeed

public float getPlaybackSpeed()

Description copied from interface: VdoPlayer

Returns the currently active playback speed.

Specified by:

getPlaybackSpeed in interface VdoPlayer

Returns:

playback speed

release

public void release()

Description copied from interface: VdoPlayer

Release system resources used by this VdoPlayer. A new VdoPlayer instance must be created to play/stream another video.

Specified by:

release in interface VdoPlayer

seekTo

public void seekTo(long timeInMillis)

Description copied from interface: VdoPlayer

Seeks to a particular time in the video.

Specified by:

seekTo in interface VdoPlayer

Parameters:

timeInMillis - time in milliseconds

addPlaybackEventListener

public void addPlaybackEventListener(VdoPlayer.PlaybackEventListener listener)

Description copied from interface: VdoPlayer

Register callbacks for playback events from this VdoPlayer

Specified by:

addPlaybackEventListener in interface VdoPlayer

Parameters:

listener - listener for the callback

removePlaybackEventListener

public void removePlaybackEventListener(VdoPlayer.PlaybackEventListener listener)

Description copied from interface: VdoPlayer

Remove a registered playback event listener from this VdoPlayer

Specified by:

removePlaybackEventListener in interface VdoPlayer

Parameters:

listener - the listener to remove

stop

public void stop()

Description copied from interface: VdoPlayer

Stops the currently loaded video.

Specified by:

stop in interface VdoPlayer

getAvailableTracks

public Track[] getAvailableTracks()

Description copied from interface: VdoPlayer

Returns the available tracks for the currently playing media.

Specified by:

getAvailableTracks in interface VdoPlayer

Returns:

array containing available tracks, or empty array if no tracks are currently available

getSelectedTracks

public Track[] getSelectedTracks()

Description copied from interface: VdoPlayer

Returns the selected tracks for the currently playing media.

Specified by:

getSelectedTracks in interface VdoPlayer

Returns:

array containing selected tracks, or empty array if no tracks are currently selected

setSelectedTracks

public void setSelectedTracks(Track[] tracks)

Description copied from interface: VdoPlayer

Sets a fixed (non-adaptive) selection of tracks. The provided array must contain Track objects returned by the player, and also must contain only single Track corresponding to a Track.TYPE_* constant. Only the first track in the array corresponding to a Track.TYPE_* constant will be acknowledged.

Specified by:

setSelectedTracks in interface VdoPlayer

Parameters:

tracks - the tracks to select

isAdaptive

public boolean isAdaptive()

Description copied from interface: VdoPlayer

Returns if the current playback is adaptive.

Specified by:

isAdaptive in interface VdoPlayer

Returns:

true if player is adaptive, false otherwise

getCurrentMedia

public MediaInfo getCurrentMedia()

Description copied from interface: VdoPlayer

Returns a MediaInfo object containing info corresponding to the currently playing media.

Specified by:

getCurrentMedia in interface VdoPlayer

Returns:

MediaInfo object corresponding to currently playing media, or null if no media is loaded

getPlaybackProperty

public java.lang.Object getPlaybackProperty(java.lang.String propertyName)

Description copied from interface: VdoPlayer

Returns values of additional properties specific to current playback session. Returned values need to be cast to their expected types before use. For e.g. value for property "totalPlayed" is total played duration in seconds of type Integer.

Specified by:

getPlaybackProperty in interface VdoPlayer

Parameters:

propertyName - name of desired property

Returns:

requested property value as an object; null if not available