# 音乐文件播放 (/zh-CN/api-reference/rtc/unity/play/audio-mixing)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## AdjustAudioMixingPlayoutVolume [#adjustaudiomixingplayoutvolume]
调节音乐文件在本地播放的音量。
```csharp
public abstract int AdjustAudioMixingPlayoutVolume(int volume);
```
### 调用时机 [#调用时机]
你需要在调用 [StartAudioMixing [2/2]](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_startaudiomixing2) 并收到 `OnAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)` 回调后调用该方法。
### 参数 [#参数]
音乐文件音量。取值范围为 [0,100],100 (默认值)为原始音量。
### 返回值 [#返回值]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## AdjustAudioMixingPublishVolume [#adjustaudiomixingpublishvolume]
调节音乐文件远端播放音量。
```csharp
public abstract int AdjustAudioMixingPublishVolume(int volume);
```
该方法调节混音音乐文件在远端的播放音量大小。
### 调用时机 [#调用时机-1]
你需要在调用 [StartAudioMixing [2/2]](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_startaudiomixing2) 并收到 `OnAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)` 回调后调用该方法。
### 参数 [#参数-1]
音乐文件音量。取值范围为 [0,100],100 (默认值)为原始音量。
### 返回值 [#返回值-1]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-1]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## AdjustAudioMixingVolume [#adjustaudiomixingvolume]
调节音乐文件的播放音量。
```csharp
public abstract int AdjustAudioMixingVolume(int volume);
```
该方法调节混音音乐文件在本端和远端的播放音量大小。
:::note
注: 调用该方法不会影响 [PlayEffect](/zh-CN/api-reference/rtc/unity/play/audio-effect-file#api_irtcengine_playeffect3) 方法中设置的音效文件播放音量。
:::
### 调用时机 [#调用时机-2]
该方法需要在 [StartAudioMixing [2/2]](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_startaudiomixing2) 后调用。
### 参数 [#参数-2]
音乐文件音量范围为 0~100。100 (默认值)为原始文件音量。
### 返回值 [#返回值-2]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-2]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## GetAudioMixingCurrentPosition [#getaudiomixingcurrentposition]
获取音乐文件的播放进度。
```csharp
public abstract int GetAudioMixingCurrentPosition();
```
该方法获取当前音乐文件播放进度,单位为毫秒。
:::note
注:
- 你需要在调用 [StartAudioMixing [2/2]](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_startaudiomixing2) 并收到 `OnAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)` 回调后调用该方法。
- 如需多次调用 [GetAudioMixingCurrentPosition](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_getaudiomixingcurrentposition),请确保调用间隔大于 500 ms。
:::
### 返回值 [#返回值-3]
- ≥ 0: 方法调用成功,返回当前音乐文件播放进度(ms)。0 表示当前音乐文件未开始播放。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-3]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## GetAudioMixingDuration [#getaudiomixingduration]
获取音乐文件总时长。
```csharp
public abstract int GetAudioMixingDuration();
```
该方法获取音乐文件总时长,单位为毫秒。
### 调用时机 [#调用时机-3]
该方法需要在 [StartAudioMixing [2/2]](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_startaudiomixing2) 之后,并收到 `OnAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)` 回调后调用。
### 返回值 [#返回值-4]
- ≥ 0: 方法调用成功则返回音乐文件时长。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-4]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## GetAudioMixingPlayoutVolume [#getaudiomixingplayoutvolume]
获取音乐文件的本地播放音量。
```csharp
public abstract int GetAudioMixingPlayoutVolume();
```
你可以调用该方法获取混音的音乐文件的本地播放音量,方便排查音量相关问题。
### 调用时机 [#调用时机-4]
该方法需要在 [StartAudioMixing [2/2]](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_startaudiomixing2) 之后,并收到 `OnAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)` 回调后调用。
### 返回值 [#返回值-5]
- ≥ 0: 方法调用成功则返回音量值,范围为 [0,100]。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-5]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## GetAudioMixingPublishVolume [#getaudiomixingpublishvolume]
获取音乐文件的远端播放音量。
```csharp
public abstract int GetAudioMixingPublishVolume();
```
该接口可以方便开发者排查音量相关问题。
:::note
注: 你需要在调用 [StartAudioMixing [2/2]](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_startaudiomixing2) 并收到 `OnAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)` 回调后调用该方法。
:::
### 返回值 [#返回值-6]
- ≥ 0: 方法调用成功则返回音量值,范围为 [0,100]。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-6]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## GetAudioTrackCount [#getaudiotrackcount]
获取当前音乐文件的音轨索引。
```csharp
public abstract int GetAudioTrackCount();
```
:::note
注:
- 你需要在调用 [StartAudioMixing [2/2]](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_startaudiomixing2) 并收到`OnAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)` 回调后调用该方法。
:::
### 返回值 [#返回值-7]
- 方法调用成功时,返回当前音乐文件的音轨索引。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-7]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## PauseAudioMixing [#pauseaudiomixing]
暂停播放音乐文件。
```csharp
public abstract int PauseAudioMixing();
```
当你调用 [StartAudioMixing [2/2]](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_startaudiomixing2) 方法播放音乐文件后,如需暂停播放,请调用该方法。如果你需要停止播放,请调用 [StopAudioMixing](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_stopaudiomixing)。
### 调用时机 [#调用时机-5]
该方法需要在加入频道后调用。
### 返回值 [#返回值-8]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-8]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## ResumeAudioMixing [#resumeaudiomixing]
恢复播放音乐文件。
```csharp
public abstract int ResumeAudioMixing();
```
当你调用 [PauseAudioMixing](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_pauseaudiomixing) 暂停播放音乐文件后,如需恢复播放,请调用该方法。
### 调用时机 [#调用时机-6]
该方法需要在加入频道后调用。
### 返回值 [#返回值-9]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-9]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## SelectAudioTrack [1/2] [#selectaudiotrack-12]
指定当前音乐文件的播放音轨。
```csharp
public abstract int SelectAudioTrack(int index);
```
获取音乐文件的音轨数量后,你可以调用该方法指定任一音轨进行播放。例如,如果一个多音轨文件的不同音轨存放了不同语言的歌曲,则你可以调用该方法设置音乐文件的播放语言。
:::note
注:
- 该方法支持的音频文件格式见 [RTC SDK 支持播放哪些格式的音频文件?](/zh-CN/reference/faq/product/audio_format)。
- 你需要在调用 [StartAudioMixing [2/2]](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_startaudiomixing2) 并收到 `OnAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)` 回调后调用该方法。
:::
### 参数 [#参数-3]
指定的播放音轨。取值范围应大于等于 0 且小于 [GetAudioTrackCount](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_getaudiotrackcount) 的返回值。
### 返回值 [#返回值-10]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-10]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## SelectMultiAudioTrack [#selectmultiaudiotrack]
选择本地播放和发送至远端的音轨。
```csharp
public abstract int SelectMultiAudioTrack(int playoutTrackIndex, int publishTrackIndex);
```
你可以调用该方法分别设置本地播放和发送到远端的音轨。
在调用该方法前,你需要通过 [OpenWithMediaSource](/zh-CN/api-reference/rtc/unity/play/mediaplayer/mediaplayer-open#api_imediaplayer_openwithmediasource) 来打开媒体文件,并通过 [MediaSource](/zh-CN/api-reference/rtc/unity/class-mediasource) 将 `enableMultiAudioTrack` 设为 true。
### 适用场景 [#适用场景]
在 K 歌场景下,主播可以根据需求选择在本地播放一路音轨(如原声),然后发送另一路音轨至远端(如伴唱)以提升听众体验。
### 参数 [#参数-4]
用于本地播放的音轨索引。你可以通过 [GetStreamInfo](/zh-CN/api-reference/rtc/unity/play/mediaplayer/mediaplayer-info#api_imediaplayer_getstreaminfo) 来获取索引值。
用于发送至远端的音轨索引。你可以通过 [GetStreamInfo](/zh-CN/api-reference/rtc/unity/play/mediaplayer/mediaplayer-info#api_imediaplayer_getstreaminfo) 来获取索引值。
### 返回值 [#返回值-11]
- 0: 方法调用成功。
- < 0: 方法调用失败。
### 所属接口类 [#所属接口类-11]
- [IMediaPlayer](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_imediaplayer)
## SetAudioMixingDualMonoMode [#setaudiomixingdualmonomode]
设置当前音频文件的声道模式。
```csharp
public abstract int SetAudioMixingDualMonoMode(AUDIO_MIXING_DUAL_MONO_MODE mode);
```
在双声道音频文件中,左声道和右声道可以存储不同的音频数据。根据实际需要,你可以设置声道模式为原始模式、左声道模式、右声道模式或混合模式。
:::note
注: 该方法仅适用于双声道的音频文件。
:::
### 适用场景 [#适用场景-1]
在 KTV 场景中,音频文件的左声道存储了伴奏,右声道存储了原唱的歌声。你可以根据实际需求进行设置:
- 如果你只需听伴奏,则用该方法设置音频文件的声道模式为左声道模式。
- 如果你需要同时听伴奏和原唱,则调用该方法设置声道模式为混合模式。
### 调用时机 [#调用时机-7]
该方法需要在 [StartAudioMixing [2/2]](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_startaudiomixing2) 之后,并收到 `OnAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)` 回调后调用。
### 参数 [#参数-5]
声道模式。详见 [AUDIO_MIXING_DUAL_MONO_MODE](/zh-CN/api-reference/rtc/unity/enum-audiomixingdualmonomode)。
### 返回值 [#返回值-12]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-12]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## SetAudioMixingPitch [#setaudiomixingpitch]
调整本地播放的音乐文件的音调。
```csharp
public abstract int SetAudioMixingPitch(int pitch);
```
本地人声和播放的音乐文件混音时,调用该方法可以仅调节音乐文件的音调。
### 调用时机 [#调用时机-8]
你需要在调用 [StartAudioMixing [2/2]](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_startaudiomixing2) 并收到 `OnAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)` 回调后调用该方法。
### 参数 [#参数-6]
按半音音阶调整本地播放的音乐文件的音调,默认值为 0,即不调整音调。取值范围为 [-12,12],每相邻两个值的音高距离相差半音。取值的绝对值越大,音调升高或降低得越多。
### 返回值 [#返回值-13]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-13]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## SetAudioMixingPlaybackSpeed [#setaudiomixingplaybackspeed]
设置当前音乐文件的播放速度。
```csharp
public abstract int SetAudioMixingPlaybackSpeed(int speed);
```
你需要在调用 [StartAudioMixing [2/2]](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_startaudiomixing2) 并收到 [OnAudioMixingStateChanged](/zh-CN/api-reference/rtc/unity/play/audio-mixing#callback_irtcengineeventhandler_onaudiomixingstatechanged) 回调报告播放状态为 `AUDIO_MIXING_STATE_PLAYING` 后再调用该方法。
### 参数 [#参数-7]
音乐文件的播放速度。推荐取值范围为 [50,400],其中:
- 50: 0.5 倍速。
- 100: 原始速度。
- 400: 4 倍速。
### 返回值 [#返回值-14]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-14]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## SetAudioMixingPosition [#setaudiomixingposition]
设置音乐文件的播放位置。
```csharp
public abstract int SetAudioMixingPosition(int pos);
```
该方法可以设置音频文件的播放位置,这样你可以根据实际情况播放文件,而非从头到尾播放整个文件。
### 调用时机 [#调用时机-9]
该方法需要在 [StartAudioMixing [2/2]](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_startaudiomixing2) 之后,并收到 `OnAudioMixingStateChanged(AUDIO_MIXING_STATE_PLAYING)` 回调后调用。
### 参数 [#参数-8]
整数。进度条位置,单位为毫秒。
### 返回值 [#返回值-15]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-15]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## StartAudioMixing [1/2] [#startaudiomixing-12]
开始播放音乐文件。
```csharp
public abstract int StartAudioMixing(string filePath, bool loopback, int cycle);
```
该方法支持播放的音频文件格式见 [RTC SDK 支持播放哪些格式的音频文件](/zh-CN/reference/faq/product/audio_format)。如果本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL,则 SDK 会报告 AUDIO_MIXING_REASON_CAN_NOT_OPEN。
:::note
注:
- 使用该方法播放时长较短的音效文件可能会导致播放失败。如需播放音效文件,建议使用 [PlayEffect](/zh-CN/api-reference/rtc/unity/play/audio-effect-file#api_irtcengine_playeffect3)。
- 如需多次调用该方法,请确保调用间隔大于 500 ms。
- 在 Android 平台上调用该方法时,请注意如下事项:
- 请确保使用 Android 4.2 或以上设备,且 API Level 不低于 16。
- 如果播放的是在线音乐文件,建议不要使用重定向地址。重定向地址在某些机型上可能无法打开。
- 如果在模拟器上调用该方法,则请确保音乐文件在 `/sdcard/` 目录下,且格式为 MP3。
:::
### 调用时机 [#调用时机-10]
该方法在加入频道前后均可调用。
### 相关回调 [#相关回调]
调用该方法成功播放音乐文件后,本地会触发 [OnAudioMixingStateChanged](/zh-CN/api-reference/rtc/unity/play/audio-mixing#callback_irtcengineeventhandler_onaudiomixingstatechanged)(`AUDIO_MIXING_STATE_PLAYING`) 回调。播放结束后,本地会触发 [OnAudioMixingStateChanged](/zh-CN/api-reference/rtc/unity/play/audio-mixing#callback_irtcengineeventhandler_onaudiomixingstatechanged)(`AUDIO_MIXING_STATE_STOPPED`) 回调。
### 参数 [#参数-9]
播放文件的地址,支持在线文件的 URL 地址、播放文件的绝对路径,需精确到文件名及后缀。支持的音频格式包括 MP3、AAC、M4A、MP4、WAV、3GP 等。
:::note
注: 如果你已通过 [PreloadEffect](/zh-CN/api-reference/rtc/unity/play/audio-effect-file#api_irtcengine_preloadeffect) 将音效加载至内存,请确保该参数与 [PreloadEffect](/zh-CN/api-reference/rtc/unity/play/audio-effect-file#api_irtcengine_preloadeffect) 中设置的 `filePath` 相同。
:::
是否只在本地播放音乐文件:
- true:只在本地播放音乐文件,只有本地用户能听到音乐。
- false:将本地播放的音乐文件发布至远端,本地用户和远端用户都能听到音乐。
音乐文件的播放次数。
- > 0: 播放次数。例如,1 表示播放 1 次。
- -1: 无限循环播放。
### 返回值 [#返回值-16]
- 0: 方法调用成功。
- < 0: 方法调用失败:
- -1:一般性的错误(未明确归类)。
- -2:设置了无效的参数。
- -3:SDK 尚未准备好:
- 请检查是否已开启音频模块。
- 请检查程序集完整性。
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine) 初始化失败。请重新初始化 [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)。
### 所属接口类 [#所属接口类-16]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## StartAudioMixing [2/2] [#startaudiomixing-22]
开始播放音乐文件。
```csharp
public abstract int StartAudioMixing(string filePath, bool loopback, int cycle, int startPos);
```
该方法支持播放的音频文件格式见 [RTC SDK 支持播放哪些格式的音频文件](/zh-CN/reference/faq/product/audio_format)。如果本地音乐文件不存在、文件格式不支持或无法访问在线音乐文件 URL,则 SDK 会报告 AUDIO_MIXING_REASON_CAN_NOT_OPEN。
:::note
注:
- 使用该方法播放时长较短的音效文件可能会导致播放失败。如需播放音效文件,建议使用 [PlayEffect](/zh-CN/api-reference/rtc/unity/play/audio-effect-file#api_irtcengine_playeffect3)。
- 如需多次调用该方法,请确保调用间隔大于 500 ms。
- 在 Android 平台上调用该方法时,请注意如下事项:
- 请确保使用 Android 4.2 或以上设备,且 API Level 不低于 16。
- 如果播放的是在线音乐文件,建议不要使用重定向地址。重定向地址在某些机型上可能无法打开。
- 如果在模拟器上调用该方法,则请确保音乐文件在 `/sdcard/` 目录下,且格式为 MP3。
:::
### 调用时机 [#调用时机-11]
该方法在加入频道前后均可调用。
### 相关回调 [#相关回调-1]
调用该方法成功播放音乐文件后,本地会触发 [OnAudioMixingStateChanged](/zh-CN/api-reference/rtc/unity/play/audio-mixing#callback_irtcengineeventhandler_onaudiomixingstatechanged)(`AUDIO_MIXING_STATE_PLAYING`) 回调。播放结束后,本地会触发 [OnAudioMixingStateChanged](/zh-CN/api-reference/rtc/unity/play/audio-mixing#callback_irtcengineeventhandler_onaudiomixingstatechanged)(`AUDIO_MIXING_STATE_STOPPED`) 回调。
### 参数 [#参数-10]
文件路径:
- Android: 文件路径,需精确到文件名及后缀。支持在线文件的 URL 地址,本地文件的 URI 地址、绝对路径或以 `/assets/` 开头的路径。通过绝对路径访问本地文件可能会遇到权限问题,建议使用 URI 地址访问本地文件。例如 `content://com.android.providers.media.documents/document/audio%3A14441`。
- Windows: 音频文件的绝对路径或 URL 地址,需精确到文件名及后缀。例如 `C:\music\audio.mp4`。
- iOS 或 macOS: 音频文件的绝对路径或 URL 地址,需精确到文件名及后缀。例如 `/var/mobile/Containers/Data/audio.mp4`。
是否只在本地播放音乐文件:
- true:只在本地播放音乐文件,只有本地用户能听到音乐。
- false:将本地播放的音乐文件发布至远端,本地用户和远端用户都能听到音乐。
音乐文件的播放次数。
- > 0: 播放次数。例如,1 表示播放 1 次。
- -1: 无限循环播放。
音乐文件的播放位置,单位为毫秒。
### 返回值 [#返回值-17]
- 0: 方法调用成功。
- < 0: 方法调用失败:
- -1:一般性的错误(未明确归类)。
- -2:设置了无效的参数。
- -3:SDK 尚未准备好:
- 请检查是否已开启音频模块。
- 请检查程序集完整性。
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine) 初始化失败。请重新初始化 [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)。
### 所属接口类 [#所属接口类-17]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## StopAudioMixing [#stopaudiomixing]
停止播放音乐文件。
```csharp
public abstract int StopAudioMixing();
```
当你调用 [StartAudioMixing [2/2]](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_startaudiomixing2) 方法播放音乐文件后,如需停止播放,可调用该方法。如果仅需暂停播放,请调用 [PauseAudioMixing](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_pauseaudiomixing)。
### 调用时机 [#调用时机-12]
该方法需要在加入频道后调用。
### 返回值 [#返回值-18]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-18]
- [IRtcEngine](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengine)
## OnAudioMixingFinished [#onaudiomixingfinished]
本地音乐文件播放已结束回调。
```csharp
public virtual void OnAudioMixingFinished()
```
:::error[废弃]
弃用: 请改用 [OnAudioMixingStateChanged](/zh-CN/api-reference/rtc/unity/play/audio-mixing#callback_irtcengineeventhandler_onaudiomixingstatechanged)。
:::
当调用 [StartAudioMixing [2/2]](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_startaudiomixing2) 播放本地音乐文件结束后,会触发该回调。如果调用 [StartAudioMixing [2/2]](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_startaudiomixing2) 失败,会返回错误码 `WARN_AUDIO_MIXING_OPEN_ERROR`。
### 所属接口类 [#所属接口类-19]
- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineeventhandler)
## OnAudioMixingPositionChanged [#onaudiomixingpositionchanged]
音乐文件播放进度回调。
```csharp
public virtual void OnAudioMixingPositionChanged(long position) { }
```
当你调用 [StartAudioMixing [2/2]](/zh-CN/api-reference/rtc/unity/play/audio-mixing#api_irtcengine_startaudiomixing2) 方法播放音乐文件后,SDK 会每隔一秒触发一次该回调,报告音乐文件当前的播放进度。
### 参数 [#参数-11]
音乐文件当前的播放进度,单位为 ms。
### 返回值 [#返回值-19]
- 0: 方法调用成功。
- < 0: 方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-20]
- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineeventhandler)
## OnAudioMixingStateChanged [#onaudiomixingstatechanged]
音乐文件的播放状态已改变回调。
```csharp
public virtual void OnAudioMixingStateChanged(AUDIO_MIXING_STATE_TYPE state, AUDIO_MIXING_REASON_TYPE reason) {}
```
该回调在音乐文件播放状态发生改变时触发,并报告当前的播放状态和错误码。
### 参数 [#参数-12]
音乐文件播放状态。详见 [AUDIO_MIXING_STATE_TYPE](/zh-CN/api-reference/rtc/unity/enum-audiomixingstatetype)。
错误码。详见 [AUDIO_MIXING_REASON_TYPE](/zh-CN/api-reference/rtc/unity/enum-audiomixingreasontype)。
### 所属接口类 [#所属接口类-21]
- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/unity/rtc-interface-class#class_irtcengineeventhandler)