ZegoMediaPlayer

媒体播放器

Declared in ZegoExpressDefines.h

Includes

Property Lists

  • totalDuration - 媒体资源的总播放时长 @discussion 必须在加载资源完成后才能访问该变量,否则为 0 @discussion 单位为毫秒
  • currentProgress - 媒体资源的当前播放进度 @discussion 必须在加载资源完成后才能访问该变量,否则为 0 @discussion 单位为毫秒
  • volume - 当前音量 @discussion 范围为 0 ~ 100。默认值为 50
  • currentState - 播放器当前的播放状态
  • index - 媒体播放器的序号

Public Func Lists

Property Docs

totalDuration

媒体资源的总播放时长 @discussion 必须在加载资源完成后才能访问该变量,否则为 0 @discussion 单位为毫秒

currentProgress

媒体资源的当前播放进度 @discussion 必须在加载资源完成后才能访问该变量,否则为 0 @discussion 单位为毫秒

volume

当前音量 @discussion 范围为 0 ~ 100。默认值为 50

currentState

播放器当前的播放状态

index

媒体播放器的序号

Public Func Docs

setEventHandler:

- (void)setEventHandler:(nullable id< ZegoMediaPlayerEventHandler >) handler;

设置媒体播放器的事件回调 handler

Parameters
handler 媒体播放器的事件回调对象

setVideoHandler:format:type:

- (void)setVideoHandler:(nullable id< ZegoMediaPlayerVideoHandler >) handler format:(ZegoVideoFrameFormat) format type:(ZegoVideoBufferType) type;

设置视频回调 handler

Parameters
handler 媒体播放器的视频事件回调对象
format 视频数据的视频帧格式
type 视频数据的 Buffer 类型

setAudioHandler:

- (void)setAudioHandler:(nullable id< ZegoMediaPlayerAudioHandler >) handler;

设置视频回调 handler

Parameters
handler 媒体播放器的音频事件回调对象

loadResource:callback:

- (void)loadResource:(NSString *) path callback:(ZegoMediaPlayerLoadResourceCallbacknullable ) callback;

加载媒体资源

Parameters
path 本地资源路径或网络资源的 URL
callback 资源加载结果的通知

start

- (void)start:;

开始播放

stop

- (void)stop:;

停止播放

pause

- (void)pause:;

暂停播放

resume

- (void)resume:;

恢复播放

seekTo:callback:

- (void)seekTo:(unsigned long long) millisecond callback:(ZegoMediaPlayerSeekToCallbacknullable ) callback;

设置指定的播放进度

Parameters
millisecond 指定的播放进度的时间点
callback 设置指定的播放进度的结果通知

enableRepeat:

- (void)enableRepeat:(BOOL) enable;

是否重复播放

Parameters
enable 重复播放标记,默认为 NO

enableAux:

- (void)enableAux:(BOOL) enable;

是否将播放器的声音混入正在推的流中

Parameters
enable 是否混音标记,默认为 NO

muteLocal:

- (void)muteLocal:(BOOL) mute;

是否静默本地播放

Parameters
mute 本地静音标记,默认为 NO。

setPlayerCanvas:

- (void)setPlayerCanvas:(nullable ZegoCanvas *) canvas;

设置播放器播放视频的视图

Parameters
canvas 视频渲染的画布对象

setVolume:

- (void)setVolume:(int) volume;

设置播放器音量

Parameters
volume 范围为 0 ~ 100,默认为 50。

setProgressInterval:

- (void)setProgressInterval:(unsigned long long) millisecond;

设置播放进度回调间隔

Parameters
millisecond 播放进度回调间隔时间,单位为毫秒