ByteRTCKTVManager class

Inheritance
  • Object
  • NativeClass
  • ByteRTCKTVManager

Constructors

ByteRTCKTVManager([NativeClassOptions? options])

Properties

$resource → NativeResource
no setterinherited
delegate FutureOr<ByteRTCKTVManagerDelegate?>
getter/setter pair
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

cancelDownload(int downloadId) FutureOr<void>
@detail api @author lihuan.wuti2ha @brief Cancels download task. @param downloadId Download task ID.
clearCache() FutureOr<void>
@detail api @author lihuan.wuti2ha @brief Clear music cache, including music and lyrics.
destroy() → void
inherited
downloadLyric(NSString musicId, ByteRTCDownloadLyricType lyricType) FutureOr<int>
@detail api @author lihuan.wuti2ha @brief Download lyrics. @param musicId Music ID. @param lyricType The lyrics file's format. See ByteRTCDownloadLyricType{@link #ByteRTCDownloadLyricType}. @return Download task ID. @note - If the lyrics are successfully downloaded, you will receive ktvManager:onDownloadSuccess:downloadResult:{@link #ByteRTCKTVManagerDelegate#ktvManager:onDownloadSuccess:downloadResult}. - If the lyrics fail to download, you will receive ktvManager:onDownloadFailed:errorCode:{@link #ByteRTCKTVManagerDelegate#ktvManager:onDownloadFailed:errorCode}.
downloadMidi(NSString musicId) FutureOr<int>
@detail api @author lihuan.wuti2ha @brief Download MIDI files. @param musicId Music ID. @return Download task ID. @note - If the file is successfully downloaded, you will receive ktvManager:onDownloadSuccess:downloadResult:{@link #ByteRTCKTVManagerDelegate#ktvManager:onDownloadSuccess:downloadResult}. - If the file fails to download, you will receive ktvManager:onDownloadFailed:errorCode:{@link #ByteRTCKTVManagerDelegate#ktvManager:onDownloadFailed:errorCode}.
downloadMusic(NSString musicId) FutureOr<int>
@detail api @author lihuan.wuti2ha @brief Download music. @param musicId Music ID. @return Download task ID. @note - If the music is successfully downloaded, you will receive ktvManager:onDownloadSuccess:downloadResult:{@link #ByteRTCKTVManagerDelegate#ktvManager:onDownloadSuccess:downloadResult}. - If the music fails to download, you will receive ktvManager:onDownloadFailed:errorCode:{@link #ByteRTCKTVManagerDelegate#ktvManager:onDownloadFailed:errorCode}. - When the music download progress is updated, you will receive ktvManager:onDownloadMusicProgress:progress:{@link #ByteRTCKTVManagerDelegate#ktvManager:onDownloadMusicProgress:progress}.
getHotMusic(NSArray<NSString> customHotlistId, ByteRTCMusicFilterType filterType) FutureOr<void>
@detail api @author lihuan.wuti2ha @brief Gets hot music according to music types. @param customHotlistId custom hot music list ID. @param filterType The filter type of the music list. See ByteRTCMusicFilterType{@link #ByteRTCMusicFilterType}. Multiple filters can be combined by the bitwise-or operator. @note After calling this API, you will receive the music list through ktvManager:onHotMusicResult:errorCode:{@link #ByteRTCKTVManagerDelegate#ktvManager:onHotMusicResult:errorCode} callback.
getKTVPlayer() FutureOr<ByteRTCKTVPlayer>
@detail api @author lihuan.wuti2ha @brief Gets the KTV player. @return KTV player interfaces. See ByteRTCKTVPlayer{@link #ByteRTCKTVPlayer}.
getMusicDetail(NSString musicId) FutureOr<void>
@detail api @author lihuan.wuti2ha @brief Gets music detail. @param musicId Music ID. @note After calling this API, you will receive the music detail through ktvManager:onMusicDetailResult:errorCode:{@link #ByteRTCKTVManagerDelegate#ktvManager:onMusicDetailResult:errorCode} callback.
getMusicList(int pageNumber, int pageSize, int filterType) FutureOr<void>
@detail api @author lihuan.wuti2ha @brief Gets the music list. @param pageNumber Page number. The default value is 1. @param pageSize The number of the music that displays on one page. @param filterType The filter type of the music list. See ByteRTCMusicFilterType{@link #ByteRTCMusicFilterType}. Multiple filters can be combined by the bitwise-or operator. @note After calling this API, you will receive the music list through ktvManager:onMusicListResult:totalSize:errorCode:{@link #ByteRTCKTVManagerDelegate#ktvManager:onMusicListResult:totalSize:errorCode} callback.
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
searchMusic(NSString keyWord, int pageNumber, int pageSize, int filterType) FutureOr<void>
@detail api @author lihuan.wuti2ha @brief Search music by keywords. @param keyWord Keyword. The string should be no more than 20 characters. @param pageNumber Page number. The default value is 1. @param pageSize The number of the music that displays on one page. @param filterType The filter type of the music list. See ByteRTCMusicFilterType{@link #ByteRTCMusicFilterType}. Multiple filters can be combined by the bitwise-or operator. @note After calling this API, you will receive the music list through ktvManager:onSearchMusicResult:totalSize:errorCode:{@link #ByteRTCKTVManagerDelegate#ktvManager:onSearchMusicResult:totalSize:errorCode} callback.
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
setMaxCacheSize(int maxCacheSizeMB) FutureOr<void>
@detail api @author lihuan.wuti2ha @brief Sets the maximum cache for storing music files. @param maxCacheSizeMB The maximum cache to be set in MB.
If the setting value is less than or equal to 0, it will be adjusted to 1,024 MB.
toString() String
A string representation of this object.
inherited
updateResource(NativeResource resource) → void
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Static Properties

codegen_$namespace → dynamic
no setter