ExoMediaPlayer (library API)

java.lang.Object
- Player.DefaultEventListener
- - com.devbrackets.android.exomedia.core.exoplayer.ExoMediaPlayer

public class ExoMediaPlayer
extends Player.DefaultEventListener

Field Summary

Fields
Modifier and Type Field and Description

protected float requestedVolume

Fields
Modifier and Type	Field and Description
`protected float`	`requestedVolume`

Constructor Summary

Constructors
Constructor and Description

ExoMediaPlayer(android.content.Context context)

Constructors
Constructor and Description
`ExoMediaPlayer(android.content.Context context)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addAnalyticsListener(AnalyticsListener listener)` Adds an `AnalyticsListener` to receive analytics events.
`void`	`addListener(ExoPlayerListener listener)`
`void`	`blockingClearSurface()` Deprecated. use `clearSurface()` as this is no longer blocking
`protected void`	`blockingSendMessages(java.util.List<PlayerMessage> messages)` This was pulled from the Deprecated ExoPlayerImpl#blockingSendMessages method
`void`	`clearSelectedTracks(ExoMedia.RendererType type)` Clear all selected tracks for the specified renderer and re-enable all renderers so the player can select the default track.
`void`	`clearSurface()`
`void`	`forcePrepare()`
`protected <any>`	`generateDrmSessionManager()` Generates the `DrmSessionManager` to use with the `RendererProvider`.
`AnalyticsCollector`	`getAnalyticsCollector()` Returns the `AnalyticsCollector` used for collecting analytics events.
`int`	`getAudioSessionId()`
`java.util.Map<ExoMedia.RendererType,TrackGroupArray>`	`getAvailableTracks()` Retrieves a list of available tracks
`BandwidthMeter`	`getBandwidthMeter()`
`int`	`getBufferedPercentage()`
`long`	`getCurrentPosition()`
`long`	`getCurrentPosition(boolean limitToCurrentWindow)` TODO: Expose this Returns the position in the media.
`long`	`getDuration()`
`protected ExoMedia.RendererType`	`getExoMediaRendererType(int exoPlayerTrackType)`
`ExoPlayer`	`getExoPlayer()`
`protected com.devbrackets.android.exomedia.core.exoplayer.ExoMediaPlayer.ExoPlayerRendererTracksInfo`	`getExoPlayerTracksInfo(ExoMedia.RendererType type, int groupIndex, MappingTrackSelector.MappedTrackInfo mappedTrackInfo)`
`protected int`	`getExoPlayerTrackType(ExoMedia.RendererType type)`
`float`	`getPlaybackSpeed()`
`int`	`getPlaybackState()`
`boolean`	`getPlayWhenReady()`
`int`	`getSelectedTrackIndex(ExoMedia.RendererType type)` Deprecated. Use `#getSelectedTrackIndex(RendererType, int)`
`int`	`getSelectedTrackIndex(ExoMedia.RendererType type, int groupIndex)`
`android.view.Surface`	`getSurface()`
`float`	`getVolume()`
`WindowInfo`	`getWindowInfo()`
`boolean`	`isRendererEnabled(ExoMedia.RendererType type)` Return true if at least one renderer for the given type is enabled
`void`	`onPlayerError(ExoPlaybackException exception)`
`void`	`onPlayerStateChanged(boolean playWhenReady, int state)`
`void`	`prepare()`
`void`	`release()`
`void`	`removeAnalyticsListener(AnalyticsListener listener)` Removes an `AnalyticsListener`.
`void`	`removeListener(ExoPlayerListener listener)`
`boolean`	`restart()` Seeks to the beginning of the media, and plays it.
`void`	`seekTo(long positionMs)`
`void`	`seekTo(long positionMs, boolean limitToCurrentWindow)` TODO: Expose this Seeks to the specified position in the media currently loaded specified by `positionMs`.
`protected void`	`sendMessage(int renderType, int messageType, java.lang.Object message)`
`protected void`	`sendMessage(int renderType, int messageType, java.lang.Object message, boolean blocking)`
`void`	`setAudioStreamType(int streamType)`
`void`	`setBufferUpdateListener(OnBufferUpdateListener listener)`
`void`	`setCaptionListener(CaptionListener listener)`
`void`	`setDrmCallback(MediaDrmCallback drmCallback)` Sets the `MediaDrmCallback` to use when handling DRM for media.
`void`	`setInternalErrorListener(InternalErrorListener listener)`
`void`	`setMediaSource(MediaSource source)`
`void`	`setMetadataListener(MetadataListener listener)`
`boolean`	`setPlaybackSpeed(float speed)`
`void`	`setPlayWhenReady(boolean playWhenReady)`
`void`	`setRendererEnabled(ExoMedia.RendererType type, boolean enabled)`
`void`	`setRepeatMode(int repeatMode)`
`void`	`setSelectedTrack(ExoMedia.RendererType type, int index)` Deprecated. Use `#setSelectedTrack(RendererType, int, int)`
`void`	`setSelectedTrack(ExoMedia.RendererType type, int groupIndex, int trackIndex)`
`void`	`setSurface(android.view.Surface surface)`
`protected void`	`setupDamSessionManagerAnalytics(<any> drmSessionManager)`
`void`	`setUri(android.net.Uri uri)`
`void`	`setVolume(float volume)`
`void`	`setWakeMode(android.content.Context context, int mode)` This function has the MediaPlayer access the low-level power manager service to control the device's power usage while playing is occurring.
`protected void`	`stayAwake(boolean awake)` Used with playback state changes to correctly acquire and release the wakelock if the user has enabled it with `setWakeMode(Context, int)`.
`void`	`stop()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - requestedVolume
```
protected float requestedVolume
```
- Constructor Detail
  - ExoMediaPlayer
```
public ExoMediaPlayer(android.content.Context context)
```
- Method Detail
  - onPlayerStateChanged
```
public void onPlayerStateChanged(boolean playWhenReady,
                                 int state)
```
  - onPlayerError
```
public void onPlayerError(ExoPlaybackException exception)
```
  - setDrmCallback
```
public void setDrmCallback(MediaDrmCallback drmCallback)
```
    Sets the MediaDrmCallback to use when handling DRM for media. This should be called before specifying the videos uri or path
    NOTE: DRM is only supported on API 18 +
    
    Parameters:
    
    drmCallback - The callback to use when handling DRM media
  - setUri
```
public void setUri(android.net.Uri uri)
```
  - setMediaSource
```
public void setMediaSource(MediaSource source)
```
  - addListener
```
public void addListener(ExoPlayerListener listener)
```
  - removeListener
```
public void removeListener(ExoPlayerListener listener)
```
  - setBufferUpdateListener
```
public void setBufferUpdateListener(OnBufferUpdateListener listener)
```
  - setInternalErrorListener
```
public void setInternalErrorListener(InternalErrorListener listener)
```
  - setCaptionListener
```
public void setCaptionListener(CaptionListener listener)
```
  - setMetadataListener
```
public void setMetadataListener(MetadataListener listener)
```
  - setSurface
```
public void setSurface(android.view.Surface surface)
```
  - getSurface
```
public android.view.Surface getSurface()
```
  - getExoPlayer
```
public ExoPlayer getExoPlayer()
```
  - getBandwidthMeter
```
public BandwidthMeter getBandwidthMeter()
```
  - getAnalyticsCollector
```
public AnalyticsCollector getAnalyticsCollector()
```
    Returns the AnalyticsCollector used for collecting analytics events.
  - addAnalyticsListener
```
public void addAnalyticsListener(AnalyticsListener listener)
```
    Adds an AnalyticsListener to receive analytics events.
    
    Parameters:
    
    listener - The listener to be added.
  - removeAnalyticsListener
```
public void removeAnalyticsListener(AnalyticsListener listener)
```
    Removes an AnalyticsListener.
    
    Parameters:
    
    listener - The listener to be removed.
  - clearSurface
```
public void clearSurface()
```
  - blockingClearSurface
```
@Deprecated
public void blockingClearSurface()
```
    Deprecated. use clearSurface() as this is no longer blocking
  - getAvailableTracks
```
public java.util.Map<ExoMedia.RendererType,TrackGroupArray> getAvailableTracks()
```
    Retrieves a list of available tracks
    
    Returns:
    
    A list of available tracks associated with each type
  - getSelectedTrackIndex
```
public int getSelectedTrackIndex(ExoMedia.RendererType type)
```
    Deprecated. Use #getSelectedTrackIndex(RendererType, int)
  - getSelectedTrackIndex
```
public int getSelectedTrackIndex(ExoMedia.RendererType type,
                                 int groupIndex)
```
  - setSelectedTrack
```
@Deprecated
public void setSelectedTrack(ExoMedia.RendererType type,
                                          int index)
```
    Deprecated. Use #setSelectedTrack(RendererType, int, int)
  - setSelectedTrack
```
public void setSelectedTrack(ExoMedia.RendererType type,
                             int groupIndex,
                             int trackIndex)
```
  - clearSelectedTracks
```
public void clearSelectedTracks(ExoMedia.RendererType type)
```
    Clear all selected tracks for the specified renderer and re-enable all renderers so the player can select the default track.
    
    Parameters:
    
    type - The renderer type
  - setRendererEnabled
```
public void setRendererEnabled(ExoMedia.RendererType type,
                               boolean enabled)
```
  - isRendererEnabled
```
public boolean isRendererEnabled(ExoMedia.RendererType type)
```
    Return true if at least one renderer for the given type is enabled
    
    Parameters:
    
    type - The renderer type
    
    Returns:
    
    true if at least one renderer for the given type is enabled
  - setVolume
```
public void setVolume(float volume)
```
  - getVolume
```
public float getVolume()
```
  - setAudioStreamType
```
public void setAudioStreamType(int streamType)
```
  - forcePrepare
```
public void forcePrepare()
```
  - prepare
```
public void prepare()
```
  - stop
```
public void stop()
```
  - setPlayWhenReady
```
public void setPlayWhenReady(boolean playWhenReady)
```
  - seekTo
```
public void seekTo(long positionMs)
```
  - seekTo
```
public void seekTo(long positionMs,
                   boolean limitToCurrentWindow)
```
    TODO: Expose this Seeks to the specified position in the media currently loaded specified by positionMs. If limitToCurrentWindow is true then a seek won't be allowed to span across windows. This should only be different if the media in playback has multiple windows (e.g. in the case of using a ConcatenatingMediaSource with more than 1 source)
    
    Parameters:
    
    positionMs - The position to seek to in the media
    
    limitToCurrentWindow - true to only seek in the current window
  - restart
```
public boolean restart()
```
    Seeks to the beginning of the media, and plays it. This method will not succeed if playback state is not ExoPlayer.STATE_IDLE or ExoPlayer.STATE_ENDED.
    
    Returns:
    
    true if the media was successfully restarted, otherwise false
  - release
```
public void release()
```
  - getPlaybackState
```
public int getPlaybackState()
```
  - getAudioSessionId
```
public int getAudioSessionId()
```
  - setPlaybackSpeed
```
public boolean setPlaybackSpeed(float speed)
```
  - getPlaybackSpeed
```
public float getPlaybackSpeed()
```
  - getCurrentPosition
```
public long getCurrentPosition()
```
  - getCurrentPosition
```
public long getCurrentPosition(boolean limitToCurrentWindow)
```
    TODO: Expose this Returns the position in the media. If limitToCurrentWindow is true then the position in the current window will be returned, otherwise the total position across all windows will be returned. These should only be different if the media in playback has multiple windows (e.g. in the case of using a ConcatenatingMediaSource with more than 1 source)
    
    Parameters:
    
    limitToCurrentWindow - If true the position within the current window will be returned
    
    Returns:
    
    The current position in the media
  - getDuration
```
public long getDuration()
```
  - getBufferedPercentage
```
public int getBufferedPercentage()
```
  - getWindowInfo
```
public WindowInfo getWindowInfo()
```
  - getPlayWhenReady
```
public boolean getPlayWhenReady()
```
  - setWakeMode
```
public void setWakeMode(android.content.Context context,
                        int mode)
```
    This function has the MediaPlayer access the low-level power manager service to control the device's power usage while playing is occurring. The parameter is a combination of PowerManager wake flags. Use of this method requires Manifest.permission.WAKE_LOCK permission. By default, no attempt is made to keep the device awake during playback.
    
    Parameters:
    
    context - the Context to use
    
    mode - the power/wake mode to set
    
    See Also:
    
    PowerManager
  - setRepeatMode
```
public void setRepeatMode(int repeatMode)
```
  - getExoPlayerTrackType
```
protected int getExoPlayerTrackType(ExoMedia.RendererType type)
```
  - getExoMediaRendererType
```
protected ExoMedia.RendererType getExoMediaRendererType(int exoPlayerTrackType)
```
  - getExoPlayerTracksInfo
```
protected com.devbrackets.android.exomedia.core.exoplayer.ExoMediaPlayer.ExoPlayerRendererTracksInfo getExoPlayerTracksInfo(ExoMedia.RendererType type,
                                                                                                                            int groupIndex,
                                                                                                                            MappingTrackSelector.MappedTrackInfo mappedTrackInfo)
```
  - sendMessage
```
protected void sendMessage(int renderType,
                           int messageType,
                           java.lang.Object message)
```
  - sendMessage
```
protected void sendMessage(int renderType,
                           int messageType,
                           java.lang.Object message,
                           boolean blocking)
```
  - blockingSendMessages
```
protected void blockingSendMessages(java.util.List<PlayerMessage> messages)
```
    This was pulled from the Deprecated ExoPlayerImpl#blockingSendMessages method
    
    Parameters:
    
    messages - The messages
  - stayAwake
```
protected void stayAwake(boolean awake)
```
    Used with playback state changes to correctly acquire and release the wakelock if the user has enabled it with setWakeMode(Context, int). If the wakeLock is null then no action will be performed.
    
    Parameters:
    
    awake - True if the wakelock should be acquired
  - generateDrmSessionManager
```
protected <any> generateDrmSessionManager()
```
    Generates the DrmSessionManager to use with the RendererProvider. This will return null on API's <
    
    Returns:
    
    The DrmSessionManager to use or null
  - setupDamSessionManagerAnalytics
```
protected void setupDamSessionManagerAnalytics(<any> drmSessionManager)
```

Class ExoMediaPlayer

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

requestedVolume

Constructor Detail

ExoMediaPlayer

Method Detail

onPlayerStateChanged

onPlayerError

setDrmCallback

setUri

setMediaSource

addListener

removeListener

setBufferUpdateListener

setInternalErrorListener

setCaptionListener

setMetadataListener

setSurface

getSurface

getExoPlayer

getBandwidthMeter

getAnalyticsCollector

addAnalyticsListener

removeAnalyticsListener

clearSurface

blockingClearSurface

getAvailableTracks

getSelectedTrackIndex

getSelectedTrackIndex

setSelectedTrack

setSelectedTrack

clearSelectedTracks

setRendererEnabled

isRendererEnabled

setVolume

getVolume

setAudioStreamType

forcePrepare

prepare

stop

setPlayWhenReady

seekTo

seekTo

restart

release

getPlaybackState

getAudioSessionId

setPlaybackSpeed

getPlaybackSpeed

getCurrentPosition

getCurrentPosition

getDuration

getBufferedPercentage

getWindowInfo

getPlayWhenReady

setWakeMode

setRepeatMode

getExoPlayerTrackType

getExoMediaRendererType

getExoPlayerTracksInfo

sendMessage

sendMessage

blockingSendMessages

stayAwake

generateDrmSessionManager

setupDamSessionManagerAnalytics