tencent cloud

Tencent Real-Time Communication

お知らせ・リリースノート
製品アップデート情報
Tencent Cloudオーディオビデオ端末SDKの再生アップグレードおよび承認チェック追加に関するお知らせ
TRTCアプリケーションのサブスクリプションパッケージサービスのリリースに関する説明について
製品の説明
製品概要
基礎概念
製品の機能
製品の強み
ユースケース
性能データ
購入ガイド
Billing Overview
無料時間の説明
Monthly subscription
Pay-as-you-go
TRTC Overdue and Suspension Policy
課金に関するよくあるご質問
Refund Instructions
初心者ガイド
Demo体験
Call
コンポーネントの説明(TUICallKit)
Activate the Service
Run Demo
クイック導入
オフライン通知
Conversational Chat
クラウドレコーディング(TUICallKit)
AI Noise Reduction
インターフェースのカスタマイズ
Calls integration to Chat
Additional Features
No UI Integration
Server APIs
Client APIs
Solution
ErrorCode
公開ログ
よくある質問
ライブ配信
Billing of Video Live Component
Overview
Activating the Service (TUILiveKit)
Demo のクイックスタート
No UI Integration
UI Customization
Live Broadcast Monitoring
Video Live Streaming
Voice Chat Room
Advanced Features
Client APIs
Server APIs
Error Codes
Release Notes
FAQs
RTC Engine
Activate Service
SDKのダウンロード
APIコードサンプル
Usage Guidelines
クライアント側 API
高度な機能
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
コンソールガイド
アプリケーション管理
使用統計
監視ダッシュボード
開発支援
Solution
Real-Time Chorus
よくあるご質問
課金関連問題
機能関連
UserSig関連
ファイアウォールの制限の対応関連
インストールパッケージの圧縮に関するご質問
AndriodおよびiOS関連
Web端末関連
Flutter関連
Electron関連
TRTCCalling Web関連
オーディオビデオ品質関連
その他のご質問
旧バージョンのドキュメント
TUIRoom(Web)の統合
TUIRoom (Android)の統合
TUIRoom (iOS)の統合
TUIRoom (Flutter)の統合
TUIRoom (Electron)の統合
TUIRoom APIのクエリー
クラウドレコーディングと再生の実現(旧)
Protocols and Policies
セキュリティコンプライアンス認証
セキュリティホワイトペーパー
情報セキュリティの説明
Service Level Agreement
Apple Privacy Policy: PrivacyInfo.xcprivacy
TRTC ポリシー
プライバシーポリシー
データ処理とセキュリティ契約
用語集
ドキュメントTencent Real-Time Communication

Background Music

フォーカスモード
フォントサイズ
最終更新日: 2025-06-23 14:17:51
this document primarily introduces how to use RTC Room Engine SDK to implement relevant features of background music.

Prerequisites

Before using the background music settings-related features provided by RTC Room Engine SDK, you need to log in to the SDK first.

User Guide

Start/Stop Playing Background Music

iOS
Android
You can start or stop playing background music by calling startPlayMusic and stopPlayMusic two APIs.
When calling startPlayMusic to start playing background music, you need to input a parameter in types of TXAudioMusicParam to set playback control information. TXAudioMusicParam contains following information, which you can set separately:
Enumeration Types
Description
id
Field Meaning: Music ID.
Special Instructions: The SDK allows playback of multiple music streams. Therefore, IDs are required for tagging to control the start, stop, and volume of the music.
endTimeMS
Field Meaning: Music end playback time point, in milliseconds, with 0 indicating playback to the end of the file.
isShortFile
Field Meaning: Whether the playback is a short music file.
Recommended Value:
YES: Short music files that need to be repeated.
NO: Normal music file. Default value: NO.
loopCount
Field Meaning: Number of music loops.
Recommended Value: The value range is from 0 to any positive integer. The default value is 0. 0 means play the music once; 1 means play the music twice; and so on.
path
Field Meaning: Complete path or URL address of the sound effect file. Supported audio formats include MP3, AAC, M4A, WAV.
publish
Field Meaning: Whether to transmit music to remote end.
Recommended Value:
YES: The music can be played locally while the remote user can also hear it.
NO: The anchor can only hear the music locally, and the remote audience cannot hear it. Default value: NO.
startTimeMS
Field Meaning: Music start playback time point, in milliseconds.
You can start or stop playing background music by calling startPlayMusic and stopPlayMusic two APIs.
When calling startPlayMusic to start playing background music, you need to input a parameter in types of AudioMusicParam to set playback control information. AudioMusicParam contains following information, which you can set separately:
Enumeration Types
Description
id
Field Meaning: Music ID.
Special Instructions: The SDK allows playback of multiple music streams. Therefore, IDs are required for tagging to control the start, stop, and volume of the music.
endTimeMS
Field Meaning: Music end playback time point, in milliseconds, with 0 indicating playback to the end of the file.
isShortFile
Field Meaning: Whether the playback is a short music file.
Recommended Value:
YES: Short music files that need to be repeated.
NO: Normal music file. Default value: NO.
loopCount
Field Meaning: Number of music loops.
Recommended Value: The value range is from 0 to any positive integer. The default value is 0. 0 means play the music once; 1 means play the music twice; and so on.
path
Field Meaning: Complete path or URL address of the sound effect file. Supported audio formats include MP3, AAC, M4A, WAV.
publish
Field Meaning: Whether to transmit music to remote end.
Recommended Value:
YES: The music can be played locally while the remote user can also hear it.
NO: The anchor can only hear the music locally, and the remote audience cannot hear it. Default value: NO.
startTimeMS
Field Meaning: Music start playback time point, in milliseconds.
The following is a simple example of starting/stopping playing background music:
iOS
Android
import RTCRoomEngine
import TXLiteAVSDK_Professional

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

// Start background music playback.
let musicParam = TXAudioMusicParam()
musicParam.id = 0 // Replace with your own Music ID
musicParam.path = "path" // Replace with the full path or URL address of the music file
musicParam.publish = true // Transmit music to remote end
musicParam.loopCount = 0 // Replace with the number of times you need to loop playback
audioEffectManager.startPlayMusic(musicParam) { code in
if code == 0 {
// Playback started successfully
} else {
// Playback start failed.
}
} onProgress: { progress, duration in
// Playback progress callback.
} onComplete: { _ in
// Playback end callback.
}

// Stop background music playback.
audioEffectManager.stopPlayMusic(musicId) // Replace with the Music ID you need to stop.

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

int id = 0; // Replace with your own Music ID
String path = "path"; // Replace with the full path or URL address of the music file.
// Start background music playback.
TXAudioEffectManager.AudioMusicParam musicParam = new TXAudioEffectManager.AudioMusicParam(id, path);
musicParam.publish = true; // Transmit music to remote end.
musicParam.loopCount = 0; // Replace with the number of times you need to loop playback.
audioEffectManager.startPlayMusic(musicParam);

// Stop background music playback.
audioEffectManager.stopPlayMusic(id); // Replace with the Music ID you need to stop.

Set Background Music Volume

You can set the background music volume by calling the setAllMusicVolume API and passing an Int value.
The passed-in Int value represents the volume, with a value range of 0 - 100. The following is an example of calling setAllMusicVolume to set the background music volume:
iOS
Android
import RTCRoomEngine
import TXLiteAVSDK_Professional

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

let volume = 60 // Replace with the volume you need to set
audioEffectManager.setAllMusicVolume(volume)
TXAudioEffectManager audioEffectManager = TUIRoomEngine.sharedInstance().getTRTCCloud().getAudioEffectManager();

int volume = 60; // Replace with the volume you need to set
audioEffectManager.setAllMusicVolume(volume);



ヘルプとサポート

この記事はお役に立ちましたか?

フィードバック