public interface IPlayer
Modifier and Type | Interface and Description |
---|---|
static interface |
IPlayer.ConvertURLCallback
URL conversion callback.
|
static class |
IPlayer.IPResolveType
IP resolve type
|
static class |
IPlayer.MirrorMode
Mirroring modes
|
static interface |
IPlayer.OnChooseTrackIndexListener |
static interface |
IPlayer.OnCompletionListener
Playback completion callback.
|
static interface |
IPlayer.OnErrorListener
Error callback.
|
static interface |
IPlayer.OnInfoListener
Notification callback.
|
static interface |
IPlayer.OnLoadingStatusListener
Loading status callback.
|
static interface |
IPlayer.OnPreparedListener
Preparation success callback.
|
static interface |
IPlayer.OnPreRenderFrameCallback
Prerender frame callback.
|
static interface |
IPlayer.OnRenderFrameCallback
Render frame callback
|
static interface |
IPlayer.OnRenderingStartListener
Rendering start callback.
|
static interface |
IPlayer.OnReportEventListener
report event listener
|
static interface |
IPlayer.OnSeekCompleteListener
Seeking completion callback.
|
static interface |
IPlayer.OnSeiDataListener
SEI data callback.
|
static interface |
IPlayer.OnSnapShotListener
Snapshot creation result callback.
|
static interface |
IPlayer.OnStateChangedListener
Player status update callback.
|
static interface |
IPlayer.OnSubtitleDisplayListener
Subtitle display callback.
|
static interface |
IPlayer.OnThumbnailListener
Thumbnail image retrieval callback.
|
static interface |
IPlayer.OnTrackChangedListener
Stream switchover callback.
|
static interface |
IPlayer.OnTrackReadyListener
Stream preparation success callback.
|
static interface |
IPlayer.OnVideoRenderedListener
video render callback
|
static interface |
IPlayer.OnVideoSizeChangedListener
Video size change callback.
|
static class |
IPlayer.Option
player available options
|
static class |
IPlayer.PropertyKey
The key to get property
|
static class |
IPlayer.RenderFrameCallbackConfig |
static class |
IPlayer.RotateMode
Rotate modes
|
static class |
IPlayer.ScaleMode
Zoom modes
|
static class |
IPlayer.SeekMode
Seeking modes
|
Modifier and Type | Field and Description |
---|---|
static int |
completion
The player has completed playing the video or audio.
|
static int |
error
The player has an error.
|
static int |
idle
Blank.
|
static int |
initalized
Initialized.
|
static int |
paused
The player is paused.
|
static int |
prepared
Prepared.
|
static int |
started
The player is playing video or audio.
|
static int |
stopped
The player is stopped.
|
static int |
unknow
Unknown status.
|
Modifier and Type | Method and Description |
---|---|
void |
addExtSubtitle(java.lang.String url)
Add external subtitles
|
void |
clearScreen()
Clear the screen.
|
TrackInfo |
currentTrack(int type)
Deprecated.
|
TrackInfo |
currentTrack(TrackInfo.Type type)
Query the playing track info according to the specified track type.
|
void |
enableHardwareDecoder(boolean enable)
Enable or disable hardware decoding.
|
java.lang.String |
getCacheFilePath(java.lang.String URL)
Query the name of a cached file with the specified URL.
|
java.lang.String |
getCacheFilePath(java.lang.String vid,
java.lang.String format,
java.lang.String definition,
int previewTime)
Query the name of a cached file with the specified VID.
|
PlayerConfig |
getConfig()
Query the player configuration.
|
long |
getDuration()
Query the total length of the stream.
|
MediaInfo |
getMediaInfo()
Query media information.
|
IPlayer.MirrorMode |
getMirrorMode()
Query the current mirroring mode.
|
long |
getNativeContextAddr() |
java.lang.Object |
getOption(IPlayer.Option key)
gets the player's options parameters
|
java.lang.String |
getPlayerName()
Gets the name of the player used when playing
|
java.lang.String |
getPropertyString(IPlayer.PropertyKey key)
Get information by key.
|
IPlayer.RotateMode |
getRotateMode()
Query the current rotate mode.
|
IPlayer.ScaleMode |
getScaleMode()
Query the current zoom mode.
|
float |
getSpeed()
Query the playback speed.
|
int |
getVideoHeight()
Query the height of the video.
|
int |
getVideoRotation()
Query the rotate angle of the video.
|
int |
getVideoWidth()
Query the width of the video.
|
float |
getVolume()
Query the volume of the player.
|
boolean |
isAutoPlay()
Query whether autoplay is enabled.
|
boolean |
isLoop()
Query whether loop playback is enabled.
|
boolean |
isMute() |
void |
pause()
Pause the player.
|
void |
prepare()
Prepare the player.
|
void |
redraw()
Deprecated.
|
void |
release()
Release.
|
void |
reload()
Reload.
|
void |
reset()
Reset.
|
void |
seekTo(long position)
Specify a position for inaccurate seeking.
|
void |
seekTo(long position,
IPlayer.SeekMode seekMode)
Seek to a specified position.
|
void |
selectExtSubtitle(int trackIndex,
boolean select)
Select external subtitles
|
void |
selectTrack(int trackInfoIndex)
Specify a stream to play.
|
void |
selectTrack(int trackInfoIndex,
boolean accurate)
Specify a stream to play.
|
void |
sendCustomEvent(java.lang.String args)
Sends a user-defined event, which will be called back via
IPlayer.OnReportEventListener . |
void |
setAutoPlay(boolean on)
Enable autoplay.
|
void |
setCacheConfig(CacheConfig cacheConfig)
Configure cache settings.
|
void |
setConfig(PlayerConfig config)
Modify the player configuration.
|
void |
setDefaultBandWidth(int bandWidth)
Set the default playback bitrate for multi-bit rate.
|
void |
setDisplay(android.view.SurfaceHolder holder)
Set SurfaceHolder.
|
void |
setDisplayView(AliDisplayView view) |
void |
setDrmCallback(DrmCallback callback)
set drm request callback.
|
void |
setFastStart(boolean open)
set fast start
|
void |
setFilterConfig(FilterConfig filterConfig)
Set filter config.
|
void |
setFilterInvalid(java.lang.String target,
boolean invalid)
disable/enable filter.
|
void |
setIPResolveType(IPlayer.IPResolveType type)
set ip resolve type
|
void |
setLoop(boolean on)
Enable loop playback.
|
void |
setMaxAccurateSeekDelta(int delta)
set the maximum interval of precision seek.
|
void |
setMirrorMode(IPlayer.MirrorMode mirrorMode)
Set a mirroring mode
|
void |
setMute(boolean on)
Mute the player.
|
void |
setOnChooseTrackIndexListener(IPlayer.OnChooseTrackIndexListener l) |
void |
setOnCompletionListener(IPlayer.OnCompletionListener l)
Set a playback completion callback.
|
void |
setOnErrorListener(IPlayer.OnErrorListener l)
Set an error callback.
|
void |
setOnInfoListener(IPlayer.OnInfoListener l)
Set a notification callback.
|
void |
setOnLoadingStatusListener(IPlayer.OnLoadingStatusListener l)
Set a loading status callback.
|
void |
setOnPreparedListener(IPlayer.OnPreparedListener l)
Set a preparation success callback.
|
void |
setOnPreRenderFrameCallback(IPlayer.OnPreRenderFrameCallback callback)
Set prerender frame callback.
|
void |
setOnRenderFrameCallback(IPlayer.OnRenderFrameCallback callback)
Set the render frame callback.
|
void |
setOnRenderingStartListener(IPlayer.OnRenderingStartListener l)
Set a rendering start callback.
|
void |
setOnReportEventListener(IPlayer.OnReportEventListener onReportEventListener)
set report event listener
|
void |
setOnSeekCompleteListener(IPlayer.OnSeekCompleteListener l)
Set a seeking completion callback.
|
void |
setOnSeiDataListener(IPlayer.OnSeiDataListener l)
Set a SEI data callback.
|
void |
setOnSnapShotListener(IPlayer.OnSnapShotListener l)
Set a snapshot creation result callback.
|
void |
setOnStateChangedListener(IPlayer.OnStateChangedListener l)
Set a player status update callback.
|
void |
setOnSubtitleDisplayListener(IPlayer.OnSubtitleDisplayListener l)
Set a subtitle display callback.
|
void |
setOnTrackChangedListener(IPlayer.OnTrackChangedListener l)
Set a stream switchover callback.
|
void |
setOnTrackReadyListener(IPlayer.OnTrackReadyListener l)
Set a stream preparation success callback.
|
void |
setOnVideoRenderedListener(IPlayer.OnVideoRenderedListener l)
set the video render callback
|
void |
setOnVideoSizeChangedListener(IPlayer.OnVideoSizeChangedListener l)
Set a video size change callback.
|
void |
setPreferPlayerName(java.lang.String name)
Sets the name of the player selected when playing.
|
void |
setRenderFrameCallbackConfig(IPlayer.RenderFrameCallbackConfig config)
Set the render frame callback configuration.
|
void |
setRotateMode(IPlayer.RotateMode rotateMode)
Set a rotate mode.
|
void |
setScaleMode(IPlayer.ScaleMode scaleMode)
Set a zoom mode.
|
void |
setSpeed(float speed)
Set the playback speed.
|
void |
setStreamDelayTime(int index,
int time)
set the delay time of the stream
|
void |
setSurface(android.view.Surface surface)
Set the display surface.
|
void |
setTraceId(java.lang.String traceId)
Set a trace ID for troubleshooting with the relevant log.
|
void |
setVideoBackgroundColor(int color)
Set video background color
|
void |
setVideoTag(int[] tags)
Set the video tags.
|
void |
setVolume(float gain)
Set the volume of the player(Not system volume).
|
void |
snapshot()
Create a snapshot for the current frame.
|
void |
start()
Start the player.
|
void |
stop()
Stop the player.
|
void |
surfaceChanged()
Surface changed.
|
void |
updateFilterConfig(java.lang.String target,
FilterConfig.FilterOptions options)
upadate filter config.
|
static final int unknow
static final int idle
static final int initalized
static final int prepared
static final int started
static final int paused
static final int stopped
static final int completion
static final int error
void selectTrack(int trackInfoIndex)
IPlayer.OnTrackChangedListener
to check whether the stream is played.
Note: If you have specified a track, then automatic bitrate switchover does not take effect even if it is enabled.
trackInfoIndex
- Stream information. See TrackInfo.getIndex()
.
If you want to enable automatic bitrate switchover, pass TrackInfo.AUTO_SELECT_INDEX
.void selectTrack(int trackInfoIndex, boolean accurate)
IPlayer.OnTrackChangedListener
to check whether the stream is played.
Note: If you have specified a track, then automatic bitrate switchover does not take effect even if it is enabled.
trackInfoIndex
- Stream information. See TrackInfo.getIndex()
.
If you want to enable automatic bitrate switchover, pass TrackInfo.AUTO_SELECT_INDEX
.accurate
- enable accurate select or not.@Deprecated TrackInfo currentTrack(int type)
type
- The type of the track. See TrackInfo.Type
.ordinal().TrackInfo currentTrack(TrackInfo.Type type)
type
- The type of the track. See TrackInfo.Type
.long getDuration()
MediaInfo getMediaInfo()
IPlayer.OnPreparedListener.onPrepared()
is called back, the media information can be returned.MediaInfo
.int getVideoWidth()
int getVideoHeight()
int getVideoRotation()
void setCacheConfig(CacheConfig cacheConfig)
cacheConfig
- Cache settings. See CacheConfig
.void setTraceId(java.lang.String traceId)
traceId
- The specified trace ID.void setVolume(float gain)
gain
- Valid values: [0,1].float getVolume()
void setMute(boolean on)
on
- Set to true to mute the player. Default: false.boolean isMute()
void setLoop(boolean on)
on
- true:Enable loop playback. Default: disabled.boolean isLoop()
void setAutoPlay(boolean on)
IPlayer.OnPreparedListener
callback is not returned.on
- Value true indicates that autoplay is enabled. Default: disabled.boolean isAutoPlay()
void setSpeed(float speed)
speed
- Valid values: [0.5,2].float getSpeed()
void setMirrorMode(IPlayer.MirrorMode mirrorMode)
mirrorMode
- The specified mirroring mode. See IPlayer.MirrorMode
.IPlayer.MirrorMode getMirrorMode()
IPlayer.MirrorMode
.void setRotateMode(IPlayer.RotateMode rotateMode)
rotateMode
- The specified rotate mode. See IPlayer.RotateMode
.IPlayer.RotateMode getRotateMode()
IPlayer.RotateMode
.void setScaleMode(IPlayer.ScaleMode scaleMode)
scaleMode
- The specified zoom mode. Default: IPlayer.ScaleMode.SCALE_TO_FILL
. See IPlayer.ScaleMode
.IPlayer.ScaleMode getScaleMode()
IPlayer.ScaleMode.SCALE_TO_FILL
.void snapshot()
IPlayer.OnSnapShotListener
to return the snapshot creation result.void setSurface(android.view.Surface surface)
surface
- The display surface.void setDisplay(android.view.SurfaceHolder holder)
holder
- The SurfaceHolder.void setDisplayView(AliDisplayView view)
void surfaceChanged()
void prepare()
IPlayer.OnPreparedListener
to return success messages. Call IPlayer.OnErrorListener
to return error messages.void start()
void pause()
void stop()
void seekTo(long position)
position
- The specified position.void seekTo(long position, IPlayer.SeekMode seekMode)
position
- The specified position. Unit: millisecond.seekMode
- The specified seeking mode. See IPlayer.SeekMode
.void setMaxAccurateSeekDelta(int delta)
delta
- interval in millisecondsvoid reset()
void release()
@Deprecated void redraw()
void clearScreen()
void setOnPreparedListener(IPlayer.OnPreparedListener l)
IPlayer.OnErrorListener
is triggered.l
- Preparation success notification.void setOnRenderingStartListener(IPlayer.OnRenderingStartListener l)
l
- Rendering start notification.void setOnStateChangedListener(IPlayer.OnStateChangedListener l)
l
- Player status update notification.void setOnCompletionListener(IPlayer.OnCompletionListener l)
l
- Playback completion notification.void setOnLoadingStatusListener(IPlayer.OnLoadingStatusListener l)
l
- Loading status notification.void setOnErrorListener(IPlayer.OnErrorListener l)
l
- Error message.void setOnChooseTrackIndexListener(IPlayer.OnChooseTrackIndexListener l)
void setOnTrackReadyListener(IPlayer.OnTrackReadyListener l)
l
- Stream preparation success notification.void setOnInfoListener(IPlayer.OnInfoListener l)
l
- The notification.void setOnVideoSizeChangedListener(IPlayer.OnVideoSizeChangedListener l)
l
- Video size change notification.void setOnSeekCompleteListener(IPlayer.OnSeekCompleteListener l)
l
- Seeking completion notification.void setOnTrackChangedListener(IPlayer.OnTrackChangedListener l)
l
- Stream switchover notification.void setOnSeiDataListener(IPlayer.OnSeiDataListener l)
l
- SEI data callback.void addExtSubtitle(java.lang.String url)
url
- subtitle addressvoid selectExtSubtitle(int trackIndex, boolean select)
trackIndex
- caption indexselect
- true: select, false: closevoid setStreamDelayTime(int index, int time)
index
- steam indextime
- msvoid setOnSubtitleDisplayListener(IPlayer.OnSubtitleDisplayListener l)
l
- Subtitle display notification.void setConfig(PlayerConfig config)
config
- The configuration of the player. See PlayerConfig
.PlayerConfig getConfig()
void setOnSnapShotListener(IPlayer.OnSnapShotListener l)
l
- Snapshot creation notification.void enableHardwareDecoder(boolean enable)
enable
- Set to true to enable hardware decoding and set to false to disable hardware decoding.java.lang.String getCacheFilePath(java.lang.String URL)
URL
- The URL of the cached file.java.lang.String getCacheFilePath(java.lang.String vid, java.lang.String format, java.lang.String definition, int previewTime)
vid
- The ID of the video.format
- The format of the video.definition
- The definition of the video.previewTime
- The preview duration for the video.void reload()
java.lang.String getPropertyString(IPlayer.PropertyKey key)
key
- The enum of keyvoid setDefaultBandWidth(int bandWidth)
bandWidth
- bit rate .java.lang.Object getOption(IPlayer.Option key)
key
- parameter value See IPlayer.Optionvoid setOnVideoRenderedListener(IPlayer.OnVideoRenderedListener l)
l
- video render callback. See IPlayer.OnVideoRenderedListenervoid setVideoBackgroundColor(int color)
color
- ARGBvoid setIPResolveType(IPlayer.IPResolveType type)
type
- See IPlayer.IPResolveType
void setFastStart(boolean open)
open
- void setOnReportEventListener(IPlayer.OnReportEventListener onReportEventListener)
onReportEventListener
- event listenervoid setDrmCallback(DrmCallback callback)
callback
- callbackvoid sendCustomEvent(java.lang.String args)
IPlayer.OnReportEventListener
. User-defined event e = 5001. Args is the parameter passed in.args
- void setVideoTag(int[] tags)
tags
- void setPreferPlayerName(java.lang.String name)
name
- java.lang.String getPlayerName()
void setRenderFrameCallbackConfig(IPlayer.RenderFrameCallbackConfig config)
config
- See IPlayer.RenderFrameCallbackConfigvoid setOnRenderFrameCallback(IPlayer.OnRenderFrameCallback callback)
callback
- See IPlayer.OnRenderFrameCallbackvoid setFilterConfig(FilterConfig filterConfig)
filterConfig
- void updateFilterConfig(java.lang.String target, FilterConfig.FilterOptions options)
target
- options
- void setFilterInvalid(java.lang.String target, boolean invalid)
target
- if empty , disable all filters.invalid
- true: enable(default); false: disablevoid setOnPreRenderFrameCallback(IPlayer.OnPreRenderFrameCallback callback)
callback
- See IPlayer.OnPreRenderFrameCallbacklong getNativeContextAddr()