Class ZegoCopyrightedMusic

Available since: 3.11.0 Description: Cancel download of music resource. Use case: After starting to download music resources, use this interface to cancel the corresponding download task. When to call: After starting the download [download]. Caution: When a valid resourceID is passed in, only unfinished download tasks will be cancelled. When empty is passed in, all unfinished download tasks will be canceled.

Available since: 2.13.0 Description: When using this module, some cache files may be generated, which can be cleared through this interface. Use case: Used to clear the cache of the App. When to call: After initializing the copyrighted music [createCopyrightedMusic].

Available since: 2.13.0 Description: Download music resource. It can only be played after downloading successfully. Use case: After obtaining the music resource authorization, use this interface to download the corresponding resources. When to call: After initializing the copyrighted music success [initCopyrightedMusic]. Caution: Downloading copyrighted music resources is affected by the Internet.

Available since: 2.15.0 Description: Get the average score. Use case: Can be used to display the average score on the view. When to call: It can be called after playing the copyright accompaniment or accompaniment clip and starting to score.

Available since: 2.13.0 Description: When using this module, some cache files may be generated, and the size of the cache file can be obtained through this interface. Use case: Used to display the cache size of the App. When to call: After initializing the copyrighted music [createCopyrightedMusic].

Available since: 2.15.0 Description: Get real-time pitch data. Use case: Can be used to display real-time pitch lines on the view. When to call: It can be called after playing the copyright accompaniment or accompaniment clip and starting to score.

Available since: 2.13.0 Description: Get the playing time of a song or accompaniment file. Use case: Can be used to display the playing time information of the song or accompaniment on the view. When to call: After initializing the copyrighted music success [initCopyrightedMusic].

Available since: 3.0.2 Description: Get the full score. Use case: Can be used to display the full score on the view. When to call: It can be called after playing the copyright accompaniment or accompaniment clip and starting to score.

Available since: 2.13.0 Description: Get verbatim lyrics, support parsing lyrics word by word. Use case: Used to display lyrics word by word. When to call: After initializing the copyrighted music success [initCopyrightedMusic].

Available since: 3.12.0 Description: Get lyrics in lrc format, support parsing lyrics line by line. Use case: Used to display lyrics line by line. When to call: After initializing the copyrighted music success [initCopyrightedMusic].

Available since: 2.15.0 Description: Get the score of the previous sentence. Use case: Can be used to display the score of each sentence on the view. When to call: It can be called after playing the copyright accompaniment or accompaniment clip and starting to score.

Available since: 3.12.0 Description: In addition to obtaining the basic information of the song (duration, song name, singer, etc.), and the most important resource id that can be used for local playback, there are also some related authentications information. Use case: Get copyrighted songs for local playback. Related APIs: After a user in the room calls the [requestresource] interface to request a music resource successfully, other users in the room can call this interface to get the music resource for free once. When to call: After initializing the copyrighted music [initCopyrightedMusic]. Note: Each resource has a unique resource ID. The resources obtained by calling this API are time-sensitive, the valid duration is the minimum value between the SDK life cycle and 24-hour.

Available since: 2.15.0 Description: Get standard pitch data. Use case: Can be used to display standard pitch lines on the view. Caution: Only accompaniment or climactic clip assets have pitch lines.

Available since: 2.15.0 Description: Get the total score. Use case: Can be used to display the total score on the view. When to call: It can be called after playing the copyright accompaniment or accompaniment clip and starting to score.

Available since: 2.13.0 Description: Initialize the copyrighted music so that you can use the function of the copyrighted music later. When to call: After call [createCopyrightedMusic] and [loginRoom]. Caution: 1. The real user information must be passed in, otherwise the song resources cannot be obtained for playback. 2. The user ID set when initializing copyrighted music needs to be the same as the user ID set when logging in to the room.

Available since: 2.15.0 Description: Pause ongoing scoring,will stop the [OnCurrentPitchValueUpdate] callback. Use case: You can call this interface to pause the scoring function while scoring. When to call: It can be called while grading.

Available since: 3.12.0 Description: Query the resource is existed or not, query the Yinsuda resource cache by default Use case: Can be used to check the resource's cache is existed or not When to call: After initializing the copyrighted music success [initCopyrightedMusic].

Available since: 3.12.0 Description: In addition to obtaining the basic information of the song (duration, song name, singer, etc.), and the most important resource id that can be used for local playback, there are also some related authentications information. Use case: Get copyrighted songs for local playback and sharing. Related APIs: After a user in the room successfully calls this interface to request a music resource, other users in the room can call the [getsharedresource] interface to get the music resource for free once. When to call: After initializing the copyrighted music [initCopyrightedMusic]. Note:

1. Each resource has a unique resource ID.
2. Every time this API is called, it will be billed once, please consult ZEGO business personnel for details.
3. Each resource has a unique resource ID. The resources obtained by calling this API are time-sensitive, the valid duration is the minimum value between the SDK life cycle and 24-hour.

Available since: 2.15.0 Description: Reset the scores that have already been performed,The [OnCurrentPitchValueUpdate] callback will be stopped and the average or total score will be 0. Use case: Often used in scenes where the same song is re-sung. When to call: It can be called after scoring has been performed.

Available since: 2.15.0 Description: Resume currently paused scoring. Use case: When there is currently paused scoring, this interface can be called to resume the scoring function. When to call: It can be called when there is currently a paused scoring.

Available since: 2.13.0 Description: Initialize the copyrighted music so that you can use the function of the copyrighted music later. Use case: Used to get a list of songs. When to call: After initializing the copyrighted music success [initCopyrightedMusic].

Available since: 2.22.0 Description: Users can set the scoring difficulty level through this function. When to call: After calling [initCopyrightedMusic] to initialize copyrighted music successfully, call [startScore] to start scoring. Default value: When this function is not called, the difficulty level of scoring is 4. Restrictions: This function does not support dynamic settings. After calling this function successfully, the next call to [startScore] will take effect.

Available since: 2.15.0 Description: Start the scoring function.After starting scoring, the scoring result OnCurrentPitchValueUpdate callback will be received according to the set callback time interval. Use case: Can be used to display the singing score on the view. When to call: After obtaining verbatim lyrics and playing the accompaniment resources of copyrighted music. Restrictions: Only support use this api after [startPublishingStream].

Available since: 2.15.0 Description: End the current rating.The [OnCurrentPitchValueUpdate] callback will be stopped, but the average or total score can still be obtained normally. Use case: You can call this interface to end the scoring while scoring. When to call: It can be called while grading.