Player (playkit API)

All Known Implementing Classes:

AdEnabledPlayerController, PlayerController, PlayerDecorator, PlayerDecoratorBase
```
public interface Player
```
Created by Noam Tamim @ Kaltura on 18/09/2016.

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface Player.Settings
Interface used for setting optional Player settings.

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`Player.Settings` Interface used for setting optional Player settings.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addEventListener(PKEvent.Listener listener, java.lang.Enum... events)` Add event listener to the player.
`void`	`addStateChangeListener(PKEvent.Listener listener)` Add state changed listener to the player.
`void`	`changeTrack(java.lang.String uniqueId)` Change current track, with specified one by uniqueId.
`void`	`destroy()` Should be called when you want to destroy the player.
`long`	`getBufferedPosition()`
`<T extends PKController> T`	`getController(java.lang.Class<T> type)` Generic getters for playkit controllers.
`long`	`getCurrentPosition()` Getter for the current playback position.
`long`	`getDuration()`
`PKMediaFormat`	`getMediaFormat()`
`float`	`getPlaybackRate()` get current player speed
`java.lang.String`	`getSessionId()` Get the Player's SessionId.
`Player.Settings`	`getSettings()` Get the Player's `Player.Settings` object, for setting some optional properties.
`PlayerView`	`getView()` The Player's View.
`boolean`	`isLive()`
`boolean`	`isPlaying()`
`void`	`onApplicationPaused()` Player lifecycle method.
`void`	`onApplicationResumed()` Player lifecycle method.
`void`	`onOrientationChanged()` Player lifecycle method.
`void`	`pause()` Pause playback of the media.
`void`	`play()` Start playback of the media.
`void`	`prepare(PKMediaConfig playerConfig)` Prepare the player for playback.
`void`	`replay()` Replay the media.
`void`	`seekTo(long position)` Seek player to the specified position.
`void`	`setPlaybackRate(float rate)` Change player speed (pitch = 1.0f by default)
`void`	`setVolume(float volume)` Change the volume of the current audio track.
`void`	`stop()` stop player and back to initial playback state.
`void`	`updatePluginConfig(java.lang.String pluginName, java.lang.Object pluginConfig)`

- Method Detail
  - getSettings
```
Player.Settings getSettings()
```
    Get the Player's Player.Settings object, for setting some optional properties.
    
    Returns:
    
    Player Settings.
  - prepare
```
void prepare(@NonNull
             PKMediaConfig playerConfig)
```
    Prepare the player for playback.
    
    Parameters:
    
    playerConfig - - media configurations to apply on the player.
  - updatePluginConfig
```
void updatePluginConfig(@NonNull
                        java.lang.String pluginName,
                        @Nullable
                        java.lang.Object pluginConfig)
```
  - onApplicationPaused
```
void onApplicationPaused()
```
    Player lifecycle method. Should be used when the application went to onPause();
  - onApplicationResumed
```
void onApplicationResumed()
```
    Player lifecycle method. Should be used when the application went to onResume();
  - onOrientationChanged
```
void onOrientationChanged()
```
    Player lifecycle method. Must be called when Activity onConfigurationChanged(Configuration newConfig) called.
  - destroy
```
void destroy()
```
    Should be called when you want to destroy the player.
  - stop
```
void stop()
```
    stop player and back to initial playback state.
  - play
```
void play()
```
    Start playback of the media.
  - pause
```
void pause()
```
    Pause playback of the media.
  - replay
```
void replay()
```
    Replay the media.
  - getView
```
PlayerView getView()
```
    The Player's View.
    
    Returns:
    
    - the view player attached to.
  - getCurrentPosition
```
long getCurrentPosition()
```
    Getter for the current playback position.
    
    Returns:
    
    - position of the player or Consts.POSITION_UNSET if position is unknown or player engine is null.
  - getDuration
```
long getDuration()
```
    Returns:
    
    - The total duration of current media or Consts.TIME_UNSET if the duration is unknown or player engine is null.
  - getBufferedPosition
```
long getBufferedPosition()
```
    Returns:
    
    - The buffered position of the current media, or Consts.POSITION_UNSET if the position is unknown or player engine is null.
  - setVolume
```
void setVolume(float volume)
```
    Change the volume of the current audio track. Accept values between 0 and 1. Where 0 is mute and 1 is maximum volume. If the volume parameter is higher then 1, it will be converted to 1. If the volume parameter is lower then 0, it be converted to 0.
    
    Parameters:
    
    volume - - volume to set.
  - isPlaying
```
boolean isPlaying()
```
    Returns:
    
    - true if player is playing, otherwise return false;
  - addEventListener
```
void addEventListener(@NonNull
                      PKEvent.Listener listener,
                      java.lang.Enum... events)
```
    Add event listener to the player.
    
    Parameters:
    
    listener - - event listener.
    
    events - - events the subscriber interested in.
  - addStateChangeListener
```
void addStateChangeListener(@NonNull
                            PKEvent.Listener listener)
```
    Add state changed listener to the player.
    
    Parameters:
    
    listener - - state changed listener
  - changeTrack
```
void changeTrack(java.lang.String uniqueId)
```
    Change current track, with specified one by uniqueId. If uniqueId is not valid or null, this will throw IllegalArgumentException. Example of the valid uniqueId for regular video track: Video:0,0,1. Example of the valid uniqueId for adaptive video track: Video:0,0,adaptive.
    
    Parameters:
    
    uniqueId - - the unique id of the new track that will play instead of the old one.
  - seekTo
```
void seekTo(long position)
```
    Seek player to the specified position.
    
    Parameters:
    
    position - - desired position.
  - getSessionId
```
java.lang.String getSessionId()
```
    Get the Player's SessionId. The SessionId is generated each time new media is set.
    
    Returns:
    
    Player's SessionId, as a String object.
  - isLive
```
boolean isLive()
```
  - getMediaFormat
```
PKMediaFormat getMediaFormat()
```
    Returns:
    
    - Getter for the current mediaFormat or null if the media format is not set yet
  - setPlaybackRate
```
void setPlaybackRate(float rate)
```
    Change player speed (pitch = 1.0f by default)
    
    Parameters:
    
    rate - - desired rate (ex. 0.5f 1.0f 1.5f, 2.0f).
  - getPlaybackRate
```
float getPlaybackRate()
```
    get current player speed
  - getController
```
<T extends PKController> T getController(java.lang.Class<T> type)
```
    Generic getters for playkit controllers.
    
    Parameters:
    
    type - - type of the controller you want to obtain.
    
    Returns:
    
    - the PKController instance if specified controller type exist, otherwise return null.

Interface Player

Nested Class Summary

Method Summary

Method Detail

getSettings

prepare

updatePluginConfig

onApplicationPaused

onApplicationResumed

onOrientationChanged

destroy

stop

play

pause

replay

getView

getCurrentPosition

getDuration

getBufferedPosition

setVolume

isPlaying

addEventListener

addStateChangeListener

changeTrack

seekTo

getSessionId

isLive

getMediaFormat

setPlaybackRate

getPlaybackRate

getController