- 动态与公告
- 产品简介
- 购买指南
- 新手指引
- Demo 体验
- 视频通话（含 UI）
- 组件介绍（TUICallKit）
- 开通服务（TUICallKit）
- 跑通 Demo（TUICallKit）
- 快速接入（TUICallKit）
- Chat 集成通话能力（TUICallKit）
- 界面定制（TUICallKit）
- 离线唤醒（TUICallKit）
- AI 降噪（TUICallKit）
- 虚拟背景（TUICallKit）
- 会话聊天（TUICallKit）
- 云端录制（TUICallKit）
- 更多特性（TUICallKit）
- 解决方案（TUICallKit）
- 服务端 API（TUICallKit）
- 客户端 API（TUICallKit）
- 错误码表（TUICallkit）
- 发布日志（TUICallKit）
- 常见问题（TUICallKit）
- 多人会议（含 UI）
- 组件介绍（TUIRoomKit）
- 开通服务（TUIRoomKit）
- 跑通 Demo（TUIRoomKit）
- 快速接入（TUIRoomKit）
- 屏幕共享（TUIRoomKit）
- 预定会议（TUIRoomKit）
- 会中呼叫（TUIRoomKit）
- 界面定制（TUIRoomKit）
- 虚拟背景（TUIRoomKit）
- 会议控制（TUIRoomKit）
- 云端录制（TUIRoomKit）
- AI 降噪（TUIRoomKit）
- 会中聊天（TUIRoomKit）
- 机器人推流（TUIRoomKit）
- 更多特性（TUIRoomKit）
- 客户端 API（TUIRoomKit）
- 服务端 API（TUIRoomKit）
- 常见问题（TUIRoomKit）
- 错误码 (TUIRoomKit)
- SDK更新日志（TUIRoomKit）
- 在线直播（含 UI）
- Live 视频直播计费说明
- 组件介绍（TUILiveKit）
- 开通服务（TUILiveKit）
- 跑通 Demo（TUILiveKit）
- 快速接入（TUILiveKit）
- 界面定制（TUILiveKit）
- 开播和观看（TUILiveKit）
- 房间列表（TUILiveKit）
- 关注主播（TUILiveKit）
- 主播连线（TUILiveKit）
- 主播 PK（TUILiveKit）
- 观众连麦（TUILiveKit）
- 互动弹幕（TUILiveKit）
- 互动礼物（TUILiveKit）
- 礼物特效（TUILiveKit）
- 美颜特效（TUILiveKit）
- 悬浮窗（TUILiveKit）
- 客户端 API（TUILiveKit）
- 服务端 API（TUILiveKit）
- 错误码（TUILiveKit）
- 发布日志（TUILiveKit）
- 常见问题（TUILiveKit）
- 语音聊天室（含 UI）
- 无 UI 集成
- 高级功能
- 服务端 API
- 控制台指南
- 解决方案
- 常见问题
- 旧版文档
- 协议与策略
- TRTC 政策
- 词汇表
- 动态与公告
- 产品简介
- 购买指南
- 新手指引
- Demo 体验
- 视频通话（含 UI）
- 组件介绍（TUICallKit）
- 开通服务（TUICallKit）
- 跑通 Demo（TUICallKit）
- 快速接入（TUICallKit）
- Chat 集成通话能力（TUICallKit）
- 界面定制（TUICallKit）
- 离线唤醒（TUICallKit）
- AI 降噪（TUICallKit）
- 虚拟背景（TUICallKit）
- 会话聊天（TUICallKit）
- 云端录制（TUICallKit）
- 更多特性（TUICallKit）
- 解决方案（TUICallKit）
- 服务端 API（TUICallKit）
- 客户端 API（TUICallKit）
- 错误码表（TUICallkit）
- 发布日志（TUICallKit）
- 常见问题（TUICallKit）
- 多人会议（含 UI）
- 组件介绍（TUIRoomKit）
- 开通服务（TUIRoomKit）
- 跑通 Demo（TUIRoomKit）
- 快速接入（TUIRoomKit）
- 屏幕共享（TUIRoomKit）
- 预定会议（TUIRoomKit）
- 会中呼叫（TUIRoomKit）
- 界面定制（TUIRoomKit）
- 虚拟背景（TUIRoomKit）
- 会议控制（TUIRoomKit）
- 云端录制（TUIRoomKit）
- AI 降噪（TUIRoomKit）
- 会中聊天（TUIRoomKit）
- 机器人推流（TUIRoomKit）
- 更多特性（TUIRoomKit）
- 客户端 API（TUIRoomKit）
- 服务端 API（TUIRoomKit）
- 常见问题（TUIRoomKit）
- 错误码 (TUIRoomKit)
- SDK更新日志（TUIRoomKit）
- 在线直播（含 UI）
- Live 视频直播计费说明
- 组件介绍（TUILiveKit）
- 开通服务（TUILiveKit）
- 跑通 Demo（TUILiveKit）
- 快速接入（TUILiveKit）
- 界面定制（TUILiveKit）
- 开播和观看（TUILiveKit）
- 房间列表（TUILiveKit）
- 关注主播（TUILiveKit）
- 主播连线（TUILiveKit）
- 主播 PK（TUILiveKit）
- 观众连麦（TUILiveKit）
- 互动弹幕（TUILiveKit）
- 互动礼物（TUILiveKit）
- 礼物特效（TUILiveKit）
- 美颜特效（TUILiveKit）
- 悬浮窗（TUILiveKit）
- 客户端 API（TUILiveKit）
- 服务端 API（TUILiveKit）
- 错误码（TUILiveKit）
- 发布日志（TUILiveKit）
- 常见问题（TUILiveKit）
- 语音聊天室（含 UI）
- 无 UI 集成
- 高级功能
- 服务端 API
- 控制台指南
- 解决方案
- 常见问题
- 旧版文档
- 协议与策略
- TRTC 政策
- 词汇表
本文档主要介绍如何使用
RTC Room Engine SDK 实现背景音乐相关功能。前提条件
使用指引
开始/停止播放背景音乐
您可以分别通过调用
startPlayMusic和stopPlayMusic两个接口，来开始或停止播放背景音乐。在调用
startPlayMusic开始播放背景音乐时，需要传入一个TXAudioMusicParam类型的参数来设置播放控制信息。TXAudioMusicParam包含以下信息，您可以分别对其进行设置：枚举类型 | 描述 |
id | 字段含义：音乐 ID。 特殊说明：SDK 允许播放多路音乐，因此需要使用 ID 进行标记，用于控制音乐的开始、停止、音量等。 |
endTimeMS | 字段含义：音乐结束播放时间点，单位毫秒，0表示播放至文件结尾。 |
isShortFile | 字段含义：播放的是否为短音乐文件。 推荐取值： YES：需要重复播放的短音乐文件。 NO：正常的音乐文件。默认值：NO。 |
loopCount | 字段含义：音乐循环播放的次数。 推荐取值：取值范围为0 - 任意正整数，默认值：0。0 表示播放音乐一次；1 表示播放音乐两次；以此类推。 |
path | 字段含义：音效文件的完整路径或 URL 地址。支持的音频格式包括 MP3、AAC、M4A、WAV。 |
publish | 字段含义：是否将音乐传到远端。 推荐取值： YES：音乐在本地播放的同时，远端用户也能听到该音乐。 NO：主播只能在本地听到该音乐，远端观众听不到。默认值：NO。 |
startTimeMS | 字段含义：音乐开始播放时间点，单位：毫秒 |
您可以分别通过调用
startPlayMusic和stopPlayMusic两个接口，来开始或停止播放背景音乐。在调用
startPlayMusic开始播放背景音乐时，需要传入一个AudioMusicParam类型的参数来设置播放控制信息。AudioMusicParam包含以下信息，您可以分别对其进行设置：枚举类型 | 描述 |
id | 字段含义：音乐 ID。 特殊说明：SDK 允许播放多路音乐，因此需要使用 ID 进行标记，用于控制音乐的开始、停止、音量等。 |
endTimeMS | 字段含义：音乐结束播放时间点，单位毫秒，0表示播放至文件结尾。 |
isShortFile | 字段含义：播放的是否为短音乐文件。 推荐取值： YES：需要重复播放的短音乐文件。 NO：正常的音乐文件。默认值：NO。 |
loopCount | 字段含义：音乐循环播放的次数。 推荐取值：取值范围为0 - 任意正整数，默认值：0。0 表示播放音乐一次；1 表示播放音乐两次；以此类推。 |
path | 字段含义：音效文件的完整路径或 URL 地址。支持的音频格式包括 MP3、AAC、M4A、WAV。 |
publish | 字段含义：是否将音乐传到远端。 推荐取值： YES：音乐在本地播放的同时，远端用户也能听到该音乐。 NO：主播只能在本地听到该音乐，远端观众听不到。默认值：NO。 |
startTimeMS | 字段含义：音乐开始播放时间点，单位：毫秒 |
以下是一个简单开始/停止播放背景音乐的示例：
import RTCRoomEngineimport TXLiteAVSDK_Professionallet audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager()// 开始播放背景音乐let musicParam = TXAudioMusicParam()musicParam.id = 0 // 替换为您自己的音乐IDmusicParam.path = "path" // 替换为音乐文件的完整路径或 URL 地址musicParam.publish = true // 将音乐传到远端musicParam.loopCount = 0 // 替换为您需要循环播放的次数audioEffectManager.startPlayMusic(musicParam) { code inif code == 0 {// 开始播放成功} else {// 开始播放失败}} onProgress: { progress, duration in// 播放进度回调} onComplete: { _ in// 播放结束回调}// 停止播放背景音乐audioEffectManager.stopPlayMusic(musicId) // 替换为您需要停止播放的音乐ID
TXAudioEffectManager audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager();int id = 0; // 替换为您自己的音乐IDString path = "path"; // 替换为音乐文件的完整路径或 URL 地址// 开始播放背景音乐TXAudioEffectManager.AudioMusicParam musicParam = new TXAudioEffectManager.AudioMusicParam(id, path);musicParam.publish = true; // 将音乐传到远端musicParam.loopCount = 0; // 替换为您需要循环播放的次数audioEffectManager.startPlayMusic(musicParam);// 停止播放背景音乐audioEffectManager.stopPlayMusic(id); // 替换为您需要停止播放的音乐ID
设置背景音乐音量
您可以通过调用
setAllMusicVolume接口并传入一个Int值，来设置背景音乐的音量。传入的Int值代表音量大小，取值范围为0 - 100。以下是一个调用
setAllMusicVolume设置背景音乐音量的示例：import RTCRoomEngineimport TXLiteAVSDK_Professionallet audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager()let volume = 60 // 替换为您需要设置的音量大小audioEffectManager.setAllMusicVolume(volume)
TXAudioEffectManager audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager();int volume = 60; // 替换为您需要设置的音量大小audioEffectManager.setAllMusicVolume(volume);
是
否
本页内容是否解决了您的问题？