虚拟节拍器
configRhythmPlayer
配置虚拟节拍器。
- (int)configRhythmPlayer:(AgoraRhythmPlayerConfig * _Nullable)config;
调用 startRhythmPlayer
后,你可以调用该方法重新配置虚拟节拍器。
成功调用该方法后,SDK 会在本地触发 didRhythmPlayerStateChanged
回调,报告虚拟节拍器的状态。
注意:
-
开启虚拟节拍器后,SDK 会从头开始播放指定的音频文件,并根据你在
AgoraRhythmPlayerConfig
中设置的beatsPerMinute
控制每个文件的播放时长。例如,将beatsPerMinute
设为60
,则 SDK 会 1 秒播放 1 个节拍。如果文件时长超过了节拍时长,则 SDK 只播放节拍时长部分的音频。 -
虚拟节拍器的声音默认会发布至远端,如果你不希望远端用户听到虚拟节拍器的声音,你可以将
AgoraRtcChannelMediaOptions
中的publishRhythmPlayerTrack
设为NO
。
参数
参数名 | 描述 |
---|---|
config | 节拍器配置。详见 |
返回值
-
0: 方法调用成功。
-
< 0: 方法调用失败。详见
错误码
了解详情和解决建议。
startRhythmPlayer
开启虚拟节拍器。
- (int)startRhythmPlayer:(NSString * _Nonnull)sound1 sound2:(NSString * _Nonnull)sound2 config:(AgoraRhythmPlayerConfig * _Nullable)config;
在音乐教学、体育教学等场景中,老师通常需要使用节拍器,让学生跟着正确的节拍练习。节拍由强拍和弱拍组成,每小节的第一拍称为强拍,其余称为弱拍。
你需要在该方法中设置强拍和弱拍的文件路径、每小节的拍数、节拍速度以及是否将节拍器的声音发送至远端。
成功调用该方法后,SDK 会在本地触发 didRhythmPlayerStateChanged
回调,报告虚拟节拍器的状态。
注意:
-
开启虚拟节拍器后,SDK 会从头开始播放指定的音频文件,并根据你在
AgoraRhythmPlayerConfig
中设置的beatsPerMinute
控制每个文件的播放时长。例如,将beatsPerMinute
设为60
,则 SDK 会 1 秒播放 1 个节拍。如果文件时长超过了节拍时长,则 SDK 只播放节拍时长部分的音频。 -
虚拟节拍器的声音默认会发布至远端,如果你不希望远端用户听到虚拟节拍器的声音,你可以将
AgoraRtcChannelMediaOptions
中的publishRhythmPlayerTrack
设为NO
。
参数
参数名 | 描述 |
---|---|
sound1 | 强拍文件的绝对路径或 URL 地址,需精确到文件名及后缀。例如 |
sound2 | 弱拍文件的绝对路径或 URL 地址,需精确到文件名及后缀。例如 |
config | 节拍器配置。详见 |
返回值
-
0: 方法调用成功。
-
< 0: 方法调用失败
-
-22: 无法找到音频文件。请填写正确的
sound1
和sound2
。
-
stopRhythmPlayer
关闭虚拟节拍器。
- (int)stopRhythmPlayer;
调用 startRhythmPlayer
后,你可以调用该方法关闭虚拟节拍器。
返回值
-
0: 方法调用成功。
-
< 0: 方法调用失败。详见
错误码
了解详情和解决建议。
didRhythmPlayerStateChanged
虚拟节拍器状态发生改变回调。
- (void)rtcEngine:(AgoraRtcEngineKit * _Nonnull)engine didRhythmPlayerStateChanged:(AgoraRhythmPlayerState)state
errorCode:(AgoraRhythmPlayerError)errorCode NS_SWIFT_NAME(rtcEngine(_:didRhythmPlayerStateChanged:errorCode:));
虚拟节拍器状态发生改变时,SDK 会触发该回调报告当前的虚拟节拍器状态。在虚拟节拍器出现故障时,该回调可以帮助你了解当前虚拟节拍的状态以及出现故障的原因,方便你排查问题。
参数
参数名 | 描述 |
---|---|
state | 当前的虚拟节拍器状态,详见 |
errorCode | 虚拟节拍器发生错误的错误码和错误信息,详见 |