Methods
enableAux(enable)
是否将播放器的声音混入正在推的流中
此接口仅会将媒体播放器声音混到主通道中
Parameters:
| Name | Type | Description |
|---|---|---|
enable |
boolean | 是否混音标记，默认为 false |
- Source:
enablePublishVideo(enable, channel)
是否将播放器的视频混入正在推的流中
Parameters:
| Name | Type | Description |
|---|---|---|
enable |
boolean | 是否推视频 |
channel |
number | channel |
- Source:
enableRepeat(enable)
是否重复播放
Parameters:
| Name | Type | Description |
|---|---|---|
enable |
boolean | 重复播放标记，默认为 false |
- Source:
getAudioTrackCount() → {number}
获取播放文件的音轨个数
- Source:
Returns:
- 音轨个数
- Type
- number
getCurrentProgress() → {number}
获取当前播放进度
必须在加载资源完成后才能调用，否则返回值为 0
- Source:
Returns:
- 当前播放进度
- Type
- number
getCurrentState() → {ZegoMediaPlayerState}
获取当前播放状态
- Source:
Returns:
- 当前播放器状态
- Type
- ZegoMediaPlayerState
getPlayVolume() → {number}
获取当前媒体播放器本地播放的音量，范围为 0 ~ 200，默认值为 60
- Source:
Returns:
- 当前音量
- Type
- number
getPublishVolume() → {number}
获取当前媒体播放器推流的音量，范围为 0 ~ 200，默认值为 60
- Source:
Returns:
- 当前音量
- Type
- number
getTotalDuration() → {number}
获取媒体资源的总进度
必须在加载资源完成后才能调用，否则返回值为 0
- Source:
Returns:
- 单位为毫秒
- Type
- number
loadResource(path) → {Promise.<number>}
加载媒体资源
可传本地资源的绝对路径或者网络资源的 URL
Parameters:
| Name | Type | Description |
|---|---|---|
path |
string | 本地资源路径或网络资源的 URL，不能传入 null 或 ""。 |
- Source:
Returns:
- 加载资源的结果
- Type
- Promise.<number>
muteLocal(mute)
是否静默本地播放
若开启了混音入流则推的流中仍然有声音，默认为 false。
Parameters:
| Name | Type | Description |
|---|---|---|
mute |
boolean | 本地静音标记，默认为 false。 |
- Source:
pause()
暂停播放
- Source:
resume()
恢复播放
- Source:
seekTo(millisecond) → {Promise.<number>}
设置指定的播放进度
单位为毫秒
Parameters:
| Name | Type | Description |
|---|---|---|
millisecond |
number | 指定的播放进度的时间点 |
- Source:
Returns:
- 设置播放进度的结果
- Type
- Promise.<number>
setAudioTrackIndex(index)
设置播放文件的音轨
Parameters:
| Name | Type | Description |
|---|---|---|
index |
number | 音轨序号，可以通过 [getAudioTrackCount] 获取音轨个数 |
- Source:
setPlayerView(view)
设置播放器播放视频的视图
Parameters:
| Name | Type | Description |
|---|---|---|
view |
ZegoView | 视频渲染的画布对象 |
- Source:
setPlayVolume(volume)
设置播放器本地播放音量
Parameters:
| Name | Type | Description |
|---|---|---|
volume |
number | 范围为 0 ~ 200，默认为 60。 |
- Source:
setProgressInterval(millisecond)
设置播放进度回调间隔
可通过此函数控制 [onMediaPlayerPlayingProgress] 的回调频率，当设置回调间隔为 0 时，停止回调。默认回调间隔为 1s
回调不会严格按照设定的回调间隔值返回，而是以处理音频帧或者视频帧的频率来判断是否需要回调
Parameters:
| Name | Type | Description |
|---|---|---|
millisecond |
number | 播放进度回调间隔时间，单位为毫秒 |
- Source:
setPublishVolume(volume)
设置播放器推流音量
Parameters:
| Name | Type | Description |
|---|---|---|
volume |
number | 范围为 0 ~ 200，默认为 60。 |
- Source:
setVoiceChangerParam(audioChannel, param)
设置变声的具体参数
Parameters:
| Name | Type | Description |
|---|---|---|
audioChannel |
ZegoMediaPlayerAudioChannel | 要进行变声的声道 |
param |
ZegoVoiceChangerParam | 变声参数 |
- Source:
setVolume(volume)
设置播放器音量，会同时设置本地播放音量和推流音量
Parameters:
| Name | Type | Description |
|---|---|---|
volume |
number | 范围为 0 ~ 200，默认为 60。 |
- Source:
start()
开始播放
必须在加载资源完成后才能调用
- Source:
stop()
停止播放
- Source:
takeSnapshot() → {Promise.<number, string>}
截取媒体播放器当前播放画面
只有在调用 [setPlayerCanvas] 设置显示控件和播放状态的情况下，才能正常截图
- Source:
Returns:
- 快照错误代码和jpg格式图片的 base64 字符串
- Type
- Promise.<number, string>
Events
onMediaPlayerNetworkEvent
媒体播放器网络状态事件回调。
详情描述：媒体播放器网络状态事件回调。
通知时机：当媒体播放器在播放网络资源时，当缓存数据的状态改变时会触发此回调。
使用限制：只有在播放网络资源时才会触发该回调。
相关接口：[setNetWorkBufferThreshold]。
Properties:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
result |
object | 结果数据对象
Properties
|
- Source:
onMediaPlayerPlayingProgress
播放器播放进度回调。
详情描述：媒体播放器播放进度回调。通过调用 [setProgressInterval] 可以设置回调间隔时间。当设置回调间隔为 0 时，停止回调。默认回调间隔为 1 秒。
通知时机：当媒体播放器开始播放资源后会触发此回调。
使用限制：无。
相关接口：[setProgressInterval]。
Properties:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
result |
object | 结果数据对象
Properties
|
- Source:
onMediaPlayerStateUpdate
媒体播放器播放状态回调。
详情描述：媒体播放器播放状态回调。
通知时机：当媒体播放器的播放状态改变时会触发此回调。
使用限制：无。
Properties:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
result |
object | 结果数据对象
Properties
|
- Source: