ZegoCopyrightedMusic class abstract

Constructors

ZegoCopyrightedMusic()

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

cancelDownload(String resourceID) → Future<void>
Cancel download of music resource.
clearCache() → Future<void>
Clear cache.
download(String resourceID) → Future<ZegoCopyrightedMusicDownloadResult>
Download music resource.
getAverageScore(String resourceID) → Future<int>
Get average score.
getCacheSize() → Future<int>
Get cache size.
getCurrentPitch(String resourceID) → Future<int>
Get real-time pitch data.
getDuration(String resourceID) → Future<int>
Get the playing time of a song or accompaniment file.
getFullScore(String resourceID) → Future<int>
Get full score .
getKrcLyricByToken(String krcToken) → Future<ZegoCopyrightedMusicGetKrcLyricByTokenResult>
Get lyrics in krc format.
getLrcLyric(String songID, {ZegoCopyrightedMusicVendorID? vendorID}) → Future<ZegoCopyrightedMusicGetLrcLyricResult>
Get lyrics in lrc format.
getLrcLyricWithConfig(ZegoCopyrightedMusicGetLyricConfig config) → Future<ZegoCopyrightedMusicGetLrcLyricResult>
Get lyrics in lrc format.
getMusicByToken(String shareToken) → Future<ZegoCopyrightedMusicGetMusicByTokenResult>
Deprecated Get a song or accompaniment. Deprecated since 3.0.2, please use the getSharedResource function instead.
getPreviousScore(String resourceID) → Future<int>
Get the score of the previous sentence.
getSharedResource(ZegoCopyrightedMusicGetSharedConfig config, ZegoCopyrightedMusicResourceType type) → Future<ZegoCopyrightedMusicGetSharedResourceResult>
Get shared music resource.
getSharedResourceV2(ZegoCopyrightedMusicGetSharedConfigV2 config) → Future<ZegoCopyrightedMusicGetSharedResourceResult>
Get shared music resource.
getStandardPitch(String resourceID) → Future<ZegoCopyrightedMusicGetStandardPitchResult>
Get standard pitch data.
getTotalScore(String resourceID) → Future<int>
Get total score .
initCopyrightedMusic(ZegoCopyrightedMusicConfig config) → Future<ZegoCopyrightedMusicInitResult>
Initialize the copyrighted music module.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pauseScore(String resourceID) → Future<int>
Pause scoring.
queryCache(String songID, ZegoCopyrightedMusicType type, {ZegoCopyrightedMusicVendorID? vendorID}) → Future<bool>
Deprecated Query the resource's cache is existed or not. Deprecated since 3.9.0, please use the method with the same name with config parameter instead.
queryCacheWithConfig(ZegoCopyrightedMusicQueryCacheConfig config) → Future<bool>
Query the resource's cache is existed or not.
queryCacheWithConfigV2(ZegoCopyrightedMusicQueryCacheConfigV2 config) → Future<bool>
Query the resource's cache is existed or not.
requestAccompaniment(ZegoCopyrightedMusicRequestConfig config) → Future<ZegoCopyrightedMusicRequestAccompanimentResult>
Deprecated Request accompaniment. Deprecated since 3.0.2, please use the requestResource function instead.
requestAccompanimentClip(ZegoCopyrightedMusicRequestConfig config) → Future<ZegoCopyrightedMusicRequestAccompanimentClipResult>
Deprecated Request accompaniment clip. Deprecated since 3.0.2, please use the requestResource function instead.
requestResource(ZegoCopyrightedMusicRequestConfig config, ZegoCopyrightedMusicResourceType type) → Future<ZegoCopyrightedMusicRequestResourceResult>
Request music resource.
requestResourceV2(ZegoCopyrightedMusicRequestConfigV2 config) → Future<ZegoCopyrightedMusicRequestResourceResult>
Request music resource.
requestSong(ZegoCopyrightedMusicRequestConfig config) → Future<ZegoCopyrightedMusicRequestSongResult>
Deprecated Request a song. Deprecated since 3.0.2, please use the requestResource function instead.
resetScore(String resourceID) → Future<int>
Reset scoring.
resumeScore(String resourceID) → Future<int>
Resume scoring.
sendExtendedRequest(String command, String params) → Future<ZegoCopyrightedMusicSendExtendedRequestResult>
Send extended feature request.
setScoringLevel(int level) → Future<void>
Set the difficulty level of scoring.
startScore(String resourceID, int pitchValueInterval) → Future<int>
Start scoring.
stopScore(String resourceID) → Future<int>
Stop scoring.
toString() → String
A string representation of this object.
inherited

Operators

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