tencent cloud

实时音视频

动态与公告
产品动态
产品近期公告
关于 TRTC Live 正式上线的公告
关于TRTC Conference 正式版上线的公告
Conference 商业化版本即将推出
关于多人音视频 Conference 开启内测公告
关于音视频通话 Call 正式版上线的公告
关于腾讯云音视频终端 SDK 播放升级及新增授权校验的公告
关于 TRTC 应用订阅套餐服务上线的相关说明
产品简介
产品概述
基本概念
产品功能
产品优势
应用场景
性能数据
购买指南
计费概述
免费时长说明
月订阅
现收现付
TRTC 逾期与暂停政策
常见问题解答
退款说明
新手指引
Demo 体验
视频通话 SDK
组件介绍
开通服务
跑通 Demo
快速接入
离线唤醒
会话聊天
云端录制
AI 降噪
界面定制
Chat 集成通话能力
更多特性
无 UI 集成
服务端 API
客户端 API
解决方案
错误码表
发布日志
常见问题
视频会议 SDK
组件介绍(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)
直播与语聊 SDK
Live 视频直播计费说明
组件介绍
开通服务(TUILiveKit)
跑通 Demo
无 UI 集成
UI 自定义
直播监播
视频直播
语聊房
高级功能
客户端 API
服务端 API
错误码
发布日志
常见问题
RTC Engine
开通服务
SDK 下载
API-Example
接入指引
API-参考手册
高级功能
AI 集成
概述
MCP 配置
Skills 配置
集成指南
常见问题
RTC RESTFUL API
History
Introduction
API Category
Room Management APIs
Stream mixing and relay APIs
On-cloud recording APIs
Data Monitoring APIs
Pull stream Relay Related interface
Web Record APIs
AI Service APIs
Cloud Slicing APIs
Cloud Moderation APIs
Making API Requests
Call Quality Monitoring APIs
Usage Statistics APIs
Data Types
Appendix
Error Codes
控制台指南
应用管理
套餐包管理
用量统计
监控仪表盘
开发辅助
解决方案
实时合唱
常见问题
迁移指南
计费相关
功能相关
UserSig 相关
应对防火墙限制相关
缩减安装包体积相关
Andriod 与 iOS 相关
Web 端相关
Flutter 相关
Electron 相关
TRTCCalling Web 相关
音视频质量相关
其他问题
旧版文档
RTC RoomEngine SDK(旧)
集成 TUIRoom (Web)
集成 TUIRoom (Android)
集成 TUIRoom (iOS)
集成 TUIRoom (Flutter)
集成 TUIRoom (Electron)
TUIRoom API 查询
实现云端录制与回放(旧)
监控仪表盘计费(旧)
协议与策略
安全合规认证
安全白皮书
信息安全说明
服务等级协议
苹果隐私策略:PrivacyInfo.xcprivacy
TRTC 政策
隐私协议
数据处理和安全协议
词汇表

背景音乐

PDF
聚焦模式
字号
最后更新时间: 2025-06-23 14:18:25
本文档主要介绍如何使用 RTC Room Engine SDK 实现背景音乐相关功能。

前提条件

在使用RTC Room Engine SDK 提供的背景音乐设置相关功能之前,您需要先 登录 SDK。

使用指引

开始/停止播放背景音乐

iOS
Android
您可以分别通过调用startPlayMusicstopPlayMusic两个接口,来开始或停止播放背景音乐。
在调用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
字段含义:音乐开始播放时间点,单位:毫秒。
您可以分别通过调用startPlayMusicstopPlayMusic两个接口,来开始或停止播放背景音乐。
在调用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
字段含义:音乐开始播放时间点,单位:毫秒。
以下是一个简单开始/停止播放背景音乐的示例:
iOS
Android
import RTCRoomEngine
import TXLiteAVSDK_Professional

let audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager()

// 开始播放背景音乐
let musicParam = TXAudioMusicParam()
musicParam.id = 0 // 替换为您自己的音乐ID
musicParam.path = "path" // 替换为音乐文件的完整路径或 URL 地址
musicParam.publish = true // 将音乐传到远端
musicParam.loopCount = 0 // 替换为您需要循环播放的次数
audioEffectManager.startPlayMusic(musicParam) { code in
if code == 0 {
// 开始播放成功
} else {
// 开始播放失败
}
} onProgress: { progress, duration in
// 播放进度回调
} onComplete: { _ in
// 播放结束回调
}

// 停止播放背景音乐
audioEffectManager.stopPlayMusic(musicId) // 替换为您需要停止播放的音乐ID

TXAudioEffectManager audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager();

int id = 0; // 替换为您自己的音乐ID
String 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设置背景音乐音量的示例:
iOS
Android
import RTCRoomEngine
import TXLiteAVSDK_Professional

let audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager()

let volume = 60 // 替换为您需要设置的音量大小
audioEffectManager.setAllMusicVolume(volume)
TXAudioEffectManager audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager();

int volume = 60; // 替换为您需要设置的音量大小
audioEffectManager.setAllMusicVolume(volume);


帮助和支持

本页内容是否解决了您的问题?

填写满意度调查问卷,共创更好文档体验。

文档反馈