ZegoAudioPlayer Class Reference

Inherits from NSObject
Declared in zego-api-audio-player-oc.h

Overview

音效播放器

– setDelegate:

设置回调

- (void)setDelegate:(id<ZegoAudioPlayerDelegate>)delegate

Declared In

zego-api-audio-player-oc.h

– playEffect:source:loop:publish:

播放音效

- (void)playEffect:(unsigned int)soundID source:(NSString *)path loop:(int)loopCount publish:(BOOL)publish

Parameters

soundID

音效 ID
path

音效资源文件的本地路径
loopCount

循环次数，-1 表示无限循环，0 表示不循环，>0 表示循环次数，实际播放次数为 (loopCount+1)
publish

是否放入推流中

@attention 如果是播放预加载的音效，指定音效 ID, 音效资源文件填 nil

Declared In

zego-api-audio-player-oc.h

– stopEffect:

停止播放音效

- (void)stopEffect:(unsigned int)soundID

Parameters

soundID

音效 ID

Declared In

zego-api-audio-player-oc.h

– pauseEffect:

暂停播放音效

- (void)pauseEffect:(unsigned int)soundID

Parameters

soundID

音效 ID

Declared In

zego-api-audio-player-oc.h

– resumeEffect:

恢复播放音效

- (void)resumeEffect:(unsigned int)soundID

Parameters

soundID

音效 ID

Declared In

zego-api-audio-player-oc.h

– setEffect:volume:

设置单个音效的本地播放音量, 如果该音效 ID 设置了推流模式, 也会设置推流音量

- (void)setEffect:(unsigned int)soundID volume:(int)volume

Parameters

soundID

音效 ID
volume

音量，取值范围[0, 200]，默认 100

Discussion

Note: 请在调用 playEffect 后调用此接口

Declared In

zego-api-audio-player-oc.h

– setEffect:publishVolume:

设置单个音效的推流音量

- (void)setEffect:(unsigned int)soundID publishVolume:(int)volume

Parameters

soundID

音效 ID
volume

音量，取值范围[0, 200]，默认 100

Discussion

Note: 请在调用 playEffect 后调用此接口

Declared In

zego-api-audio-player-oc.h

– setEffect:playVolume:

设置单个音效的本地播放音量

- (void)setEffect:(unsigned int)soundID playVolume:(int)volume

Parameters

soundID

音效 ID
volume

音量，取值范围[0, 200]，默认 100

Discussion

Note: 请在调用 playEffect 后调用此接口

Declared In

zego-api-audio-player-oc.h

– setVolumeAll:

设置所有音效的本地播放音量, 如果音效 ID 设置了推流模式, 也会设置推流音量

- (void)setVolumeAll:(int)volume

Parameters

volume

音量，取值范围[0, 200]，默认 100

Discussion

Note: 请在 ZegoAudioPlayer 创建后调用此接口

Declared In

zego-api-audio-player-oc.h

– setPublishVolumeAll:

设置所有音效的推流音量

- (void)setPublishVolumeAll:(int)volume

Parameters

volume

音量，取值范围[0, 200]，默认 100

Discussion

Note: 请在 ZegoAudioPlayer 创建后调用此接口

Declared In

zego-api-audio-player-oc.h

– setPlayVolumeAll:

设置所有音效的本地播放音量

- (void)setPlayVolumeAll:(int)volume

Parameters

volume

音量，取值范围[0, 200]，默认 100

Discussion

Note: 请在 ZegoAudioPlayer 创建后调用此接口

Declared In

zego-api-audio-player-oc.h

– setPlaySpeed:speed:

设置指定音效的播放速度

- (void)setPlaySpeed:(unsigned int)soundID speed:(float)speed

Parameters

soundID

音效 ID
speed

倍速，取值范围[0.5, 2.0]，默认 1.0

Declared In

zego-api-audio-player-oc.h

– pauseAll

暂停全部音效

- (void)pauseAll

Declared In

zego-api-audio-player-oc.h

– resumeAll

恢复全部音效

- (void)resumeAll

Declared In

zego-api-audio-player-oc.h

– stopAll

停止全部音效

- (void)stopAll

Declared In

zego-api-audio-player-oc.h

– preloadEffect:source:

预加载音效

- (void)preloadEffect:(unsigned int)soundID source:(NSString *)path

Parameters

soundID

音效 ID
path

音效资源文件的本地路径

Declared In

zego-api-audio-player-oc.h

– unloadEffect:

删除预加载音效

- (void)unloadEffect:(unsigned int)soundID

Parameters

soundID

音效 ID

Declared In

zego-api-audio-player-oc.h

– seekTo:timestamp:

设置进度

- (int)seekTo:(unsigned int)soundID timestamp:(long)timestamp

Parameters

soundID

音效 ID
timestamp

进度, 单位毫秒

Return Value

返回 -1 表示失败, 返回 0 表示成功

Declared In

zego-api-audio-player-oc.h

– getDuration:

获取音效的总时长

- (long)getDuration:(unsigned int)soundID

Parameters

soundID

音效 ID

Return Value

返回音效的总时长, 失败返回 0

Declared In

zego-api-audio-player-oc.h

– getCurrentDuration:

获取音效的当前进度

- (long)getCurrentDuration:(unsigned int)soundID

Parameters

soundID

音效 ID

Return Value

返回音效的当前进度, 失败返回 -1

Declared In

zego-api-audio-player-oc.h

– updatePosition:position:

更新音效播放器(音频源)位置

- (void)updatePosition:(unsigned int)soundID position:(const float [ _Nonnull 3 ])position

Parameters

position

用户的三维空间坐标
nSoundID

音效 ID

Discussion

Note: 此接口需要与 RangeAudio/RangeScene 模块配合使用，RangeAudio/RangeScene 模块开启 3D 音效后，此接口才能调用成功

Note: 此接口需要在收到 OnPlayEffect 回调后调用

Declared In

zego-api-audio-player-oc.h