# 虚拟节拍器 (/zh-CN/api-reference/rtc/cpp-all-platforms/play/rhythmplayer)
> For AI agents: see the complete documentation index at [llms.txt](/llms.txt).
## configRhythmPlayer [#configrhythmplayer]
配置虚拟节拍器。
```cpp
virtual int configRhythmPlayer(const AgoraRhythmPlayerConfig& config) = 0;
```
:::error[废弃]
自 v4.6.0 版本废弃。
:::
调用 [startRhythmPlayer](/zh-CN/api-reference/rtc/cpp-all-platforms/play/rhythmplayer#api_irtcengine_startrhythmplayer) 后,你可以调用该方法重新配置虚拟节拍器。启用虚拟节拍器后,SDK 会从头开始播放指定的音效文件,并根据你在 [AgoraRhythmPlayerConfig](/zh-CN/api-reference/rtc/cpp-all-platforms/class-agorarhythmplayerconfig) 中设置的 `beatsPerMinute` 控制每个文件的播放时长。例如,如果将 `beatsPerMinute` 设置为 60,SDK 每秒播放一个节拍。如果文件时长超过节拍时长,SDK 只播放节拍时长内的音频。默认情况下,虚拟节拍器的声音会在频道中发布。如果希望远端用户也能听到该声音,可以在 [ChannelMediaOptions](/zh-CN/api-reference/rtc/cpp-all-platforms/class-channelmediaoptions) 中将 `publishRhythmPlayerTrack` 设置为 true。
### 调用时机 [#调用时机]
该方法可以在加入频道前或后调用。
### 相关回调 [#相关回调]
成功调用该方法后,SDK 会在本地触发 [onRhythmPlayerStateChanged](/zh-CN/api-reference/rtc/cpp-all-platforms/play/rhythmplayer#callback_irtcengineeventhandler_onrhythmplayerstatechanged) 回调报告虚拟节拍器的状态。
### 参数 [#参数]
节拍器配置。详见 [AgoraRhythmPlayerConfig](/zh-CN/api-reference/rtc/cpp-all-platforms/class-agorarhythmplayerconfig)。
### 返回值 [#返回值]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类]
- [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine)
## startRhythmPlayer [#startrhythmplayer]
启用虚拟节拍器。
```cpp
virtual int startRhythmPlayer(const char* sound1, const char* sound2, const AgoraRhythmPlayerConfig& config) = 0;
```
:::error[废弃]
自 v4.6.0 版本废弃。
:::
启用虚拟节拍器后,SDK 会从头开始播放指定的音效文件,并根据你在 [AgoraRhythmPlayerConfig](/zh-CN/api-reference/rtc/cpp-all-platforms/class-agorarhythmplayerconfig) 中设置的 `beatsPerMinute` 控制每个文件的播放时长。例如,如果你将 `beatsPerMinute` 设置为 60,SDK 每秒播放一个节拍。如果文件时长超过节拍时长,SDK 只播放节拍时长内的音频内容。
默认情况下,虚拟节拍器的声音会在频道中发布。如果你希望远端用户也能听到该声音,可以在 [ChannelMediaOptions](/zh-CN/api-reference/rtc/cpp-all-platforms/class-channelmediaoptions) 中将 `publishRhythmPlayerTrack` 设置为 true。
### 适用场景 [#适用场景]
在音乐教育、体育教学等场景中,教师通常需要使用节拍器帮助学生按照正确的节奏进行练习。节拍由强拍和弱拍组成,每小节的第一个节拍称为强拍,其余为弱拍。
### 调用时机 [#调用时机-1]
该方法可以在加入频道前或加入频道后调用。
### 相关回调 [#相关回调-1]
成功调用该方法后,SDK 会触发 [onRhythmPlayerStateChanged](/zh-CN/api-reference/rtc/cpp-all-platforms/play/rhythmplayer#callback_irtcengineeventhandler_onrhythmplayerstatechanged) 回调报告虚拟节拍器的状态。
### 参数 [#参数-1]
强拍音效文件的绝对路径或 URL 地址(包括文件扩展名)。例如,C:\\music\\audio.mp4。支持的音频文件格式详见 SDK 支持的格式。
弱拍音效文件的绝对路径或 URL 地址(包括文件扩展名)。例如,C:\\music\\audio.mp4。支持的音频文件格式详见 SDK 支持的格式。
节拍器配置,详见 [AgoraRhythmPlayerConfig](/zh-CN/api-reference/rtc/cpp-all-platforms/class-agorarhythmplayerconfig)。
### 返回值 [#返回值-1]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
- -22:未找到音效文件。请为 `sound1` 和 `sound2` 设置正确的路径。
### 所属接口类 [#所属接口类-1]
- [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine)
## stopRhythmPlayer [#stoprhythmplayer]
禁用虚拟节拍器。
```cpp
virtual int stopRhythmPlayer() = 0;
```
:::error[废弃]
自 v4.6.0 版本废弃。
:::
调用 [startRhythmPlayer](/zh-CN/api-reference/rtc/cpp-all-platforms/play/rhythmplayer#api_irtcengine_startrhythmplayer) 后,可以调用该方法禁用虚拟节拍器。
:::note
注: 该方法仅适用于 Android 和 iOS 平台。
:::
### 返回值 [#返回值-2]
- 0:方法调用成功。
- < 0:方法调用失败。详见[错误码](/zh-CN/api-reference/rtc/error-code)了解详情和解决建议。
### 所属接口类 [#所属接口类-2]
- [IRtcEngine](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengine)
## onRhythmPlayerStateChanged [#onrhythmplayerstatechanged]
虚拟节拍器状态发生变化时的回调。
```cpp
virtual void onRhythmPlayerStateChanged(RHYTHM_PLAYER_STATE_TYPE state, RHYTHM_PLAYER_REASON reason)
```
:::error[废弃]
自 v4.6.0 版本废弃。
:::
该回调用于报告虚拟节拍器的当前状态,指示本地音频流的状态,帮助你在音频异常时排查问题。
:::note
注: 该回调仅适用于 Android 和 iOS 平台。
:::
### 触发时机 [#触发时机]
当虚拟节拍器状态发生变化时触发。
### 参数 [#参数-2]
虚拟节拍器的当前状态,详见 [RHYTHM_PLAYER_STATE_TYPE](/zh-CN/api-reference/rtc/cpp-all-platforms/enum-rhythmplayerstatetype)。
与虚拟节拍器错误相关的错误码和错误信息,详见 [RHYTHM_PLAYER_REASON](/zh-CN/api-reference/rtc/cpp-all-platforms/enum-rhythmplayerreason)。
### 所属接口类 [#所属接口类-3]
- [IRtcEngineEventHandler](/zh-CN/api-reference/rtc/cpp-all-platforms/rtc-interface-class#class_irtcengineeventhandler)