ByteRTCSingScoringManager class
- Inheritance
-
- Object
- NativeClass
- ByteRTCSingScoringManager
Properties
-
$resource
→ NativeResource
-
no setterinherited
-
hashCode
→ int
-
The hash code for this object.
no setterinherited
-
ready
→ Future<void>
-
Whether the instance is initialized
no setterinherited
-
runtimeType
→ Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
destroy()
→ void
-
inherited
-
getAverageScore()
→ FutureOr<int>
-
@detail api
@author wangjunzheng
@brief 获取当前演唱歌曲的平均分。
@return
- <0：获取平均分失败。
- >=0：当前演唱平均分。
-
getLastSentenceScore()
→ FutureOr<int>
-
@detail api
@author wangjunzheng
@brief 获取上一句的演唱评分。调用 startSingScoring:scoringInfoInterval:{@link #ByteRTCSingScoringManager#startSingScoring:scoringInfoInterval} 开始评分后可以调用该接口。
@return
- <0：获取评分失败。
- >=0：上一句歌词的演唱评分。
-
getStandardPitchInfo(NSString midiFilepath)
→ FutureOr<ByteRTCStandardPitchInfo>
-
@detail api
@author wangjunzheng
@brief 获取标准音高数据。
@param midiFilepath 歌曲 midi 文件路径。
@return ByteRTCStandardPitchInfo{@link #ByteRTCStandardPitchInfo} 标准音高数据数组。
@note
- 请保证此接口传入的 midi 文件路径与 setSingScoringConfig:{@link #ByteRTCSingScoringManager#setSingScoringConfig} 接口中传入的路径一致。
-
getTotalScore()
→ FutureOr<int>
-
@detail api
@author wangjunzheng
@brief 获取当前演唱总分。调用 startSingScoring:scoringInfoInterval:{@link #ByteRTCSingScoringManager#startSingScoring:scoringInfoInterval} 开始评分后可以调用该接口。
@return
- <0：获取总分失败。
- >=0：当前演唱总分。
-
initSingScoring(NSString singScoringAppkey, NSString singScoringToken, id<ByteRTCSingScoringDelegate> delegate)
→ FutureOr<int>
-
@detail api
@author wangjunzheng
@brief 初始化 K 歌评分。
@param singScoringAppkey K 歌评分密钥，用于鉴权验证 K 歌功能是否开通。
@param singScoringToken K 歌评分密钥，用于鉴权验证 K 歌功能是否开通。
@param delegate K 歌评分事件回调类，详见 ByteRTCSingScoringDelegate{@link #ByteRTCSingScoringDelegate}。
@return
- 0：配置成功。
- -1：接口调用失败。
- -2：未集成 K 歌评分模块。
- >0：其他错误，具体参看错误码表。
@note 输入正确的鉴权信息才可以使用 K 歌评分相关的功能，鉴权方式为离线鉴权，根据包名（bundleID）绑定 Appkey 及 Token，K 歌评分密钥请联系技术支持人员申请。
-
nativeCall<T>(String method, [List? args, NativeMethodMeta? meta])
→ Future<T>
-
Call instance method
inherited
-
noSuchMethod(Invocation invocation)
→ dynamic
-
Invoked when a nonexistent method or property is accessed.
inherited
-
sendInstanceGet<T>(String property)
→ Future<T>
-
Get instance property
inherited
-
sendInstancePropertiesGet(dynamic nativeClass)
→ Future<Map<String, dynamic>>
-
Get instance properties
inherited
-
sendInstanceSet(String property, dynamic value)
→ Future<void>
-
Set instance property
inherited
-
setSingScoringConfig(ByteRTCSingScoringConfig config)
→ FutureOr<int>
-
@detail api
@author wangjunzheng
@brief 设置 K 歌评分参数。
@param config K 歌评分的各项参数，详见 ByteRTCSingScoringConfig{@link #ByteRTCSingScoringConfig}。
@return
- 0：配置成功。
- -1：接口调用失败。
- -2：未集成 K 歌评分模块。
- >0：其他错误，具体参看错误码表。
-
startSingScoring(int position, int scoringInfoInterval)
→ FutureOr<int>
-
@detail api
@author wangjunzheng
@brief 开始 K 歌评分。
@param position 开始评分时，音乐的播放进度，单位：ms。
@param scoringInfoInterval 实时回调的时间间隔，单位：ms；默认 50 ms。最低间隔为 20 ms。
@return
- 0：配置成功。
- -1：接口调用失败。
- -2：未集成 K 歌评分模块。
- >0：其他错误，具体参看错误码表。
@note
- 在调用 initSingScoring:singScoringToken:delegate:{@link #ByteRTCSingScoringManager#initSingScoring:singScoringToken:delegate} 初始化 K 歌评分功能后调用该接口。
- 调用该接口后，将会根据设置的回调时间间隔，收到评分结果 onCurrentScoringInfo:{@link #ByteRTCSingScoringDelegate#onCurrentScoringInfo} 回调。
- 如果调用 startAudioMixing:filePath:config: 接口播放音频文件，请在收到 rtcEngine:onAudioMixingStateChanged:state:error:(ByteRTCAudioMixingStatePlaying) 之后调用此接口。
-
stopSingScoring()
→ FutureOr<int>
-
@detail api
@author wangjunzheng
@brief 停止 K 歌评分。
@return
- 0：成功。
- <0：失败。
-
toString()
→ String
-
A string representation of this object.
inherited
-
updateResource(NativeResource resource)
→ void
-
inherited
