Options for creating mixing audios 更多...
#include <NERtcEngineBase.h>
类 NERtcCreateAudioMixingOption 继承关系图:
构造函数 | |
| (BOOL) | - isInvalid |
| 检查 option 参数值的合法性。 | |
属性 | |
| NSString * | path |
| 待播放的音乐文件的绝对路径或 URL 地址，支持本地绝对路径或 URL 地址。 | |
| int | loopCount |
| 伴音循环播放的次数： 1：（默认）播放一次。 ≤ 0：无限循环播放，直至调用 pauseAudioMixing 后暂停，或调用 stopAudioMixing 后停止。 | |
| BOOL | sendEnabled |
| 是否将伴音发送远端，默认为 YES，即远端用户订阅本端音频流后可听到该伴音。 | |
| BOOL | playbackEnabled |
| 是否本地播放伴音。默认为 YES，即本地用户可以听到该伴音。 | |
| uint32_t | sendVolume |
| 音乐文件的发送音量，取值范围为 0~200。默认为 100，表示使用文件的原始音量。 | |
| uint32_t | playbackVolume |
| 音乐文件的播放音量，取值范围为 0~200。默认为 100，表示使用文件的原始音量。 | |
| int64_t | startTimeStamp |
| 音乐文件开始播放的时间，UTC 时间戳，即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到事件发生时的毫秒数。默认值为 0，表示立即播放。 | |
| NERtcAudioStreamType | sendWithAudioType |
| 伴音跟随音频主流还是辅流，默认跟随主流。 | |
| uint64_t | progressInterval |
| 伴音播放进度回调间隔，单位 ms，取值范围为 100~10000, 默认 1000ms | |
详细描述
Options for creating mixing audios
函数文档
◆ isInvalid
| - (BOOL) isInvalid |
检查 option 参数值的合法性。
- 返回 NO：option 参数值合法。
- 返回 YES：option 参数值设置错误，请检查后重试。
属性说明
◆ loopCount
|
readwritenonatomicassign |
伴音循环播放的次数： 1：（默认）播放一次。 ≤ 0：无限循环播放，直至调用 pauseAudioMixing 后暂停，或调用 stopAudioMixing 后停止。
◆ path
|
readwritenonatomiccopy |
待播放的音乐文件的绝对路径或 URL 地址，支持本地绝对路径或 URL 地址。
- 需精确到文件名及后缀。
- 支持的音效文件类型包括 MP3、M4A、AAC、3GP、WMA 和 WAV 格式。
◆ playbackEnabled
|
readwritenonatomicassign |
是否本地播放伴音。默认为 YES，即本地用户可以听到该伴音。
◆ playbackVolume
|
readwritenonatomicassign |
音乐文件的播放音量，取值范围为 0~200。默认为 100，表示使用文件的原始音量。
- 注解
- 若您在通话中途修改了音量设置，则当前通话中再次调用时默认沿用此设置。
◆ progressInterval
|
readwritenonatomicassign |
伴音播放进度回调间隔，单位 ms，取值范围为 100~10000, 默认 1000ms
◆ sendEnabled
|
readwritenonatomicassign |
是否将伴音发送远端，默认为 YES，即远端用户订阅本端音频流后可听到该伴音。
◆ sendVolume
|
readwritenonatomicassign |
音乐文件的发送音量，取值范围为 0~200。默认为 100，表示使用文件的原始音量。
- 注解
- 若您在通话中途修改了音量设置，则当前通话中再次调用时默认沿用此设置。
◆ sendWithAudioType
|
readwritenonatomicassign |
伴音跟随音频主流还是辅流，默认跟随主流。
◆ startTimeStamp
|
readwritenonatomicassign |
音乐文件开始播放的时间，UTC 时间戳，即从 1970 年 1 月 1 日 0 点 0 分 0 秒开始到事件发生时的毫秒数。默认值为 0，表示立即播放。
该类的文档由以下文件生成:
- D:/Formatter/api-doc-to-git/lava/lava/nertcsdk/src/sdk/ios/include/NERtcEngineBase.h
