getLyric

Retrieves the download link for the lyrics of a music resource.

virtual int getLyric(agora::util::AString& requestId, int64_t songCode, int32_t lyricType = 0) = 0;

Related Callbacks

After calling this method, the SDK triggers the onLyricResult callback to report the lyrics download link.

Parameters

requestId
Request ID used to uniquely identify the request.
songCode
ID of the music resource, used to identify the music.
lyricType
Lyric type:
  • 0: XML format.
  • 1: LRC format.

Return Values

  • 0: Success.
  • < 0: Failure.