logo
控制台登录/注册
文档
客户端 API
服务端 API
实时音视频
iOS: Objective-C
功能总览
常用类
ZegoExpressEnginelink
ZegoEventHandlerlink
ZegoRealTimeSequentialDataManagerlink
ZegoMediaPlayerlink
ZegoAudioEffectPlayerlink
ZegoRangeAudiolink
全部分类
Class
Protocol
Enum
当前页

ZegoMediaPlayer

ZegoMediaPlayer

Declared in ZegoExpressDefines.h

方法

setEventHandler:

setEventHandler:
- (void)setEventHandler:(nullable id<ZegoMediaPlayerEventHandler>) handler;
设置媒体播放器的事件回调。
Declared in ZegoExpressDefines.h

参数

名称类型描述
handlernullable id<ZegoMediaPlayerEventHandler>媒体播放器的事件回调

详情

监听媒体播放器的事件通知回调。

  • 业务场景：开发者可以根据相关事件回调进行播放器 UI 界面的处理。
  • 调用时机：创建 [ZegoMediaPlayer] 实例后。
  • 支持版本：2.1.0 及以上。
  • 使用限制：无。
  • 注意事项：调用此函数将覆盖上一次调用此函数设置的回调。

setVideoHandler:format:type:

setVideoHandler:format:type:
- (void)setVideoHandler:(nullable id<ZegoMediaPlayerVideoHandler>) handler format:(ZegoVideoFrameFormat) format type:(ZegoVideoBufferType) type;
设置媒体播放器的视频数据回调。
Declared in ZegoExpressDefines.h

参数

名称类型描述
handlernullable id<ZegoMediaPlayerVideoHandler>媒体播放器的视频数据回调
formatZegoVideoFrameFormat视频数据的视频帧格式
typeZegoVideoBufferType视频数据的 Buffer 类型

详情

可以通过设置此回调将媒体播放器播放的媒体资源文件的视频数据抛出来。

  • 调用时机：创建 [ZegoMediaPlayer] 实例后。
  • 支持版本：2.1.0 及以上。
  • 使用限制：无。
  • 注意事项：当不再需要获取视频帧数据时请再次调用此函数将 handler 置空，以停止视频帧数据回调。

setAudioHandler:

setAudioHandler:
- (void)setAudioHandler:(nullable id<ZegoMediaPlayerAudioHandler>) handler;
设置媒体播放器的音频数据回调。
Declared in ZegoExpressDefines.h

参数

名称类型描述
handlernullable id<ZegoMediaPlayerAudioHandler>媒体播放器的音频数据回调

详情

可以通过设置此回调将媒体播放器播放的媒体资源文件的音频数据抛出来。

  • 调用时机：创建 [ZegoMediaPlayer] 实例后。
  • 支持版本：2.1.0 及以上。
  • 使用限制：无。
  • 注意事项：当不再需要获取音频数据时请再次调用此函数将 handler 置空，以停止音频数据回调。

setBlockDataHandler:blockSize:

setBlockDataHandler:blockSize:
- (void)setBlockDataHandler:(nullable id<ZegoMediaPlayerBlockDataHandler>) handler blockSize:(unsigned int) blockSize;
设置媒体播放器的媒体资源块数据回调。
Declared in ZegoExpressDefines.h

参数

名称类型描述
handlernullable id<ZegoMediaPlayerBlockDataHandler>媒体播放器的媒体资源块数据回调。
blockSizeunsigned int加密块数据的大小，OnBlockData 回调中的 bufferSize 为 blockSize 整数倍。

详情

可以通过设置此回调，监听并解密媒体资源块数据，用于播放用户自己的密文媒体资源。

  • 调用时机：创建 [ZegoMediaPlayer] 实例后，播放媒体资源之前。
  • 支持版本：3.4.0 及以上。
  • 使用限制：无。
  • 注意事项：当不再需要监听该回调进行数据解密时，再次调用此函数将 handler 置空。

loadResource:callback:

loadResource:callback:
- (void)loadResource:(NSString *) path callback:(nullable ZegoMediaPlayerLoadResourceCallback) callback;
加载本地或者网络媒体资源。
Declared in ZegoExpressDefines.h

参数

名称类型描述
pathNSString *本地资源路径或网络资源的 URL，不能传入 null 或 ""。Android 可通过 Uri 方式进行传参。
callbacknullable ZegoMediaPlayerLoadResourceCallback资源加载结果的通知。

详情

加载媒体资源。

  • 业务场景：开发者可以将可传本地资源的绝对路径或者网络资源的 URL 传入进行加载。
  • 调用时机：在已经初始化引擎 [createEngine] 且创建媒体播放器 [createMediaPlayer] 之后可以调用。
  • 相关接口：也可通过 [loadResourceWithPosition] 或 [loadResourceFromMediaData] 函数加载资源。
  • 支持版本：1.3.4 及以上。
  • 注意事项：如果该媒体播放器已经加载资源或者正在播放，请先调用 [stop] 接口停止播放，然后再调用接口加载媒体资源，否则无法加载成功。

返回值

加载媒体资源结果回调。

loadResourceWithPosition:startPosition:callback:

loadResourceWithPosition:startPosition:callback:
- (void)loadResourceWithPosition:(NSString *) path startPosition:(long) startPosition callback:(nullable ZegoMediaPlayerLoadResourceCallback) callback;
加载本地或者网络媒体资源，并指定开始位置。
Declared in ZegoExpressDefines.h

参数

名称类型描述
pathNSString *本地资源路径或网络资源的 URL，不能传入 null 或 ""。Android 可通过 Uri 方式进行传参。
startPositionlong开始播放的进度。
callbacknullable ZegoMediaPlayerLoadResourceCallback资源加载结果的通知。

详情

加载媒体资源，同时可指定开始播放的进度,单位毫秒。

  • 业务场景：开发者可以将可传本地资源的绝对路径或者网络资源的 URL 传入进行加载。
  • 调用时机：在已经初始化引擎 [createEngine] 且创建媒体播放器 [createMediaPlayer] 之后可以调用。
  • 相关接口：也可通过 [loadResource] 或 [loadResourceFromMediaData] 函数加载资源。
  • 支持版本：2.14.0 及以上。
  • 注意事项：1.当 startPosition 超过播放总时长，将从头开始播放。 2.如果该媒体播放器已经加载资源或者正在播放，请先调用 [stop] 接口停止播放，然后再调用接口加载媒体资源，否则无法加载成功。

返回值

加载媒体资源结果回调。

loadResourceFromMediaData:startPosition:callback:

loadResourceFromMediaData:startPosition:callback:
- (void)loadResourceFromMediaData:(NSData *) mediaData startPosition:(long) startPosition callback:(nullable ZegoMediaPlayerLoadResourceCallback) callback;
加载二进制的音频媒体资源。
Declared in ZegoExpressDefines.h

参数

名称类型描述
mediaDataNSData *二进制音频数据。
startPositionlong指定开始播放的进度,单位毫秒。
callbacknullable ZegoMediaPlayerLoadResourceCallback资源加载结果的通知。

详情

加载二进制的音频数据。

  • 业务场景：开发者不希望将音频数据缓存本地，直接把音频二进制数据传给媒体播放器，直接加载并播放该音频。
  • 调用时机：在已经初始化引擎 [createEngine] 且创建媒体播放器 [createMediaPlayer] 之后可以调用。
  • 相关接口：也可通过 [loadResource] 或 [loadResourceWithPosition] 函数加载资源。
  • 支持版本：2.10.0 及以上。
  • 注意事项：1.当 startPosition 超过播放总时长，将从头开始播放。 2.如果该媒体播放器已经加载资源或者正在播放，请先调用 [stop] 接口停止播放，然后再调用接口加载媒体资源，否则无法加载成功。

返回值

加载媒体资源结果回调。

loadCopyrightedMusicResourceWithPosition:startPosition:callback:

loadCopyrightedMusicResourceWithPosition:startPosition:callback:
- (void)loadCopyrightedMusicResourceWithPosition:(NSString *) resourceID startPosition:(long) startPosition callback:(nullable ZegoMediaPlayerLoadResourceCallback) callback;
加载版权音乐资源。
Declared in ZegoExpressDefines.h

参数

名称类型描述
resourceIDNSString *从版权音乐模块获取的资源ID。
startPositionlong开始播放的进度。
callbacknullable ZegoMediaPlayerLoadResourceCallback资源加载结果的通知。

详情

加载版权音乐资源，同时可指定开始播放的进度,单位毫秒。

  • 业务场景：开发者可以将可传版权音乐的资源ID进行加载。
  • 调用时机：在已经初始化引擎 [createEngine] 且创建媒体播放器 [createMediaPlayer] 之后可以调用。
  • 支持版本：2.14.0 及以上。
  • 注意事项：1.当 startPosition 超过播放总时长，将从头开始播放。 2.如果该媒体播放器已经加载资源或者正在播放，请先调用 [stop] 接口停止播放，然后再调用接口加载媒体资源，否则无法加载成功。

返回值

加载媒体资源结果回调。

loadResourceWithConfig:callback:

loadResourceWithConfig:callback:
- (void)loadResourceWithConfig:(ZegoMediaPlayerResource *) resource callback:(nullable ZegoMediaPlayerLoadResourceCallback) callback;
加载本地或者网络媒体资源，带配置参数。
Declared in ZegoExpressDefines.h

参数

名称类型描述
resourceZegoMediaPlayerResource *需要加载的多媒体资源。
callbacknullable ZegoMediaPlayerLoadResourceCallback资源加载结果的通知。

详情

加载媒体资源。

  • 业务场景：开发者可以将可传本地资源的绝对路径或者网络资源的 URL 传入进行加载。
  • 调用时机：在已经初始化引擎 [createEngine] 且创建媒体播放器 [createMediaPlayer] 之后调用。
  • 相关接口：支持通过 [loadResourceWithPosition] 或 [loadResourceFromMediaData] 接口加载资源。
  • 支持版本：3.3.0 及以上。
  • 注意事项：如果该媒体播放器已经加载资源或者正在播放，请先调用 [stop] 接口停止播放，然后再调用接口加载媒体资源，否则无法加载成功。

返回值

加载媒体资源结果回调。

start

start
- (void)start;
开始播放
Declared in ZegoExpressDefines.h

必须在加载资源完成后才能调用

stop

stop
- (void)stop;
停止播放
Declared in ZegoExpressDefines.h

pause

pause
- (void)pause;
暂停播放
Declared in ZegoExpressDefines.h

resume

resume
- (void)resume;
恢复播放
Declared in ZegoExpressDefines.h

seekTo:callback:

seekTo:callback:
- (void)seekTo:(unsigned long long) millisecond callback:(nullable ZegoMediaPlayerSeekToCallback) callback;
设置指定的播放进度
Declared in ZegoExpressDefines.h

参数

名称类型描述
millisecondunsigned long long指定的播放进度的时间点
callbacknullable ZegoMediaPlayerSeekToCallback设置指定的播放进度的结果通知

详情

单位为毫秒

返回值

设置指定的播放进度的结果通知

enableRepeat:

enableRepeat:
- (void)enableRepeat:(BOOL) enable;
是否重复播放
Declared in ZegoExpressDefines.h
名称类型描述
enableBOOL重复播放标记，默认为 false

setPlaySpeed:

setPlaySpeed:
- (void)setPlaySpeed:(float) speed;
设置播放倍速。
Declared in ZegoExpressDefines.h

参数

名称类型描述
speedfloat播放速度。默认为 1.0。
2.12.0 至 3.15.1 版本：范围为 0.5 ~ 4.0。
3.16.0 及以上版本：范围为 0.3 ~ 4.0。

详情

设置播放器的播放倍速。

  • 调用时机：必须在加载资源完成后才能调用。
  • 相关接口：可通过 [loadResource] 函数加载资源。
  • 支持版本：2.12.0 及以上。
  • 使用限制：无。

enableAux:

enableAux:
- (void)enableAux:(BOOL) enable;
是否将播放器的声音混入正在推的流中
Declared in ZegoExpressDefines.h

参数

名称类型描述
enableBOOL是否混音标记，默认为 false

详情

此接口仅会将媒体播放器声音混到主通道中

muteLocal:

muteLocal:
- (void)muteLocal:(BOOL) mute;
是否静默本地播放
Declared in ZegoExpressDefines.h

参数

名称类型描述
muteBOOL本地静音标记，默认为 false。

详情

若开启了混音入流则推的流中仍然有声音，默认为 false。

setPlayerCanvas:

setPlayerCanvas:
- (void)setPlayerCanvas:(nullable ZegoCanvas *) canvas;
设置播放器播放视频的视图
Declared in ZegoExpressDefines.h
名称类型描述
canvasnullable ZegoCanvas *视频渲染的画布对象

setVolume:

setVolume:
- (void)setVolume:(int) volume;
设置播放器音量，会同时设置本地播放音量和推流音量
Declared in ZegoExpressDefines.h
名称类型描述
volumeint范围为 0 ~ 200，默认为 60。

setPlayVolume:

setPlayVolume:
- (void)setPlayVolume:(int) volume;
设置播放器本地播放音量
Declared in ZegoExpressDefines.h
名称类型描述
volumeint范围为 0 ~ 200，默认为 60。

setPublishVolume:

setPublishVolume:
- (void)setPublishVolume:(int) volume;
设置播放器推流音量
Declared in ZegoExpressDefines.h
名称类型描述
volumeint范围为 0 ~ 200，默认为 60。

setProgressInterval:

setProgressInterval:
- (void)setProgressInterval:(unsigned long long) millisecond;
设置播放进度回调间隔
Declared in ZegoExpressDefines.h

参数

名称类型描述
millisecondunsigned long long播放进度回调间隔时间，单位为毫秒

详情

可通过此函数控制 [onMediaPlayerPlayingProgress] 的回调频率，当设置回调间隔为 0 时，停止回调。默认回调间隔为 1s 回调不会严格按照设定的回调间隔值返回，而是以处理音频帧或者视频帧的频率来判断是否需要回调

playVolume

playVolume
- (int)playVolume;
获取当前媒体播放器本地播放的音量，范围为 0 ~ 200，默认值为 60
Declared in ZegoExpressDefines.h

当前音量

publishVolume

publishVolume
- (int)publishVolume;
获取当前媒体播放器推流的音量，范围为 0 ~ 200，默认值为 60
Declared in ZegoExpressDefines.h

当前音量

totalDuration

totalDuration
- (unsigned long long)totalDuration;
获取媒体资源的总进度
Declared in ZegoExpressDefines.h

必须在加载资源完成后才能调用，否则返回值为 0

单位为毫秒

currentProgress

currentProgress
- (unsigned long long)currentProgress;
获取当前播放进度
Declared in ZegoExpressDefines.h

必须在加载资源完成后才能调用，否则返回值为 0

当前播放进度

currentRenderingProgress

currentRenderingProgress
- (unsigned long long)currentRenderingProgress;
获取当前渲染进度
Declared in ZegoExpressDefines.h

必须在加载资源完成后才能调用，否则返回值为 0

当前渲染进度

audioTrackCount

audioTrackCount
- (unsigned int)audioTrackCount;
获取播放文件的音轨个数
Declared in ZegoExpressDefines.h

音轨个数

setAudioTrackIndex:

setAudioTrackIndex:
- (void)setAudioTrackIndex:(unsigned int) index;
设置播放文件的音轨
Declared in ZegoExpressDefines.h
名称类型描述
indexunsigned int音轨序号，可以通过 [getAudioTrackCount] 获取音轨个数

setAudioTrackMode:

setAudioTrackMode:
- (void)setAudioTrackMode:(ZegoMediaPlayerAudioTrackMode) mode;
设置播放器的音轨模式
Declared in ZegoExpressDefines.h

参数

名称类型描述
modeZegoMediaPlayerAudioTrackMode音轨模式。

详情

设置播放器的音轨模式。

  • 业务场景：在实时合唱（KTV）场景下，调用该接口开启多音轨模式后，可以调用接口 [setAudioTrackIndex] 指定需要播放的原唱音轨，调用接口 [setAudioTrackPublishIndex] 指定需要推流的伴奏音轨。
  • 调用时机：在开始播放 [start] 前调用才生效。
  • 相关接口：可通过 [setAudioTrackIndex] 指定媒体文件的播放音轨，通过 [setAudioTrackPublishIndex] 指定媒体文件的推流音轨。
  • 支持版本：3.1.0 及以上。
  • 注意事项：当开启多音轨模式时会增加对硬件设备的资源消耗。

setAudioTrackPublishIndex:

setAudioTrackPublishIndex:
- (void)setAudioTrackPublishIndex:(unsigned int) index;
设置媒体文件需要推流的音轨
Declared in ZegoExpressDefines.h

参数

名称类型描述
indexunsigned int音轨序号，可以通过 [getAudioTrackCount] 获取音轨个数

详情

设置媒体文件需要推流的音轨。

  • 调用时机：初始化引擎 [createEngine] 并创建媒体播放器 [createMediaPlayer] 之后调用。
  • 相关接口：可以通过 [getAudioTrackCount] 获取音轨个数。
  • 支持版本：3.1.0 及以上。
  • 注意事项：需要调用接口 [setAudioTrackMode] 开启多音轨模式后该调用才生效。

enableVoiceChanger:param:audioChannel:

enableVoiceChanger:param:audioChannel:
- (void)enableVoiceChanger:(BOOL) enable param:(ZegoVoiceChangerParam *) param audioChannel:(ZegoMediaPlayerAudioChannel) audioChannel;
开启变声，设置变声的具体参数。
Declared in ZegoExpressDefines.h

参数

名称类型描述
enableBOOL是否开启变声，true-开启，false-关闭，默认 false。
paramZegoVoiceChangerParam *变声参数
audioChannelZegoMediaPlayerAudioChannel要进行变声的声道

详情

开启变声，设置变声的具体参数。

  • 调用时机：初始化引擎 [createEngine] 并创建媒体播放器 [createMediaPlayer] 之后调用。
  • 支持版本：3.15.0 及以上。

currentState

currentState
- (ZegoMediaPlayerState) currentState;
获取当前播放状态
Declared in ZegoExpressDefines.h

当前播放器状态

index

index
- (NSNumber *)index;
获取媒体播放器的序号
Declared in ZegoExpressDefines.h

获取媒体播放器索引。

  • 调用时机：在 [createMediaPlayer] 之后可调用。
  • 使用限制：无。

媒体播放器索引。

takeSnapshot:

takeSnapshot:
- (void)takeSnapshot:(ZegoMediaPlayerTakeSnapshotCallback) callback;
对媒体播放器当前播放画面进行截图
Declared in ZegoExpressDefines.h

参数

名称类型描述
callbackZegoMediaPlayerTakeSnapshotCallback媒体播放器播放画面截图的回调

详情

只有在调用 [setPlayerCanvas] 设置了显示控件，以及播放状态的情况下，才能正常截图

enableAccurateSeek:config:

enableAccurateSeek:config:
- (void)enableAccurateSeek:(BOOL) enable config:(ZegoAccurateSeekConfig *) config;
开启精准 seek 并设置相关属性
Declared in ZegoExpressDefines.h

参数

名称类型描述
enableBOOL是否开启精准 seek
configZegoAccurateSeekConfig *精准 seek 的属性设置，只有 enable 为 true 时有效。

详情

普通 seek 指定的时间戳可能是非 I 帧，进而返回指定时间戳前后的 I 帧，不是很精确。而精准 seek 当指定的时间戳不是 I 帧时，会通过指定时间戳前后的 I 帧去解指定时间戳的那帧数据。

  • 业务场景：适用于用户需要精准 seek 到指定时间戳的场景。
  • 调用时机：必须在加载资源前调用设置，在整个媒体播放器的生命周期内生效。
  • 支持版本：2.4.0 及以上。

setNetWorkResourceMaxCache:size:

setNetWorkResourceMaxCache:size:
- (void)setNetWorkResourceMaxCache:(unsigned int) time size:(unsigned int) size;
设置网络素材最大的缓存时长和缓存数据大小
Declared in ZegoExpressDefines.h

参数

名称类型描述
timeunsigned int缓存最大时长, 单位 ms, SDK 内部默认为5000；有效值为大于等于 2000；如果填 0, 表示不限制。
sizeunsigned int缓存最大尺寸, 单位 byte,SDK内部默认size为1510241024 byte；有效值为大于等于 5000000, 如果填 0, 表示不限制。

详情

必须在加载资源前调用设置，在整个媒体播放器的生命周期内生效。 time和size不允许同时为 0。SDK 内部默认time为5000, size为1510241024 byte。time和size中某一个指标先达到设置的值，就会停止缓存。 在加载资源时设置 onlineResourceCachePath 非空时，将通过 maxCachePendingLength 控制缓存，该配置无效。

getNetWorkResourceCache

getNetWorkResourceCache
- (ZegoNetWorkResourceCache *)getNetWorkResourceCache;
获取当前网络素材缓存队列的缓存数据可播放的时长和缓存数据大小
Declared in ZegoExpressDefines.h

返回当前缓存的信息，包括数据可播放的时长和缓存数据大小

setNetWorkBufferThreshold:

setNetWorkBufferThreshold:
- (void)setNetWorkBufferThreshold:(unsigned int) threshold;
通过该接口设置媒体播放器重新恢复播放需要达到的缓存阈值,SDK 默认值是 5000ms,有效值为大于等于1000ms
Declared in ZegoExpressDefines.h

参数

名称类型描述
thresholdunsigned int重新恢复播放需要达到的阈值, 单位 ms。

详情

必须在加载资源前调用设置,在整个媒体播放器的生命周期内生效。 当网络状态较差且媒体播放器将缓存的网络资源都播放完时，就会停止播放，并通过回调接口onMediaPlayerNetworkEvent的ZegoMediaPlayerNetworkEvent.BUFFER_BEGIN状态通知用户，告知正在重新缓存网络资源。 只有当缓存的网络资源大于设置的阈值的时候,媒体播放器才会在原来暂停的位置自动恢复播放，并通过回调接口onMediaPlayerNetworkEvent的ZegoMediaPlayerNetworkEvent.BUFFER_ENDED通知用户，告知用户缓存网络资源已经达到阈值并恢复了播放。

enableSoundLevelMonitor:millisecond:

enableSoundLevelMonitor:millisecond:
- (void)enableSoundLevelMonitor:(BOOL) enable millisecond:(unsigned int) millisecond;
是否开启声浪监听。
Declared in ZegoExpressDefines.h

参数

名称类型描述
enableBOOL是否开启监听，true 开启，false 关闭。
millisecondunsigned int声浪的监听时间周期，单位为毫秒，取值范围 [100, 3000]。

详情

开启或关闭声浪监听。

  • 调用时机：初始化引擎 [createEngine] 并创建媒体播放器 [createMediaPlayer] 之后调用。
  • 相关回调：开启后可以通过 [onMediaPlayerSoundLevelUpdate] 回调监听声浪更新。
  • 支持版本：2.15.0 及以上。
  • 使用限制：无。

enableFrequencySpectrumMonitor:millisecond:

enableFrequencySpectrumMonitor:millisecond:
- (void)enableFrequencySpectrumMonitor:(BOOL) enable millisecond:(unsigned int) millisecond;
是否开启频谱监听。
Declared in ZegoExpressDefines.h

参数

名称类型描述
enableBOOL是否开启监听，true 开启，false 关闭。
millisecondunsigned int频谱的监听时间周期，单位为毫秒，取值范围 [10, 3000]。注意在 3.19.0 及更老版本上，取值范围为 [100, 3000]

详情

开启或关闭频谱监听。

  • 调用时机：初始化引擎 [createEngine] 并创建媒体播放器 [createMediaPlayer] 之后调用。
  • 相关回调：开启后可以通过 [onMediaPlayerFrequencySpectrumUpdate] 回调监听声浪更新。
  • 支持版本：2.15.0 及以上。
  • 使用限制：无。

setActiveAudioChannel:

setActiveAudioChannel:
- (void)setActiveAudioChannel:(ZegoMediaPlayerAudioChannel) audioChannel;
设置播放声道。
Declared in ZegoExpressDefines.h

参数

名称类型描述
audioChannelZegoMediaPlayerAudioChannel播放声道，默认全部声道。

详情

设置播放声道。

  • 调用时机：初始化引擎 [createEngine] 并创建媒体播放器 [createMediaPlayer] 之后调用。
  • 支持版本：2.20.0 及以上。
  • 使用限制：无。

clearView

clearView
- (void)clearView;
清除播放控件播放结束后, 在控件上保留的最后一帧画面。
Declared in ZegoExpressDefines.h

清除播放控件播放结束后, 在控件上保留的最后一帧画面。

  • 调用时机：初始化引擎 [createEngine] 并创建媒体播放器 [createMediaPlayer] 之后调用。
  • 支持版本：2.20.0 及以上。
  • 使用限制：只有媒体播放器结束播放该接口调用才会生效。

getMediaInfo

getMediaInfo
- (ZegoMediaPlayerMediaInfo *)getMediaInfo;
获取媒体文件视频分辨率等媒体信息。
Declared in ZegoExpressDefines.h

获取媒体文件视频分辨率等媒体信息。

  • 调用时机：初始化引擎 [createEngine] 并创建媒体播放器 [createMediaPlayer] 之后调用。
  • 支持版本：3.6.0 及以上。
  • 使用限制：无。

updatePosition:

updatePosition:
- (void)updatePosition:(const float[_Nonnull 3]) position;
更新媒体播放器(音频源)位置。
Declared in ZegoExpressDefines.h

参数

名称类型描述
positionconst float[_Nonnull 3]自身在世界坐标系中的坐标，参数是长度为 3 的 float 数组。

详情

更新媒体播放器(音频源)位置。。

  • 业务场景：媒体播放器也需要有 3D 空间音效。
  • 调用时机：在已经初始化引擎 [createEngine] 且创建媒体播放器 [createMediaPlayer] 之后可以调用。
  • 支持版本：3.6.0 及以上。
  • 使用限制：此接口需要与 RangeAudio/RangeScene 模块配合使用，RangeAudio/RangeScene 模块开启 3D 音效后，此接口才能调用成功。

setHttpHeader:

setHttpHeader:
- (void)setHttpHeader:(NSDictionary<NSString *, NSString *> *) headers;
设置 http 头信息。
Declared in ZegoExpressDefines.h

参数

名称类型描述
headersNSDictionary<NSString *, NSString *> *头信息。

详情

调用该函数设置 http 网络资源的http headers。

  • 业务场景：当网络资源需要设置特殊的头信息时可以配置。
  • 调用时机：在已经初始化引擎 [createEngine] 且创建媒体播放器 [createMediaPlayer] 之后可以调用。
  • 支持版本：3.8.0 及以上。
  • 使用限制：在加载对应的网络资源之前调用。

setPlayMediaStreamType:

setPlayMediaStreamType:
- (void)setPlayMediaStreamType:(ZegoMediaStreamType) streamType;
设置播放的媒体流类型。
Declared in ZegoExpressDefines.h

参数

名称类型描述
streamTypeZegoMediaStreamType流类型。

详情

配置播放的媒体流类型，可以仅播放视频流或者音频流，在播放器生命周期内一直生效。

  • 业务场景：当仅需要播放视频流或者音频流时。
  • 调用时机：在已经初始化引擎 [createEngine] 且创建媒体播放器 [createMediaPlayer] 之后可以调用。
  • 支持版本：3.10.0 及以上。
  • 注意事项：播放时改变媒体流类型，将在下一次播放时生效。

enableLiveAudioEffect:mode:

enableLiveAudioEffect:mode:
- (void)enableLiveAudioEffect:(BOOL) enable mode:(ZegoLiveAudioEffectMode) mode;
开启现场音效。
Declared in ZegoExpressDefines.h

参数

名称类型描述
enableBOOL是否开启现场音效。
modeZegoLiveAudioEffectMode现场音效模式。

详情

开启现场音效后，空间感增强、乐器声音增强突出，不会增加延迟。

  • 业务场景：一般用于语聊房、K 歌场景下，增强伴奏的现场音效。
  • 调用时机：在已经初始化引擎 [createEngine] 且创建媒体播放器 [createMediaPlayer] 之后可以调用。
  • 支持版本：3.10.0 及以上。
  • 注意事项：为了提升现场音效的体验，我们建议配置双声道编码。开发者可以通过使用 [setAudioCaptureStereoMode] 方法来实现此配置。如果不进行双声道编码配置，某些歌曲的效果可能会显著降低，因为在合成单声道时，左右声道的效果可能会相互抵消，导致效果不明显。

enableLocalCache:cacheDir:

enableLocalCache:cacheDir:
- (void)enableLocalCache:(BOOL) enable cacheDir:(NSString *) cacheDir;
开启本地缓存 http/https 网络资源。
Declared in ZegoExpressDefines.h

参数

名称类型描述
enableBOOL是否开启本地缓存。
cacheDirNSString *缓存目录。如果留空会使用 SDK 内部指定的目录。

详情

当播放 http/https 网络资源时，开启本地缓存后，会将网络资源保存到本地，并通过 [onMediaPlayerLocalCache] 将缓存信息回调出来。

  • 调用时机：在已经初始化引擎 [createEngine] 且创建媒体播放器 [createMediaPlayer] 之后可以调用。在 [loadResource] 之后或者播放过程中调用，会在下一次播放生效。
  • 支持版本：3.12.0 及以上。
  • 注意事项：只支持 http/https 单文件类型网络资源，如果播放过程中有 [seekTo] 操作，缓存会失败。

enableViewMirror:

enableViewMirror:
- (void)enableViewMirror:(BOOL) enable;
开启画面镜像。
Declared in ZegoExpressDefines.h

参数

名称类型描述
enableBOOL是否开启画面镜像。

详情

开启画面镜像。

  • 调用时机：在已经初始化引擎 [createEngine] 且创建媒体播放器 [createMediaPlayer] 之后可以调用。
  • 支持版本：3.14.0 及以上。

getPlaybackStatistics

getPlaybackStatistics
- (ZegoMediaPlayerStatisticsInfo *)getPlaybackStatistics;
获取播放统计信息。
Declared in ZegoExpressDefines.h

获取当前播放统计信息，监控播放器解码和渲染是否发生异常。

  • 业务场景：一般用于云播放器场景。
  • 调用时机：在 [loadResource] 回调成功之后调用。
  • 支持版本：3.12.0 及以上。

setVoiceChangerParam:audioChannel:

setVoiceChangerParam:audioChannel:
deprecated
- (void)setVoiceChangerParam:(ZegoVoiceChangerParam *) param audioChannel:(ZegoMediaPlayerAudioChannel) audioChannel;
【已废弃】设置变声的具体参数
Declared in ZegoExpressDefines.h
名称类型描述
paramZegoVoiceChangerParam *变声参数
audioChannelZegoMediaPlayerAudioChannel要进行变声的声道
已废弃
此函数在 3.15.0 版本及以上已废弃，请使用 [enableVoiceChanger] 函数代替。

上一篇

zegomediadatapublishereventhandler

下一篇

zegomediaplayerblockdatahandler

当前页

返回到顶部