IPlayer

Type Parameters:

P - subClass

All Superinterfaces:

IPlayerBase

All Known Implementing Classes:

APlayer, APlayerBinding, Player, PlayerBinding
```
public interface IPlayer<P extends IPlayer>
extends IPlayerBase
```
Interface Player

See Also:

Player, PlayerBinding

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static interface IPlayer.Listener

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`IPlayer.Listener`

Field Summary
- Fields inherited from interface com.jcodeing.kmedia.IPlayerBase
  STATE_BUFFERING, STATE_ENDED, STATE_GOT_SOURCE, STATE_IDLE, STATE_READY

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addListener(IPlayer.Listener listener)`
`int`	`calibrateCurrentPositionUnitIndex(long position)` generally not use(player inside Will automatically maintain current [position unit] index calibrate)
`void`	`clearAB()` Clear A-B all tag Tips: setClearAB(false) also don't manual invoke clearAB(), will save all tag.
`boolean`	`fastForwardRewind(long ms)`
`AudioMgrHelper`	`getAudioMgrHelper()`
`java.lang.String`	`getCurrentMediaId()` Returns current media id (custom or default[string representation of this play uri])
`int`	`getCurrentPositionUnitIndex()`
`IMediaQueue`	`getMediaQueue()` get a media queue, if not `setMediaQueue(IMediaQueue)`, it return default media queue
`P`	`init(IMediaPlayer mediaPlayer)` Init internal media player
`IMediaPlayer`	`internalPlayer()` Get a internal mediaPlayer
`boolean`	`play()`
`boolean`	`play(IMediaItem mediaItem)`
`boolean`	`play(android.net.Uri uri)`
`boolean`	`playMediaId(java.lang.String mediaId)`
`boolean`	`prepare(IMediaItem mediaItem)`
`boolean`	`prepare(android.net.Uri uri)`
`boolean`	`prepareMediaId(java.lang.String mediaId)`
`void`	`removeListener(IPlayer.Listener listener)`
`boolean`	`seekTo(long ms)` internal call `seekTo(long, int)` Max processing level
`boolean`	`seekTo(long ms, int processingLevel)` Support custom processing level of seekTo
`void`	`seekToPending(long ms)` set a pending seekTo in before start() dispose
`long`	`seekToPositionUnitIndex(int posUnitIndex)` Seeks to specified PositionUnitIndex
`long`	`seekToProgress(int progress, int progressMax)` Seeks to specified progress
`P`	`setAB(long startPos, long endPos)` Set A-B start position and end position with reset ab all tag
`P`	`setAB(long startPos, long endPos, int loopMode, int loopInterval)` Set A-B internal call `setAB(long, long)`, `setABLoop(int, int)` param loopMode,loopInterval can use `C.PARAM_ORIGINAL` keeping the original values param loopMode,loopInterval can use `C.PARAM_UNSET`/`C.PARAM_RESET` unset/reset values
`P`	`setABLoop(int loopMode, int loopInterval)` Set A-B loop param loopMode,loopInterval can use `C.PARAM_ORIGINAL` keeping the original values param loopMode,loopInterval can use `C.PARAM_UNSET`/`C.PARAM_RESET` unset/reset values
`P`	`setClearAB(boolean autoClear)` Set auto clear A-B all tag(when A-B finish) WARNING: If for special reasons cause A-B is not finish, will don't auto clear.
`void`	`setCurrentPositionUnitIndex(int posUnitIndex)` generally not use(player inside Will automatically maintain current [position unit] index)
`P`	`setEnabledAudioFocusManage(boolean enabled)`
`P`	`setEnabledPositionUnitLoop(boolean enabled, int loopMode, int loopInterval)` Set the enabled,loopMode,loopInterval of this position unit loop, with reset position unit looped count tag param loopMode,loopInterval can use `C.PARAM_ORIGINAL` keeping the original values param loopMode,loopInterval can use `C.PARAM_UNSET`/`C.PARAM_RESET` unset/reset values
`P`	`setEnabledWifiLock(boolean enabled)` Set enabled wifi lock, to hold a Wifi lock, which prevents the player from going to sleep while the media is playing.
`void`	`setMediaQueue(IMediaQueue mediaQueue)` set a new media queue for player
`P`	`setPositionUnitList(IPositionUnitList posUnitList)` WARNING: must ensure `IPositionUnitList.getMediaId()` equals `getCurrentMediaId()` can work normally
`P`	`setPositionUnitLoopIndexList(java.util.ArrayList<java.lang.Integer> posUnitLoopIndexList)` WARNING: media source change with specify to loop of [position unit] index list will be reset
`P`	`setUpdatePlayProgressDelayMs(long updatePlayProgressDelayMs)` Sets the updatePlayProgress delay.
`P`	`shouldAutoPlayWhenSeekComplete(boolean shouldAutoPlayWhenSeekComplete)` Generally used in front of the seekTo...(.) to ensure that seek complete to auto play immediately after
`void`	`shutdown()` Shut down player (release all resources)

Methods inherited from interface com.jcodeing.kmedia.IPlayerBase
clearVideo, getCurrentPosition, getDuration, getPlaybackSpeed, getPlaybackState, getVolume, isPlayable, isPlaying, pause, release, reset, setPlaybackSpeed, setVideo, setVideo, setVolume, start, stop

- Method Detail
  - internalPlayer
```
IMediaPlayer internalPlayer()
```
    Get a internal mediaPlayer
```
   Player run core by internal maintaining mediaPlayer.
   In general is not recommended unless you want to operate some special functions.
   * note that internalPlayer and Player
   * at the same time operating possible when the incompatibilities
 
```
  - init
```
P init(IMediaPlayer mediaPlayer)
```
    Init internal media player
  - prepare
```
boolean prepare(android.net.Uri uri)
```
  - prepare
```
boolean prepare(IMediaItem mediaItem)
```
  - prepareMediaId
```
boolean prepareMediaId(java.lang.String mediaId)
```
  - play
```
boolean play()
```
  - play
```
boolean play(android.net.Uri uri)
```
  - play
```
boolean play(IMediaItem mediaItem)
```
  - playMediaId
```
boolean playMediaId(java.lang.String mediaId)
```
  - shutdown
```
void shutdown()
```
    Shut down player (release all resources)
  - seekTo
```
boolean seekTo(long ms,
               int processingLevel)
```
    Support custom processing level of seekTo
    Parameters:
    processingLevel - The greater the level with processing the more things
    
    1: Callback IPlayer.Listener.onPlayProgress(long, long)
    
    2: Call calibrateCurrentPositionUnitIndex(long)
  - seekTo
```
boolean seekTo(long ms)
```
    internal call seekTo(long, int) Max processing level
    
    Specified by:
    
    seekTo in interface IPlayerBase
  - fastForwardRewind
```
boolean fastForwardRewind(long ms)
```
    Parameters:
    ms - fastForwardMs/RewindMs
    
    +ms: fastForward
    .fastForwardRewind(1000)->fast forward 1 second
    -ms: RewindMs
    .fastForwardRewind(-1000)->rewind 1 second
  - shouldAutoPlayWhenSeekComplete
```
P shouldAutoPlayWhenSeekComplete(boolean shouldAutoPlayWhenSeekComplete)
```
    Generally used in front of the seekTo...(.) to ensure that seek complete to auto play immediately after
```
   *IPlayerBase.start() method with shouldAutoPlayWhenSeekComplete(true)
   *IPlayerBase.pause() with shouldAutoPlayWhenSeekComplete(false)
 
```
  - seekToPending
```
void seekToPending(long ms)
```
    set a pending seekTo in before start() dispose
  - seekToProgress
```
long seekToProgress(int progress,
                    int progressMax)
```
    Seeks to specified progress
    
    Parameters:
    
    progress - current progress
    
    progressMax - the upper limit of this progress range.
    
    Returns:
    
    seekTo position (>=0), or -1 if seekTo Failure.
  - setUpdatePlayProgressDelayMs
```
P setUpdatePlayProgressDelayMs(long updatePlayProgressDelayMs)
```
    Sets the updatePlayProgress delay.
    More accurate to handle progress type work.
    Parameters:
    
    updatePlayProgressDelayMs - value>=0?value:default[1000 - (position % 1000)]
  - getCurrentMediaId
```
java.lang.String getCurrentMediaId()
```
    Returns current media id (custom or default[string representation of this play uri])
  - setEnabledWifiLock
```
P setEnabledWifiLock(boolean enabled)
```
    Set enabled wifi lock, to hold a Wifi lock, which prevents the player from going to sleep while the media is playing.
    RequiresPermission(Manifest.permission.WAKE_LOCK)
    AndroidManifest.xml add below
```
 
 <uses-permission android:name="android.permission.WAKE_LOCK"/>
 
```
  - setEnabledAudioFocusManage
```
P setEnabledAudioFocusManage(boolean enabled)
```
  - getAudioMgrHelper
```
AudioMgrHelper getAudioMgrHelper()
```
  - setPositionUnitList
```
P setPositionUnitList(IPositionUnitList posUnitList)
```
    WARNING: must ensure IPositionUnitList.getMediaId() equals getCurrentMediaId() can work normally
    
    Parameters:
    
    posUnitList - [Position Unit] List
  - getCurrentPositionUnitIndex
```
int getCurrentPositionUnitIndex()
```
    Returns:
    
    current position unit index OR -1(unset | waiting state)
  - setCurrentPositionUnitIndex
```
void setCurrentPositionUnitIndex(int posUnitIndex)
```
    generally not use(player inside Will automatically maintain current [position unit] index)
    If you want to calibrate,can call calibrateCurrentPositionUnitIndex(long)
  - seekToPositionUnitIndex
```
long seekToPositionUnitIndex(int posUnitIndex)
```
    Seeks to specified PositionUnitIndex
    
    Returns:
    
    seekTo position (>=0), or -1 if seekTo Failure.
  - calibrateCurrentPositionUnitIndex
```
int calibrateCurrentPositionUnitIndex(long position)
```
    generally not use(player inside Will automatically maintain current [position unit] index calibrate)
    
    Parameters:
    
    position - currentPosition or -1[position < 0 || position > getDuration()] (auto getCurrentPosition())
    
    Returns:
    
    calibrated PositionUnitIndex or -1(not calibrate or calibrate result not present)
  - setEnabledPositionUnitLoop
```
P setEnabledPositionUnitLoop(boolean enabled,
                             int loopMode,
                             int loopInterval)
```
    Set the enabled,loopMode,loopInterval of this position unit loop, with reset position unit looped count tag
    *param loopMode,loopInterval can use C.PARAM_ORIGINAL keeping the original values
    *param loopMode,loopInterval can use C.PARAM_UNSET/C.PARAM_RESET unset/reset values
    Parameters:
    
    enabled - True [position unit] loop is enabled, false otherwise.
    loopMode - [Position unit] loop mode
    
    -1 disable
    -8 infinity loop
    0++ specified loop
    loopInterval - [Position unit] loop interval
    
    See Also:
    
    setUpdatePlayProgressDelayMs(long)
  - setPositionUnitLoopIndexList
```
P setPositionUnitLoopIndexList(java.util.ArrayList<java.lang.Integer> posUnitLoopIndexList)
```
    WARNING: media source change with specify to loop of [position unit] index list will be reset
    
    Parameters:
    
    posUnitLoopIndexList - specify to loop of [position unit] index list
  - setAB
```
P setAB(long startPos,
        long endPos)
```
    Set A-B start position and end position with reset ab all tag
    
    Parameters:
    
    startPos - [A-B] start position (Ms)
    
    endPos - [A-B] end position (Ms)
    
    Returns:
    
    IPlayer !setAB but does not play. You must call play(?) to play.
    
    See Also:
    
    play(), play(Uri)
  - setABLoop
```
P setABLoop(int loopMode,
            int loopInterval)
```
    Set A-B loop
    *param loopMode,loopInterval can use C.PARAM_ORIGINAL keeping the original values
    *param loopMode,loopInterval can use C.PARAM_UNSET/C.PARAM_RESET unset/reset values
    Parameters:
    loopMode - [A-B] loop mode
    
    -1 disable
    -8 infinity loop
    0++ specified loop
    loopInterval - [A-B] loop interval (S)
    
    Returns:
    
    IPlayer !setAB but does not play. You must call play(?) to play.
    
    See Also:
    
    play(), play(Uri)
  - setAB
```
P setAB(long startPos,
        long endPos,
        int loopMode,
        int loopInterval)
```
    Set A-B internal call setAB(long, long), setABLoop(int, int)
    *param loopMode,loopInterval can use C.PARAM_ORIGINAL keeping the original values
    *param loopMode,loopInterval can use C.PARAM_UNSET/C.PARAM_RESET unset/reset values
    Parameters:
    
    startPos - [A-B] start position (Ms)
    
    endPos - [A-B] end position (Ms)
    loopMode - [A-B] loop mode
    
    -1 disable
    -8 infinity loop
    0++ specified loop
    loopInterval - [A-B] loop interval (S)
    
    Returns:
    
    IPlayer !setAB but does not play. You must call play(?) to play.
    
    See Also:
    
    play(), play(Uri)
  - setClearAB
```
P setClearAB(boolean autoClear)
```
    Set auto clear A-B all tag(when A-B finish)
    WARNING: If for special reasons cause A-B is not finish, will don't auto clear.
    
    See Also:
    
    clearAB()
  - clearAB
```
void clearAB()
```
    Clear A-B all tag
    Tips: setClearAB(false) also don't manual invoke clearAB(), will save all tag. invoke again play(?) continue play A-B for specified ab tag.
    
    See Also:
    
    setClearAB(boolean)
  - setMediaQueue
```
void setMediaQueue(IMediaQueue mediaQueue)
```
    set a new media queue for player
    
    Parameters:
    
    mediaQueue - IMediaQueue
  - getMediaQueue
```
IMediaQueue getMediaQueue()
```
    get a media queue, if not setMediaQueue(IMediaQueue), it return default media queue
    
    Returns:
    
    IMediaQueue
  - addListener
```
void addListener(IPlayer.Listener listener)
```
    Parameters:
    listener - IPlayer.Listener
    
    new PlayerListener( )
    custom implements IPlayer.Listener
  - removeListener
```
void removeListener(IPlayer.Listener listener)
```
    Parameters:
    
    listener - param==null -> clear()

Interface IPlayer<P extends IPlayer>

Nested Class Summary

Field Summary

Fields inherited from interface com.jcodeing.kmedia.IPlayerBase

Method Summary

Methods inherited from interface com.jcodeing.kmedia.IPlayerBase

Method Detail

internalPlayer

init

prepare

prepare

prepareMediaId

play

play

play

playMediaId

shutdown

seekTo

seekTo

fastForwardRewind

shouldAutoPlayWhenSeekComplete

seekToPending

seekToProgress

setUpdatePlayProgressDelayMs

getCurrentMediaId

setEnabledWifiLock

setEnabledAudioFocusManage

getAudioMgrHelper

setPositionUnitList

getCurrentPositionUnitIndex

setCurrentPositionUnitIndex

seekToPositionUnitIndex

calibrateCurrentPositionUnitIndex

setEnabledPositionUnitLoop

setPositionUnitLoopIndexList

setAB

setABLoop

setAB

setClearAB

clearAB

setMediaQueue

getMediaQueue

addListener

removeListener