VdoPlayer

All Known Implementing Classes:

CastVdoPlayer
```
public interface VdoPlayer
```
Interface for controlling playback.
The VdoPlayer instance returned in VdoPlayer.InitializationListener.onInitializationSuccess(com.vdocipher.aegis.player.VdoPlayer.PlayerHost, com.vdocipher.aegis.player.VdoPlayer, boolean) can be used to load media and control playback.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`VdoPlayer.InitializationListener` Interface for callbacks related to initialization of a VdoPlayer.
`static interface`	`VdoPlayer.PlaybackEventListener` Interface for callbacks related to playback events.
`static interface`	`VdoPlayer.PlayerHost` Interface for classes that can provide a VdoPlayer instance to load media and control playback.
`static class`	`VdoPlayer.PlayerHostNotReadyException` Thrown when `VdoPlayer.PlayerHost.getPlayer()` is called on an uninitialized PlayerHost or if the hosted VdoPlayer has been released.
`static class`	`VdoPlayer.VdoInitParams` Initialization parameters specifying a media with other options that can be loaded to a VdoPlayer for playback.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`STATE_BUFFERING` The player needs more data to be loaded to be ready to play or resume playback.
`static int`	`STATE_ENDED` The player has finished playing all the media enqueued.
`static int`	`STATE_IDLE` No media is currently queued for playback.
`static int`	`STATE_READY` The player is able to immediately play from the current position.

Method Summary

All Methods Instance Methods Abstract Methods
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 `getPlaybackState()` == `STATE_READY`.
`Track[]`	`getSelectedTracks()` Returns the selected tracks for the currently playing media.
`boolean`	`isAdaptive()` Returns if the current playback is adaptive.
`boolean`	`isSpeedControlSupported()` Returns if the current player supports changing the playback speed.
`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 `getPlaybackState()` == `STATE_READY`.
`void`	`setSelectedTracks(Track[] tracks)` Sets a fixed (non-adaptive) selection of tracks.
`void`	`stop()` Stops the currently loaded video.

- Field Detail
  - STATE_IDLE
```
static final int STATE_IDLE
```
    No media is currently queued for playback.
    
    See Also:
    
    Constant Field Values
  - STATE_BUFFERING
```
static final int STATE_BUFFERING
```
    The player needs more data to be loaded to be ready to play or resume playback.
    
    See Also:
    
    Constant Field Values
  - STATE_READY
```
static final int STATE_READY
```
    The player is able to immediately play from the current position. The player will be playing if getPlayWhenReady() returns true, and paused otherwise.
    
    See Also:
    
    Constant Field Values
  - STATE_ENDED
```
static final int STATE_ENDED
```
    The player has finished playing all the media enqueued.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getPlaybackState
```
int getPlaybackState()
```
    Returns the current state of the player.
    
    Returns:
    
    One of the STATE_IDLE, STATE_BUFFERING, STATE_READY, STATE_ENDED.
  - setPlayWhenReady
```
void setPlayWhenReady(boolean playWhenReady)
```
    Sets whether playback should proceed when getPlaybackState() == STATE_READY. If the player is already in the ready state then this method can be used to pause and resume playback.
    
    Parameters:
    
    playWhenReady - Whether playback should proceed when ready.
  - getPlayWhenReady
```
boolean getPlayWhenReady()
```
    Whether playback will proceed when getPlaybackState() == STATE_READY.
    
    Returns:
    
    Whether playback will proceed when ready.
  - load
```
void load(VdoPlayer.VdoInitParams vdoParams)
```
    Immediately starts loading a media for the player to play.
    
    Parameters:
    
    vdoParams - parameters for the playback
  - getCurrentTime
```
long getCurrentTime()
```
    Gets the current playback time of the video from the beginning.
    
    Returns:
    
    the current playback time of the video in milliseconds
  - getBufferedTime
```
long getBufferedTime()
```
    Gets the time till which video is buffered
    
    Returns:
    
    buffer time in milliseconds
  - getDuration
```
long getDuration()
```
    Gets the duration of the current video.
    
    Returns:
    
    duration of the current video in milliseconds
  - isSpeedControlSupported
```
boolean isSpeedControlSupported()
```
    Returns if the current player supports changing the playback speed.
    
    Returns:
    
    true if speed control is supported
  - setPlaybackSpeed
```
void setPlaybackSpeed(float speed)
```
    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.
    
    Parameters:
    
    speed - factor by which playback speed should be changed
  - getPlaybackSpeed
```
float getPlaybackSpeed()
```
    Returns the currently active playback speed.
    
    Returns:
    
    playback speed
  - release
```
void release()
```
    Release system resources used by this VdoPlayer. A new VdoPlayer instance must be created to play/stream another video.
  - seekTo
```
void seekTo(long timeInMillis)
```
    Seeks to a particular time in the video.
    
    Parameters:
    
    timeInMillis - time in milliseconds
  - addPlaybackEventListener
```
void addPlaybackEventListener(VdoPlayer.PlaybackEventListener listener)
```
    Register callbacks for playback events from this VdoPlayer
    
    Parameters:
    
    listener - listener for the callback
  - removePlaybackEventListener
```
void removePlaybackEventListener(VdoPlayer.PlaybackEventListener listener)
```
    Remove a registered playback event listener from this VdoPlayer
    
    Parameters:
    
    listener - the listener to remove
  - stop
```
void stop()
```
    Stops the currently loaded video.
  - getAvailableTracks
```
Track[] getAvailableTracks()
```
    Returns the available tracks for the currently playing media.
    
    Returns:
    
    array containing available tracks, or empty array if no tracks are currently available
  - getSelectedTracks
```
Track[] getSelectedTracks()
```
    Returns the selected tracks for the currently playing media.
    
    Returns:
    
    array containing selected tracks, or empty array if no tracks are currently selected
  - setSelectedTracks
```
void setSelectedTracks(Track[] tracks)
```
    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.
    
    Parameters:
    
    tracks - the tracks to select
  - isAdaptive
```
boolean isAdaptive()
```
    Returns if the current playback is adaptive.
    
    Returns:
    
    true if player is adaptive, false otherwise
  - getCurrentMedia
```
MediaInfo getCurrentMedia()
```
    Returns a MediaInfo object containing info corresponding to the currently playing media.
    
    Returns:
    
    MediaInfo object corresponding to currently playing media, or null if no media is loaded
  - getPlaybackProperty
```
java.lang.Object getPlaybackProperty(java.lang.String propertyName)
```
    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.
    
    Parameters:
    
    propertyName - name of desired property
    
    Returns:
    
    requested property value as an object; null if not available

Interface VdoPlayer

Nested Class Summary

Field Summary

Method Summary

Field Detail

STATE_IDLE

STATE_BUFFERING

STATE_READY

STATE_ENDED

Method Detail

getPlaybackState

setPlayWhenReady

getPlayWhenReady

load

getCurrentTime

getBufferedTime

getDuration

isSpeedControlSupported

setPlaybackSpeed

getPlaybackSpeed

release

seekTo

addPlaybackEventListener

removePlaybackEventListener

stop

getAvailableTracks

getSelectedTracks

setSelectedTracks

isAdaptive

getCurrentMedia

getPlaybackProperty