Interface Info |
|---|
public interface WisePlayer 定义视频播放功能的WisePlayer播放器的接口。 |
Qualifier and Type | Interface Name and Description |
|---|---|
interface | 定义媒体内容已经完成准备的监听器的接口。 |
interface | 定义播放器缓冲相关事件的监听器的接口。 |
interface | 定义播放完成的监听器的接口。 |
interface | 定义seek操作的监听器的接口。 |
interface | WisePlayer.ResolutionUpdatedListener 定义播放视频画面清晰度发生变化的监听器的接口。 |
interface | 定义播放器媒体以及播放事件上报的监听器的接口。 |
interface | 定义播放器错误信息上报的监听器的接口。 |
interface | WisePlayer.SubtitleUpdateListener 定义播放器字幕信息上报的监听器的接口。 |
interface | 定义播放器缩略图信息上报的监听器的接口。 |
Qualifier and Type | Method Name and Description |
|---|---|
void | setVideoType(int videoType) 设置视频类型。 |
void | setPlayUrl(String url) 设置播放媒体内容的单个CDN URL。 |
void | setPlayUrl(String[] urlArray) 设置播放媒体内容的多个CDN URL,播放器在发生播放异常时会进行CDN切换。 |
void | setPlayUrl(String playParam, String appId, int scenario) 设置托管内容或者华为视频开放内容播放源。 |
void | setPlayUrl(String playParam, String appId, int scenario, int videoFormat) 设置托管内容或者华为视频开放内容播放源,支持下发指定编码格式的片源。 |
void | setView(View view) 设置View对象用于显示媒体内容中的视频。 |
void | ready() 异步准备播放器和媒体资源。 |
void | start() 开始或继续播放。若在此之前您已暂停播放,则将从暂停的时间点继续播放。如果播放已停止或之前从未开始过,则播放将从头或者书签位置开始。 |
void | pause() 暂停播放,调用start()恢复播放。 |
void | suspend() 挂起播放器。 |
void | resume(int play) 恢复播放器。 |
void | seek(int time) 定位到指定时间位置播放。实际开始播放位置为早于或者等于指定时间的关键帧位置。 |
void | seek(int time, int mode) 定位到指定时间位置播放。根据mode判断是否使用精确定位。 |
void | stop() 媒体内容停止播放。 |
void | reset() 重置播放器到初始状态,可以重新设置播放媒体内容和准备播放。 |
void | release() 释放播放器对象持有的资源。当App不再使用播放器对象时必须调用此接口释放播放器持有的资源,避免内存泄漏。 |
boolean | 获取播放器当前是否处于播放状态。 |
| 获取媒体内容信息。 | |
int | 获取当前正在播放视频的高度。 |
int | 获取当前正在播放视频的宽度。 |
int | 获取媒体内容总时长,单位:毫秒。 |
int | 获取当前的播放进度。 |
int | 获取当前播放器已缓存的时长。 |
void | setBufferingStatus(boolean status) 设置是否允许播放器缓冲媒体数据。例如:在移动网络下暂停播放,停止媒体数据缓冲。 |
long | 获取媒体内容下载速度。 |
| 获取当前正在播放的媒体流信息。 | |
void | setMute(boolean status) 设置是否静音播放。 |
void | setVolume(float volume) 设置音量。 |
void | setBookmark(int bookmark) 设置书签播放的时间,实际的起播时间为早于或者等于书签时间的关键帧时间。 |
void | setPlaySpeed(float speed) 设置播放速度。 |
float | 获取当前的播放速度。 |
void | setPlayMode(int playMode) 设置音视频播放模式。 |
int | 获取当前的音视频播放模式。 |
int | setBandwidthSwitchMode(int mod) 设置视频内容播放时的码率切换模式。 |
void | switchBitrateDesignated(int bitrate) 立即切换到指定的码率进行播放,关闭带宽自适应码率切换功能。 |
void | switchBitrateSmooth(int bitrate) 平滑切换到指定码率播放。调用此接口播放器会保留并继续播放一段时间的缓存媒体数据,按照指定的码率下载后续分片的媒体内容播放。 |
void | setBitrateRange(int minBitrate, int maxBitrate) 设置播放的自适应切换码率范围。 |
void | setInitBitrate(InitBitrateParam param) 设置初始播放码率参数,需要在调用ready()前设置起播码率参数。 |
void | 业务App在调整View大小时通知播放器。 |
void | 关闭华为视频水印显示。 |
void | setCycleMode(int cycleMode) 设置循环播放模式。 |
int | 获取循环播放模式。 |
void | setReadyListener(ReadyListener listener) 设置媒体内容已经完成准备的监听器实例。 |
void | setLoadingListener(LoadingListener listener) 设置播放器缓冲相关事件的监听器实例。 |
void | setPlayEndListener(PlayEndListener listener) 设置播放完成的监听器实例。 |
void | setSeekEndListener(SeekEndListener listener) 设置seek操作完成的监听器实例。 |
void | setResolutionUpdatedListener(ResolutionUpdatedListener listener) 设置播放视频尺寸发生变化的监听器实例。 |
void | setEventListener(EventListener listener) 设置播放器媒体以及播放信息上报的监听器实例。 |
void | setErrorListener(ErrorListener listener) 设置播放器错误信息上报的监听器实例。 |
void | getRecommendVideoList(String videoId, RecommendOptions options, String appAT, IRecommendVideoCallback callback) 获取内容关联推荐信息。 |
void | refreshPlayUrl(String url) FLV直播播放过程中刷新播放URL。 |
void | setInitBufferTimeStrategy(InitBufferTimeStrategy bufferTimeStrategy) 设置起播缓冲时间配置策略。 |
| 获取当前播放的音频Track。 | |
| 获取音频Track信息列表。 | |
void | selectAudioTrack(int audioTrackId) 切换音频Track。 |
void | presetAudioLanguage(String lang) 音频Track偏好设置。 |
| 获取字幕Track信息列表。 | |
| 获取当前播放选择的字幕Track。 | |
void | selectSubtitleTrack(int trackId) 切换字幕。 |
void | 不播放任何字幕。 |
void | presetSubtitleLanguage(String language) 设置字幕Track偏好。 |
void | 设置请求的代理参数。 |
int | setProperties(int propertyKey, Object... value) 设置播放器相关属性。 |
void | setWakeMode(Context context, int mode) 设置设备唤醒状态。 |
void | setSubtitleUpdateListener(SubtitleUpdateListener listener) 设置播放字幕的监听器实例。 |
void | setPreviewPicListener(PreviewPicListener listener) 设置获取缩略图的监听器实例。 |
Method |
|---|
public void setVideoType(int videoType) 设置视频类型。 |
Parameters
Name | Description |
|---|---|
videoType | 视频类型,默认为0。
|
Method |
|---|
public void setPlayUrl(String url) 设置播放媒体内容的单个CDN URL。 播放器实例不支持重复设置URL地址,更新播放媒体内容地址场景,需要先调用reset()重置播放器实例。 |
Parameters
Name | Description |
|---|---|
url | 播放媒体内容的单个CDN URL地址,支持的流协议和媒体内容包括:
|
Method |
|---|
public void setPlayUrl(String[] urlArray) 设置播放媒体内容的多个CDN URL。urlArray地址需为同一个媒体内容的多个CDN URL,最大支持8个CDN URL,建议不超过3个CDN URL。 播放器在发生播放异常时会进行CDN切换,CDN切换时通过WisePlayer.EventListener监听器上报CDN_SWITCH事件。 播放器实例不支持重复设置URL地址,更新播放媒体内容地址场景,需要先调用reset()重置播放器实例。 |
Parameters
Name | Description |
|---|---|
urlArray | 播放媒体内容的多个CDN URL地址,支持的流协议和媒体内容包括:
|
Method |
|---|
public void setPlayUrl(String playParam, String appId, int scenario) 设置托管内容或者华为视频开放内容播放源。 播放器实例不支持重复设置URL地址,更新播放媒体内容地址场景,需要先调用reset()重置播放器实例。 |
Parameters
Name | Description |
|---|---|
playParam | 内容播放参数,对应华为视频能力开放平台同步到App内容元数据中播放参数字段。 |
appId | 华为视频分配给第三方App的业务标识。是唯一标识,所有App都不一样。 |
scenario | 内容播放场景,场景定义参见ScenarioType。 默认为 0:在线播放ONLINE。 |
Method |
|---|
public void setPlayUrl(String playParam, String appId, int scenario, int videoFormat) 设置托管内容或者华为视频开放内容播放源,支持下发指定编码格式的片源。 播放器实例不支持重复设置URL地址,更新播放媒体内容地址场景,需要先调用reset()重置播放器实例。 |
Parameters
Name | Description |
|---|---|
playParam | 内容播放参数,对应华为视频能力开放平台同步到App内容元数据中播放参数字段。 |
appId | 华为视频分配给第三方App的业务标识。 |
scenario | 内容播放场景,场景定义参见ScenarioType。 默认为 0:在线播放ONLINE。 |
videoFormat | 视频编码格式: |
Method |
|---|
public void setView(View view) 设置View对象用于显示媒体内容中的视频。 如果需要显示视频内容,则必须调用setView(View view)方法。未设置或者设置一个空的View将导致仅播放音频内容。 |
Parameters
Name | Description |
|---|---|
view | android.view.View对象。 |
Method |
|---|
public void ready() 异步准备播放器和媒体资源。 需要在调用前设置播放数据源和视频显示的View,调用该方法播放器将立即返回,播放器在完成媒体资源准备后通过监听器WisePlayer.ReadyListener的onReady()回调方法通知。 |
Method |
|---|
public void suspend() 挂起播放器。 播放器切换至后台状态挂起媒体内容播放,播放器回到前台时调用resume()恢复播放。如果在播放器切换至后台状态时需要采用纯音频播放模式,请调用setPlayMode()。 |
Method |
|---|
public void resume(int play) 恢复播放器。 播放器回到前台时恢复播放,调用此方法前可以调用setView()接口重新设置视频内容显示对象。 |
Parameters
Name | Description |
|---|---|
play | 控制恢复前台后的播放状态:
|
Method |
|---|
public void seek(int time) 定位到指定时间播放。实际开始播放位置为早于或者等于指定时间的关键帧位置。 在seek完成时,播放器通过WisePlayer.SeekEndListener通知App。 说明: 当前FLV直播不支持seek调用。 |
Parameters
Name | Description |
|---|---|
time | 媒体内容的时间,单位:毫秒。 当定位到指定的时间位置时,将定位到早于指定时间的最近一个关键帧。如果时间为负数,则保持当前的播放位置不变,如果时间大于媒体内容总时长,播放器将上报MEDIA_SEEK_NO_AVAILABLE_SEGMENT错误。 |
Method |
|---|
public void seek(int time, int mode) 定位到指定时间位置播放。根据mode判断是否使用精确定位。 在seek完成时,播放器通过WisePlayer.SeekEndListener通知App。 说明: 当前FLV直播不支持seek调用。 |
Parameters
Name | Description |
|---|---|
time | 媒体内容的时间,单位:毫秒。 当定位到指定的时间位置,如果时间为负数,则保持当前的播放位置不变,如果时间大于媒体内容总时长,播放器将上报MEDIA_SEEK_NO_AVAILABLE_SEGMENT错误。 |
mode | 定位到指定时间播放的模式。 取值范围: |
Method |
|---|
public boolean isPlaying() 获取播放器当前是否处于播放状态。 |
Returns
Type | Description |
|---|---|
boolean | 返回播放器是否处于播放状态。
|
Method |
|---|
public VideoInfo getVideoInfo() 获取媒体内容信息。在媒体内容未准备好时返回空。 |
Returns
Type | Description |
|---|---|
返回媒体内容信息。 |
Method |
|---|
public int getVideoHeight() 获取当前正在播放视频的高度。 |
Returns
Type | Description |
|---|---|
int | 返回媒体视频流高度。单位:像素。 |
Method |
|---|
public int getVideoWidth() 获取当前正在播放视频的宽度。 |
Returns
Type | Description |
|---|---|
int | 返回媒体视频流宽度,单位:像素。 |
Method |
|---|
public int getDuration() 获取媒体内容总时长。 |
Returns
Type | Description |
|---|---|
int | 返回媒体内容总时长,单位:毫秒。 |
Method |
|---|
public int getCurrentTime() 获取当前的播放进度。 |
Returns
Type | Description |
|---|---|
int | 当前的播放进度,单位:毫秒。 |
Method |
|---|
public int getBufferTime() 获取当前播放器已缓存的时长。 |
Returns
Type | Description |
|---|---|
int | 当前播放器已缓存的时长,单位:毫秒。 |
Method |
|---|
public void setBufferingStatus(boolean status) 设置是否允许播放器缓冲媒体数据。例如:在移动网络下暂停播放,停止媒体数据缓冲。 |
Parameters
Name | Description |
|---|---|
status | 是否允许播放器缓冲媒体数据,默认值为true。
|
Method |
|---|
public long getBufferingSpeed() 获取媒体内容下载速度。 |
Returns
Type | Description |
|---|---|
long | 媒体内容下载速度,单位:bps。 |
Method |
|---|
public StreamInfo getCurrentStreamInfo() 获取当前正在播放的媒体流信息。在媒体内容未准备好时返回空。 |
Returns
Type | Description |
|---|---|
当前正在播放的媒体流信息。 |
Method |
|---|
public void setMute(boolean status) 设置是否静音播放。 |
Parameters
Name | Description |
|---|---|
status | 是否静音播放,默认值为false。
|
Method |
|---|
public void setVolume(float volume) 设置播放音量。 |
Parameters
Name | Description |
|---|---|
volume | 播放的音量,取值范围:[0.0, 1.0],默认值为1.0。 |
音量的最大值是当前手机媒体音量的值,并不是手机最大的音量值。例如,手机最大音量值是100,如果手机用户使用音量键将音量值调到80,那么当APP调用setVolume传入了参数值是1.0后,手机对应的音量值是80而不是100。
Method |
|---|
public void setBookmark(int bookmark) 设置书签播放的时间,实际的起播时间为早于或者等于书签时间的关键帧时间。 需要在调用ready()前设置书签播放时间,开始播放后调用此接口不生效。与seek()方法的不同在于,设置书签位置开始播放,播放器在解析索引文件后从书签位置开始下载媒体内容,而在ready()后再seek(),播放器会下载媒体内容的首个分片后再执行seek定位操作。 |
Parameters
Name | Description |
|---|---|
bookmark | 书签播放的时间位置,单位:毫秒。 |
Method |
|---|
public void setPlaySpeed(float speed) 设置播放速度。 |
Parameters
Name | Description |
|---|---|
speed | 播放速度,默认值为1.0。支持的播放速度包括:0.5倍、0.75倍、1.0倍、1.25倍、1.5倍、1.75倍、2.0倍。 |
Method |
|---|
public float getPlaySpeed() 获取当前的播放速度。 |
Returns
Type | Description |
|---|---|
float | 当前的播放速度。 |
Method |
|---|
public void setPlayMode(int playMode) 设置音视频播放模式。 |
Parameters
Name | Description |
|---|---|
playMode | 音视频播放模式:
|
切换纯音频播放模式后,播放界面保持当前的画面不动。App可以根据自身的功能,添加海报或者其他处理。
Method |
|---|
public int getPlayMode() 获取当前的音视频播放模式。 |
Returns
Type | Description |
|---|---|
int | 音视频播放模式,默认值为0:
|
Method |
|---|
public int setBandwidthSwitchMode(int mod) 设置视频内容播放时的码率切换模式。 播放器在切换码率时会上报BANDWIDTH_UPDATE信息。 |
Parameters
Name | Description |
|---|---|
mod | 视频内容的码率切换模式:
|
Returns
Type | Description |
|---|---|
int | 修改码率切换模式的操作结果:
|
Method |
|---|
public void switchBitrateDesignated(int bitrate) 立即切换到指定的码率进行播放,关闭带宽自适应码率切换功能。 调用此接口播放器会清除当前已缓存的视频内容媒体数据,并按照指定码率重新下载缓冲媒体内容播放。播放器在切换码率时会上报BANDWIDTH_UPDATE信息,当上报的更新码率信息和指定的立即切换码率相同时则切换码率完成,会通过onEvent上报BITRATE_SWITCH_COMPLETE信息。 |
Parameters
Name | Description |
|---|---|
bitrate | 切换的目标码率,可切换的码率值通过调用getVideoInfo()获取。 |
Method |
|---|
public void switchBitrateSmooth(int bitrate) 平滑切换到指定码率播放。调用此接口播放器会保留并继续播放一段时间的缓存内容数据,按照指定的码率下载后续分片的视频内容播放。 播放器在切换码率时会上报BANDWIDTH_UPDATE信息,当上报的更新码率信息和指定的平滑切换码率相同时则切换码率完成,会上报BITRATE_SWITCH_COMPLETE信息,完成平滑切换码率后播放器会继续在setBitrateRange()指定的码率范围中自动切换码率。 |
Parameters
Name | Description |
|---|---|
bitrate | 切换的目标码率,可切换的码率值通过调用getVideoInfo()获取。 |
Method |
|---|
public void setBitrateRange(int minBitrate, int maxBitrate) 设置播放的自适应切换码率范围。 请先调用getVideoInfo()获取当前视频内容支持的码率列表,App需要确保设置的码率范围内至少有一个匹配的码率,否则播放器会上报UNSUPPORTED_BANDWIDTH错误码。 |
Parameters
Name | Description |
|---|---|
minBitrate | 播放的视频最低码率。 |
maxBitrate | 播放的视频最高码率。 |
Method |
|---|
public void setInitBitrate(InitBitrateParam param) 设置初始播放码率参数,需要在调用ready()前设置起播码率参数。 |
Parameters
Name | Description |
|---|---|
param | 起播码率参数InitBitrateParam对象。 |
Method |
|---|
public void setCycleMode(int cycleMode) 设置循环播放模式。 开启循环播放模式播放器在播放完成时,播放器不会回调PlayEndListener监听器,自动从媒体内容的起始时间重新播放。 在启用预加载功能后,如果在setPlayUrl之前调用此接口,则会将播放的数据同步缓存到本地,循环播放时直接从本地读取数据,可以节省流量。因此建议在setPlayUrl之前调用此接口。 |
Parameters
Name | Description |
|---|---|
cycleMode | 循环播放模式:
|
Method |
|---|
public int getCycleMode() 获取循环播放模式。 |
Returns
Type | Description |
|---|---|
int | 循环播放模式:
|
Method |
|---|
public void setReadyListener(ReadyListener listener) 设置媒体内容已经完成准备的监听器实例。 |
Parameters
Name | Description |
|---|---|
listener | 媒体内容已经完成准备的监听器。 |
Method |
|---|
public void setLoadingListener(LoadingListener listener) 设置播放器缓冲相关事件的监听器实例。 |
Parameters
Name | Description |
|---|---|
listener | 播放器缓冲相关事件的监听器实例。 |
Method |
|---|
public void setPlayEndListener(PlayEndListener listener) 设置播放完成的监听器实例。 |
Parameters
Name | Description |
|---|---|
listener | 播放完成的监听器实例。 |
Method |
|---|
public void setSeekEndListener(SeekEndListener listener) 设置seek操作完成的监听器实例。 |
Parameters
Name | Description |
|---|---|
listener | seek操作完成的监听器实例。 |
Method |
|---|
public void setResolutionUpdatedListener(ResolutionUpdatedListener listener) 设置播放视频清晰度发生变化的监听器实例。 |
Parameters
Name | Description |
|---|---|
listener | 播放视频清晰度发生变化的监听器实例。 |
Method |
|---|
public void setEventListener(EventListener listener) 设置播放器媒体以及播放信息上报的监听器实例。 |
Parameters
Name | Description |
|---|---|
listener | 播放器媒体以及播放信息上报的监听器实例。 |
Method |
|---|
public void setErrorListener(ErrorListener listener) 设置播放器错误信息上报的监听器实例。 |
Parameters
Name | Description |
|---|---|
listener | 播放器错误信息上报的监听器实例。 |
Method |
|---|
public void getRecommendVideoList(String videoId, RecommendOptions options, String appAT, IRecommendVideoCallback callback) 获取内容关联推荐信息。 |
Parameters
Name | Description |
|---|---|
videoId | 关联推荐的视频ID,和华为视频开放服务内容元数据开放接口中提供的视频ID相同。 |
options | 推荐请求可选参数。 |
appAT | 第三方应用访问华为视频服务器的应用级Access Token,华为视频开放服务根据该Access Token获取和校验第三方应用的身份。 |
callback | 回调接口。 |
Method |
|---|
public void refreshPlayUrl(String url) 直播播放过程中更新播放URL。 |
Parameters
Name | Description |
|---|---|
url | 直播播放过程中更新URL。 |
Method |
|---|
public void setInitBufferTimeStrategy(InitBufferTimeStrategy bufferTimeStrategy) 设置起播缓冲时间配置策略。 |
Parameters
Name | Description |
|---|---|
bufferTimeStrategy | 起播缓冲时间配置策略。 |
Method |
|---|
public AudioTrackInfo getSelectedAudioTrack() 获取当前播放的音频Track。 |
Returns
Type | Description |
|---|---|
音频Track信息。 |
Method |
|---|
public AudioTrackInfo[] getAudioTracks() 获取音频Track信息列表。 |
Returns
Type | Description |
|---|---|
音频Track信息列表。 |
Method |
|---|
public void selectAudioTrack(int audioTrackId) 切换音频Track。 |
Parameters
Name | Description |
|---|---|
audioTrackId | 目标音频TrackId。 |
Method |
|---|
public void presetAudioLanguage(String lang) 音频Track偏好设置。 |
Parameters
Name | Description |
|---|---|
lang | 音频语言偏好设置。 格式定义为:lang1,lang2,lang3。 通过“,”分割多个音频语言描述,排在前面的优先级高, 最多支持3个。 如:”zh_CN,en_US,ar_AR”优先级排序:zh_CN > en_US > ar_AR。 |
Method |
|---|
public SubtitleTrackInfo[] getSubtitleTracks() 获取字幕Track信息列表。 |
Returns
Type | Description |
|---|---|
字幕Track信息列表。 |
Method |
|---|
public SubtitleTrackInfo getSelectedSubtitleTrack() 获取当前播放的字幕Track。 |
Returns
Type | Description |
|---|---|
字幕Track信息。 |
Method |
|---|
public void selectSubtitleTrack(int trackId) 切换字幕Track。 |
Parameters
Name | Description |
|---|---|
trackId | 目标字幕TrackId。 |
Method |
|---|
public void presetSubtitleLanguage(String language) 设置字幕Track偏好。 |
Parameters
Name | Description |
|---|---|
language | 字幕语言偏好设置。 格式定义为:lang1,lang2,lang3。 通过“,”分割多个字幕语言描述,排在前面的优先级高, 最多支持3个。 如:“zh_CN,en_US,ar_AR”优先级排序:zh_CN > en_US > ar_AR。 |
Method |
|---|
public void setProxy(Proxy proxy) 设置请求的代理参数。 |
Parameters
Name | Description |
|---|---|
proxy | 请求的代理参数。 |
Method |
|---|
public int setProperties(int propertyKey, Object... value) 设置播放器相关属性。 |
Parameters
Name | Description |
|---|---|
propertyKey | 参数类型。定义请参见Properties。 |
value | 参数值。参数值请参见Constant values。 |
Returns
Type | Description |
|---|---|
int | 设置播放器相关数据是否成功。
|
Method |
|---|
public void setWakeMode(Context context, int mode) 设置设备唤醒状态。 |
Parameters
Name | Description |
|---|---|
context | Android Context对象,非空。 |
mode | 设置的设备唤醒状态。取值范围是Android原生提供的参数:PARTIAL_WAKE_LOCK, FULL_WAKE_LOCK, SCREEN_DIM_WAKE_LOCK和SCREEN_BRIGHT_WAKE_LOCK。 |
使用此方法需要android.permission.WAKE_LOCK权限。
Method |
|---|
public void setSubtitleUpdateListener(SubtitleUpdateListener listener) 设置播放字幕的监听器实例。 |
Parameters
Name | Description |
|---|---|
listener | 播放字幕的监听器实例。 |
Method |
|---|
public void setPreviewPicListener(PreviewPicListener listener) 设置获取缩略图的监听器实例。 |
Parameters
Name | Description |
|---|---|
listener | 获取缩略图的监听器实例。 |