NERtcCreateAudioEffectOption类 参考

Options for creating audio effects 更多...

#include <NERtcEngineBase.h>

类 NERtcCreateAudioEffectOption 继承关系图:

属性
NSString *	path
	待播放的音效文件路径，支持本地绝对路径或 URL 地址。
int	loopCount
	音效循环播放的次数：
BOOL	sendEnabled
	是否将音效发送远端。默认为 YES，即远端用户可以听到该音效。
BOOL	playbackEnabled
	是否本地播放该音效。默认为 YES，即本地用户可以听到该音效。
uint32_t	sendVolume
	音效文件的发送音量，取值范围为 0~100。默认为 100，表示使用文件的原始音量。
uint32_t	playbackVolume
	音效文件的播放音量，取值范围为 0~100。默认为 100，表示使用文件的原始音量。
int64_t	startTimeStamp
	音效文件开始播放的时间，UTC 时间戳，默认值为 0，表示立即播放。
NERtcAudioStreamType	sendWithAudioType
	音效跟随音频主流还是辅流，默认跟随主流。
uint64_t	progressInterval
	音效播放进度回调间隔，单位 ms，取值范围为 100~10000, 默认 1000ms

详细描述

Options for creating audio effects

属性说明

loopCount

- (int) loopCount

readwritenonatomicassign

音效循环播放的次数：

• 1：（默认）播放音效一次。
• ≤ 0：无限循环播放音效，直至调用 stopEffect 或 stopAllEffects 后停止。

path

- (NSString*) path

readwritenonatomiccopy

待播放的音效文件路径，支持本地绝对路径或 URL 地址。

• 需精确到文件名及后缀。
• 支持的音效文件类型包括 MP3、M4A、AAC、3GP、WMA 和 WAV 格式。

playbackEnabled

- (BOOL) playbackEnabled

readwritenonatomicassign

是否本地播放该音效。默认为 YES，即本地用户可以听到该音效。

playbackVolume

- (uint32_t) playbackVolume

readwritenonatomicassign

音效文件的播放音量，取值范围为 0~100。默认为 100，表示使用文件的原始音量。

注解

若您在通话中途修改了音量设置，则当前通话中再次调用时默认沿用此设置。

progressInterval

- (uint64_t) progressInterval

readwritenonatomicassign

音效播放进度回调间隔，单位 ms，取值范围为 100~10000, 默认 1000ms

sendEnabled

- (BOOL) sendEnabled

readwritenonatomicassign

是否将音效发送远端。默认为 YES，即远端用户可以听到该音效。

sendVolume

- (uint32_t) sendVolume

readwritenonatomicassign

音效文件的发送音量，取值范围为 0~100。默认为 100，表示使用文件的原始音量。

注解

若您在通话中途修改了音量设置，则当前通话中再次调用时默认沿用此设置。

sendWithAudioType

- (NERtcAudioStreamType) sendWithAudioType

readwritenonatomicassign

音效跟随音频主流还是辅流，默认跟随主流。

startTimeStamp

- (int64_t) startTimeStamp

readwritenonatomicassign

音效文件开始播放的时间，UTC 时间戳，默认值为 0，表示立即播放。

---

该类的文档由以下文件生成:

• D:/Formatter/api-doc-to-git/lava/lava/nertcsdk/src/sdk/ios/include/NERtcEngineBase.h