nertc.RtcCreateAudioEffectOption结构体 参考

Public 属性
string	path
int	loopCount
bool	sendEnabled
uint	sendVolume
bool	playbackEnabled
uint	playbackVolume
ulong	startTimestamp
RtcAudioStreamType	streamType
uint	progressInterval

详细描述

创建音效的配置项。

类成员变量说明

path

string nertc.RtcCreateAudioEffectOption.path

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

• 需精确到文件名及后缀，例如 “D:\audioFiles\test.mp3”。
• 支持的音效文件类型包括 MP3、M4A、AAC、3GP、WMA 和 WAV 格式。

loopCount

int nertc.RtcCreateAudioEffectOption.loopCount

音效循环播放的次数：

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

sendEnabled

bool nertc.RtcCreateAudioEffectOption.sendEnabled

是否将伴音发送远端，默认为 true，即远端用户订阅本端音频流后可听到该伴音。

sendVolume

uint nertc.RtcCreateAudioEffectOption.sendVolume

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

注解

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

playbackEnabled

bool nertc.RtcCreateAudioEffectOption.playbackEnabled

是否可播放。默认为 true，即可在本地播放该音效。

playbackVolume

uint nertc.RtcCreateAudioEffectOption.playbackVolume

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

注解

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

startTimestamp

ulong nertc.RtcCreateAudioEffectOption.startTimestamp

音乐文件开始播放的时间，UTC 时间戳，即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到事件发生时的毫秒数。默认值为。 0，表示立即播放。

streamType

RtcAudioStreamType nertc.RtcCreateAudioEffectOption.streamType

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

progressInterval

uint nertc.RtcCreateAudioEffectOption.progressInterval

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

---

该结构体的文档由以下文件生成:

• RtcBase.cs