# 音乐文件播放 (/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## adjustAudioMixingPlayoutVolume [#adjustaudiomixingplayoutvolume]
调节音乐文件在本地播放的音量。
```ts
public abstract adjustAudioMixingPlayoutVolume(volume: number): number;
```
### 调用时机 [#调用时机]
你需要在调用 [startAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_startaudiomixing2) 并收到 onAudioMixingStateChanged`(PLAYING)` 回调后调用该方法。
### 调用限制 [#调用限制]
无。
### 参数 [#参数]
音乐文件音量。取值范围为 [0,100],100 (默认值)为原始音量。
### 返回值 [#返回值]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类]
- [RtcEngine](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengine)
## adjustAudioMixingPublishVolume [#adjustaudiomixingpublishvolume]
调节音乐文件远端播放音量。
```ts
public abstract adjustAudioMixingPublishVolume(volume: number): number;
```
该方法调节混音音乐文件在远端的播放音量大小。
### 调用时机 [#调用时机-1]
你需要在调用 [startAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_startaudiomixing2) 并收到 onAudioMixingStateChanged`(PLAYING)` 回调后调用该方法。
### 调用限制 [#调用限制-1]
无。
### 参数 [#参数-1]
音乐文件音量。取值范围为 [0,100],100 (默认值)为原始音量。
### 返回值 [#返回值-1]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-1]
- [RtcEngine](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengine)
## adjustAudioMixingVolume [#adjustaudiomixingvolume]
调节音乐文件的播放音量。
```ts
public abstract adjustAudioMixingVolume(volume: number): number;
```
该方法调节混音音乐文件在本端和远端的播放音量大小。
:::note
注: 调用该方法不会影响 [playEffect](/zh-CN/api-reference/rtc/harmonyos/play/audio-effect-file#api_irtcengine_playeffect3) 方法中设置的音效文件播放音量。
:::
### 调用时机 [#调用时机-2]
该方法需要在 [startAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_startaudiomixing2) 后调用。
### 调用限制 [#调用限制-2]
无。
### 参数 [#参数-2]
音乐文件音量范围为 0~100。100 (默认值)为原始文件音量。
### 返回值 [#返回值-2]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-2]
- [RtcEngine](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengine)
## adjustPlaybackSignalVolume [#adjustplaybacksignalvolume]
调节本地播放的所有远端用户信号音量。
```ts
public abstract adjustPlaybackSignalVolume(volume: number): number;
```
该方法用于调节所有远端用户混音后在本地播放的信号音量,如果你需要调节指定远端用户在本地播放的信号音量,建议你调用 [adjustUserPlaybackSignalVolume](/zh-CN/api-reference/rtc/harmonyos/audio/audio-basic#api_irtcengine_adjustuserplaybacksignalvolume)。
### 调用时机 [#调用时机-3]
加入频道前后均可调用。
### 调用限制 [#调用限制-3]
无。
### 参数 [#参数-3]
音量,取值范围为 [0,400]。
- 0: 静音。
- 100: (默认)原始音量。
- 400: 原始音量的 4 倍,自带溢出保护。
### 返回值 [#返回值-3]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-3]
- [RtcEngine](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengine)
## getAudioMixingCurrentPosition [#getaudiomixingcurrentposition]
获取音乐文件的播放进度。
```ts
public abstract getAudioMixingCurrentPosition(): number;
```
### 详情 [#详情]
该方法获取当前音乐文件播放进度,单位为毫秒。
:::caution
注意:
- 你需要在调用 [startAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_startaudiomixing2) 并收到 onAudioMixingStateChanged`(PLAYING)` 回调后调用该方法。
- 如需多次调用 getAudioMixingCurrentPosition,请确保调用间隔大于 500 ms。
:::
### 返回值 [#返回值-4]
- ≥ 0: 方法调用成功,返回当前音乐文件播放进度(ms)。0 表示当前音乐文件未开始播放。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-4]
- [RtcEngine](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengine)
## getAudioMixingDuration [#getaudiomixingduration]
获取音乐文件总时长。
```ts
public abstract getAudioMixingDuration():number;
```
该方法获取音乐文件总时长,单位为毫秒。
### 调用时机 [#调用时机-4]
该方法需要在 [startAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_startaudiomixing2) 之后,并收到 [onAudioMixingStateChanged](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#callback_irtcengineeventhandler_onaudiomixingstatechanged)`(PLAYING)` 回调后调用。
### 调用限制 [#调用限制-4]
无。
### 返回值 [#返回值-5]
- ≥ 0: 方法调用成功则返回音乐文件时长。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-5]
- [RtcEngine](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengine)
## getAudioMixingPlayoutVolume [#getaudiomixingplayoutvolume]
获取音乐文件的本地播放音量。
```ts
public abstract getAudioMixingPlayoutVolume():number;
```
你可以调用该方法获取混音的音乐文件的本地播放音量,方便排查音量相关问题。
### 调用时机 [#调用时机-5]
该方法需要在 [startAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_startaudiomixing2) 之后,并收到 [onAudioMixingStateChanged](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#callback_irtcengineeventhandler_onaudiomixingstatechanged)`(PLAYING)` 回调后调用。
### 调用限制 [#调用限制-5]
无。
### 返回值 [#返回值-6]
- ≥ 0: 方法调用成功则返回音量值,范围为 [0,100]。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-6]
- [RtcEngine](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengine)
## getAudioMixingPublishVolume [#getaudiomixingpublishvolume]
获取音乐文件的远端播放音量。
```ts
public abstract getAudioMixingPublishVolume():number;
```
### 详情 [#详情-1]
该接口可以方便开发者排查音量相关问题。
:::caution
注意: 你需要在调用 [startAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_startaudiomixing2) 并收到 onAudioMixingStateChanged`(PLAYING)` 回调后调用该方法。
:::
### 返回值 [#返回值-7]
- ≥ 0: 方法调用成功则返回音量值,范围为 [0,100]。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-7]
- [RtcEngine](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengine)
## pauseAudioMixing [#pauseaudiomixing]
暂停播放音乐文件。
```ts
public abstract pauseAudioMixing(): number;
```
当你调用 [startAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_startaudiomixing2) 方法播放音乐文件后,如需暂停播放,请调用该方法。如果你需要停止播放,请调用 [stopAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_stopaudiomixing)。
### 调用时机 [#调用时机-6]
该方法需要在加入频道后调用。
### 调用限制 [#调用限制-6]
无。
### 返回值 [#返回值-8]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-8]
- [RtcEngine](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengine)
## resumeAudioMixing [#resumeaudiomixing]
恢复播放音乐文件。
```ts
public abstract resumeAudioMixing(): number;
```
当你调用 [pauseAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_pauseaudiomixing) 暂停播放音乐文件后,如需恢复播放,请调用该方法。
### 调用时机 [#调用时机-7]
该方法需要在加入频道后调用。
### 调用限制 [#调用限制-7]
无。
### 返回值 [#返回值-9]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-9]
- [RtcEngine](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengine)
## selectMultiAudioTrack [#selectmultiaudiotrack]
选择本地播放和发送至远端的音轨。
```ts
public abstract selectMultiAudioTrack(playoutTrackIndex:number, publishTrackIndex: number): number;
```
### 详情 [#详情-2]
你可以调用该方法分别设置本地播放和发送到远端的音轨。
在调用该方法前,你需要通过 [openWithMediaSource](/zh-CN/api-reference/rtc/harmonyos/play/mediaplayer/mediaplayer-open#api_imediaplayer_openwithmediasource) 来打开媒体文件,并通过 [MediaPlayerSource](/zh-CN/api-reference/rtc/harmonyos/class-mediasource) 将 enableMultiAudioTrack 设为 `true`。
### 适用场景 [#适用场景]
在 K 歌场景下,主播可以根据需求选择在本地播放一路音轨(如原声),然后发送另一路音轨至远端(如伴唱)以提升听众体验。
### 参数 [#参数-4]
用于本地播放的音轨索引。你可以通过 [getStreamInfo](/zh-CN/api-reference/rtc/harmonyos/play/mediaplayer/mediaplayer-info#api_imediaplayer_getstreaminfo) 来获取索引值。
用于发送至远端的音轨索引。你可以通过 [getStreamInfo](/zh-CN/api-reference/rtc/harmonyos/play/mediaplayer/mediaplayer-info#api_imediaplayer_getstreaminfo) 来获取索引值。
### 返回值 [#返回值-10]
- 0: 方法调用成功。
- < 0: 方法调用失败。
### 所属接口类 [#所属接口类-10]
- [IMediaPlayer](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_imediaplayer)
## setAudioMixingPlaybackSpeed [#setaudiomixingplaybackspeed]
设置当前音乐文件的播放速度。
```ts
public abstract setAudioMixingPlaybackSpeed(speed: number): number
```
### 详情 [#详情-3]
你需要在调用 [startAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_startaudiomixing2) 并收到 [onAudioMixingStateChanged](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#callback_irtcengineeventhandler_onaudiomixingstatechanged) 回调报告播放状态为 PLAYING 后再调用该方法。
### 参数 [#参数-5]
音乐文件的播放速度。推荐取值范围为 [50,400],其中:
- 50: 0.5 倍速。
- 100: 原始速度。
- 400: 4 倍速。
### 返回值 [#返回值-11]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-11]
- [RtcEngine](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengine)
## setAudioMixingPosition [#setaudiomixingposition]
设置音乐文件的播放位置。
```ts
public abstract setAudioMixingPosition(pos: number): number;
```
该方法可以设置音频文件的播放位置,这样你可以根据实际情况播放文件,而非从头到尾播放整个文件。
### 调用时机 [#调用时机-8]
该方法需要在 [startAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_startaudiomixing2) 之后,并收到 [onAudioMixingStateChanged](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#callback_irtcengineeventhandler_onaudiomixingstatechanged)`(PLAYING)` 回调后调用。
### 调用限制 [#调用限制-8]
无。
### 参数 [#参数-6]
整数。进度条位置,单位为毫秒。
### 返回值 [#返回值-12]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-12]
- [RtcEngine](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengine)
## startAudioMixing [#startaudiomixing]
开始播放音乐文件。
```ts
public abstract startAudioMixing(filepath: string, loopback: boolean, cycle: number, startpos?:number): number;
```
该方法支持播放以 `content://` 开头的 URI 文件。支持的音频格式详见 [RTC SDK 支持播放哪些格式的音频文件](/zh-CN/reference/faq/product/audio_format)。如果本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL,则 SDK 会报告 CAN_NOT_OPEN。
### 调用时机 [#调用时机-9]
该方法在加入频道前后均可调用。
### 调用限制 [#调用限制-9]
- 使用该方法播放时长较短的音效文件可能会导致播放失败。如需播放音效文件,建议使用 [playEffect](/zh-CN/api-reference/rtc/harmonyos/play/audio-effect-file#api_irtcengine_playeffect3)。
- 如需多次调用该方法,请确保调用间隔大于 500 ms。
### 相关回调 [#相关回调]
调用该方法成功播放音乐文件后,本地会触发 [onAudioMixingStateChanged](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#callback_irtcengineeventhandler_onaudiomixingstatechanged)(`PLAYING`) 回调。播放结束后,本地会触发 onAudioMixingStateChanged(`STOPPED`) 回调。
### 参数 [#参数-7]
文件路径:
是否只在本地播放音乐文件:
- `true`:只在本地播放音乐文件,只有本地用户能听到音乐。
- `false`:将本地播放的音乐文件发布至远端,本地用户和远端用户都能听到音乐。
音乐文件的播放次数。
- >0: 播放次数。例如,1 表示播放 1 次。
- -1: 无限循环播放。
音乐文件的播放位置,单位为毫秒。
### 返回值 [#返回值-13]
- 0: 方法调用成功。
- < 0: 方法调用失败:
- -1:一般性的错误(未明确归类)。
- -2:设置了无效的参数。
- -3:SDK 尚未准备好:
- 请检查是否已开启音频模块。
- 请检查程序集完整性。
- [RtcEngine](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengine) 初始化失败。请重新初始化 RtcEngine。
### 所属接口类 [#所属接口类-13]
- [RtcEngine](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengine)
## stopAudioMixing [#stopaudiomixing]
停止播放音乐文件。
```ts
public abstract stopAudioMixing(): number;
```
当你调用 [startAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_startaudiomixing2) 方法播放音乐文件后,如需停止播放,可调用该方法。如果仅需暂停播放,请调用 [pauseAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_pauseaudiomixing)。
### 调用时机 [#调用时机-10]
该方法需要在加入频道后调用。
### 调用限制 [#调用限制-10]
无。
### 返回值 [#返回值-14]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-14]
- [RtcEngine](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengine)
## onAudioMixingPositionChanged [#onaudiomixingpositionchanged]
音乐文件播放进度回调。
```ts
onAudioMixingPositionChanged?:(position:bigint) => void
```
### 详情 [#详情-4]
当你调用 [startAudioMixing](/zh-CN/api-reference/rtc/harmonyos/play/audio-mixing#api_irtcengine_startaudiomixing2) 方法播放音乐文件后,SDK 会每隔一秒触发一次该回调,报告音乐文件当前的播放进度。
### 参数 [#参数-8]
音乐文件当前的播放进度,单位为 ms。
### 返回值 [#返回值-15]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-15]
- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengineeventhandler)
## onAudioMixingStateChanged [#onaudiomixingstatechanged]
音乐文件的播放状态已改变回调。
```ts
onAudioMixingStateChanged?:(state:Constants.AudioMixingState,reason:Constants.AudioMixingReason) => void
```
### 详情 [#详情-5]
该回调在音乐文件播放状态发生改变时触发,并报告当前的播放状态和错误码。
### 参数 [#参数-9]
音乐文件播放状态。详见 [AudioMixingState](/zh-CN/api-reference/rtc/harmonyos/enum-audiomixingstatetype)。
错误码。详见 [AudioMixingReason](/zh-CN/api-reference/rtc/harmonyos/enum-audiomixingreasontype)。
### 所属接口类 [#所属接口类-16]
- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/harmonyos/rtc-interface-class#class_irtcengineeventhandler)