#include <nertc_engine_defines.h>

Public 属性
char	path [kNERtcMaxURILength]

int	loop_count

bool	send_enabled

uint32_t	send_volume

bool	playback_enabled

uint32_t	playback_volume

NERtcAudioStreamType	send_with_audio_type

uint64_t	start_timestamp

uint32_t	progress_interval

详细描述

创建音效的配置项

类成员变量说明

◆ loop_count

int nertc::NERtcCreateAudioEffectOption::loop_count

音效循环播放的次数：

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

◆ path

char nertc::NERtcCreateAudioEffectOption::path[kNERtcMaxURILength]

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

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

◆ playback_enabled

bool nertc::NERtcCreateAudioEffectOption::playback_enabled

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

◆ playback_volume

uint32_t nertc::NERtcCreateAudioEffectOption::playback_volume

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

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

◆ progress_interval

uint32_t nertc::NERtcCreateAudioEffectOption::progress_interval

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

◆ send_enabled

bool nertc::NERtcCreateAudioEffectOption::send_enabled

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

◆ send_volume

uint32_t nertc::NERtcCreateAudioEffectOption::send_volume

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

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

◆ send_with_audio_type

NERtcAudioStreamType nertc::NERtcCreateAudioEffectOption::send_with_audio_type

音频流类型。默认为 kRtcAudioStreamTypeMain。

◆ start_timestamp

uint64_t nertc::NERtcCreateAudioEffectOption::start_timestamp

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

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

include/nertc_engine_defines.h

Public 属性