ByteRTCKTVPlayer class
- Inheritance
-
- Object
- NativeClass
- ByteRTCKTVPlayer
Methods
-
destroy()
→ void
-
inherited
-
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
-
pauseMusic(NSString musicId)
→ FutureOr<void>
-
@detail api
@author lihuan.wuti2ha
@brief 暂停播放歌曲。
@param musicId 音乐 ID。
@note
- 调用接口后，你会收到 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调歌曲播放状态。
- 若音乐 ID 错误，会触发 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调，errorCode 为 –3023，playState 为 4。
- 若未进房，会触发 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调，errorCode 为 –3022，playState 为 4。
-
playMusic(NSString musicId, ByteRTCAudioTrackType trackType, ByteRTCAudioPlayType playType)
→ FutureOr<void>
-
@detail api
@author lihuan.wuti2ha
@brief 播放歌曲。
@param musicId 音乐 ID。
若同一 musicId 的歌曲正在播放，再次调用接口会从开始位置重新播放。若 musicId 对应的音频文件不存在会触发报错。
@param trackType 原唱伴唱类型，参看 ByteRTCAudioTrackType{@link #ByteRTCAudioTrackType}。
@param playType 音乐播放类型。参看 ByteRTCAudioPlayType{@link #ByteRTCAudioPlayType}。
@note
- 调用接口后，你会收到 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调歌曲播放状态。
- 若音乐 ID 错误，会触发 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调，errorCode 为 –3023，playState 为 4。
- 若未进房，会触发 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调，errorCode 为 –3022，playState 为 4。
- 若音乐文件不存在，会触发 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调，errorCode 为 –3020，playState 为 4。
-
resumeMusic(NSString musicId)
→ FutureOr<void>
-
@detail api
@author lihuan.wuti2ha
@brief 继续播放歌曲。
@param musicId 音乐 ID。
@note
- 调用接口后，你会收到 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调歌曲播放状态。
- 若音乐 ID 错误，会触发 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调，errorCode 为 –3023，playState 为 4。
- 若未进房，会触发 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调，errorCode 为 –3022，playState 为 4。
-
seekMusic(NSString musicId, int position)
→ FutureOr<void>
-
@detail api
@author lihuan.wuti2ha
@brief 设置音乐文件的起始播放位置。
@param musicId 音乐 ID。
@param position 音乐起始位置，单位为毫秒，取值小于音乐文件总时长。
@note
- 调用本接口时音乐必须处于播放中状态。
- 调用接口后，你会收到 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调歌曲播放状态。
- 若音乐 ID 错误，会触发 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调，errorCode 为 –3023，playState 为 4。
- 若未进房，会触发 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调，errorCode 为 –3022，playState 为 4。
-
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
-
setMusicPitch(NSString musicId, int pitch)
→ FutureOr<void>
-
@detail api
@author lihuan.wuti2ha
@brief 对播放中的音乐设置升降调信息。
@param musicId 音乐 ID。
@param pitch 相对于音乐文件原始音调的升高/降低值，取值范围
-12，12，默认值为 0，即不做调整。
取值范围内每相邻两个值的音高距离相差半音，正值表示升调，负值表示降调，设置的绝对值越大表示音调升高或降低越多。
@note
- 调用本接口时音乐必须处于播放中状态。
- 若设置的 pitch 大于 12，则按最大值 12 进行调整；若设置的 pitch 小于 –12，，则按最小值 –12 进行调整。
- 若音乐 ID 错误，会触发 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调，errorCode 为 –3023，playState 为 4。
- 若未进房，会触发 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调，errorCode 为 –3022，playState 为 4。
-
setMusicVolume(NSString musicId, int volume)
→ FutureOr<void>
-
@detail api
@author lihuan.wuti2ha
@brief 设置歌曲播放音量，只能在开始播放后进行设置。
@param musicId 音乐 ID。
@param volume 歌曲播放音量，调节范围：
0,400。
- 0：静音。
- 100：原始音量。
- 400: 原始音量的 4 倍(自带溢出保护)。
@note
- 调用本接口时音乐必须处于播放中状态。
- 若设置的音量大于 400，则按最大值 400 进行调整；若设置的音量小于 0，则按最小值 0 进行调整。
- 若音乐 ID 错误，会触发 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调，errorCode 为 –3023，playState 为 4。
- 若未进房，会触发 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调，errorCode 为 –3022，playState 为 4。
-
stopMusic(NSString musicId)
→ FutureOr<void>
-
@detail api
@author lihuan.wuti2ha
@brief 停止播放歌曲。
@param musicId 音乐 ID。
@note
- 调用接口后，你会收到 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调歌曲播放状态。
- 若音乐 ID 错误，会触发 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调，errorCode 为 –3023，playState 为 4。
- 若未进房，会触发 ktvPlayer:onPlayStateChanged:state:error:{@link #ByteRTCKTVPlayerDelegate#ktvPlayer:onPlayStateChanged:state:error} 回调，errorCode 为 –3022，playState 为 4。
-
switchAudioTrackType(NSString musicId)
→ FutureOr<void>
-
@detail api
@author lihuan.wuti2ha
@brief 切换歌曲原唱伴唱。
@param musicId 音乐 ID。
@note 调用本接口时音乐必须处于播放中状态。
-
toString()
→ String
-
A string representation of this object.
inherited
-
updateResource(NativeResource resource)
→ void
-
inherited
