Agora RTC Objective-C API Reference  Refactor
Data Structures
AgoraMusicContentCenter.h File Reference

Go to the source code of this file.

Data Structures

class  AgoraMusicCacheInfo
 
class  AgoraMusicChartInfo
 
class  AgoraMvProperty
 
class  AgoraClimaxSegment
 
class  AgoraMusic
 
class  AgoraMusicCollection
 
protocol  <AgoraMusicContentCenterEventDelegate>
 
class  AgoraMusicContentCenterConfig
 
protocol  <AgoraMusicPlayerProtocol>
 
class  AgoraMusicContentCenter
 

Enumeration Type Documentation

◆ AgoraMusicPlayMode

Playback modes for music resources.

Enumerator
AgoraMusicPlayModeOriginal 

0: Original singer.

AgoraMusicPlayModeAccompany 

1: Accompaniment.

AgoraMusicPlayModeLeadsing 

2: Vocal guide.

◆ AgoraMusicContentCenterPreloadState

The loading state of music resources.

Enumerator
AgoraMusicContentCenterPreloadStateOK 

0: Music resource loading is complete.

AgoraMusicContentCenterPreloadStateError 

1: Failed to load music resource.

AgoraMusicContentCenterPreloadStatePreloading 

2: Music resources are loading.

AgoraMusicContentCenterPreloadStateRemoveCache 

3: The cached music resource has been removed.

◆ AgoraMusicContentCenterStateReason

Request status codes for the music content center.

Enumerator
AgoraMusicContentCenterStateReasonOK 

0: Request succeeds.

AgoraMusicContentCenterStateReasonError 

1: General error with no specific attribution.

AgoraMusicContentCenterStateReasonErrorGateway 

2: Gateway error. Possible causes include:

  • The current Token has expired. Please regenerate the Token.
  • The provided Token is invalid. Make sure you are using a Temporary Token.
  • Network error. Please check your network connection.
AgoraMusicContentCenterStateReasonErrorPermissionAndResource 

3: Permission error or the music resource does not exist. Make sure your project has enabled the Agora Copyright music Content Center permission. Please contact technical support.

AgoraMusicContentCenterStateReasonErrorInternalDataParse 

4: Internal data parsing error. Please contact technical support.

AgoraMusicContentCenterStateReasonErrorMusicLoading 

5: Error occurs while loading music resources. Please contact technical support.

AgoraMusicContentCenterStateReasonErrorMusicDecryption 

6: Error occurs while decrypting music resources. Please contact technical support.

AgoraMusicContentCenterStateReasonErrorHttpInternalError 

7: An internal HTTP error occurs. Please try again later.

◆ AgoraMusicCacheStatusType

The cache state of music resources.

Enumerator
AgoraMusicCacheStatusTypeCached 

0: Music resource is cached.

AgoraMusicCacheStatusTypeCaching 

1: Music resources are being cached.