|
Agora RTC Objective-C API Reference
Refactor
|
Inherits <NSObjectNSObject>.
Instance Methods | |
| (void) | - onMusicChartsResult:result:reason: |
| (void) | - onMusicCollectionResult:result:reason: |
| (void) | - onLyricResult:songCode:lyricUrl:reason: |
| (void) | - onSongSimpleInfoResult:songCode:simpleInfo:reason: |
| (void) | - onPreLoadEvent:songCode:percent:lyricUrl:state:reason: |
The request event delegate callback
| - (void) onMusicChartsResult: | (NSString *) | requestId | |
| result: | (NSArray< AgoraMusicChartInfo * > *) | result | |
| reason: | (AgoraMusicContentCenterStateReason) | reason | |
The music chart result callback; occurs when getMusicCharts method is called.
| requestId | The request id is same as that returned by getMusicCharts. |
| result | The result of music chart collection |
| reason | The status of the request. See MusicContentCenterStateReason |
| - (void) onMusicCollectionResult: | (NSString *) | requestId | |
| result: | (AgoraMusicCollection *) | result | |
| reason: | (AgoraMusicContentCenterStateReason) | reason | |
Music collection, occurs when getMusicCollectionByMusicChartId or searchMusic method is called.
| requestId | The request id is the same with that returned by getMusicCollectionByMusicChartId or searchMusic |
| result | The result of music collection |
| reason | The status of the request. See MusicContentCenterStateReason |
| - (void) onLyricResult: | (NSString *) | requestId | |
| songCode: | (NSInteger) | songCode | |
| lyricUrl: | (NSString *_Nullable) | lyricUrl | |
| reason: | (AgoraMusicContentCenterStateReason) | reason | |
Lyric url callback of getLyric, occurs when getLyric is called
| requestId | The request id is same as that returned by getLyric |
| songCode | Song code |
| lyricUrl | The lyric url of this music |
| reason | The status of the request. See MusicContentCenterStateReason |
| - (void) onSongSimpleInfoResult: | (NSString *) | requestId | |
| songCode: | (NSInteger) | songCode | |
| simpleInfo: | (NSString *_Nullable) | simpleInfo | |
| reason: | (AgoraMusicContentCenterStateReason) | reason | |
Simple info callback of getSongSimpleInfo, occurs when getSongSimpleInfo is called
| requestId | The request id is same as that returned by getSongSimpleInfo. |
| songCode | Song code |
| simpleInfo | The metadata of the music. |
| reason | The status of the request. See MusicContentCenterStateReason |
| - (void) onPreLoadEvent: | (NSString *) | requestId | |
| songCode: | (NSInteger) | songCode | |
| percent: | (NSInteger) | percent | |
| lyricUrl: | (NSString *_Nullable) | lyricUrl | |
| state: | (AgoraMusicContentCenterPreloadState) | state | |
| reason: | (AgoraMusicContentCenterStateReason) | reason | |
Preload process callback, occurs when preload is called
| requestId | The request id is same as that returned by preload. |
| songCode | Song code |
| percent | Preload progress (0 ~ 100) |
| lyricUrl | The lyric url of this music |
| state | Preload state; see PreloadState. |
| reason | The status of the request. See MusicContentCenterStateReason |