Agora RTC Objective-C API Reference Refactor

Data Structures | Enumerations
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

## Enumerations
enum | AgoraMusicPlayMode { AgoraMusicPlayModeOriginal = 0, AgoraMusicPlayModeAccompany = 1, AgoraMusicPlayModeLeadsing = 2 }
enum | AgoraMusicContentCenterPreloadStatus { AgoraMusicContentCenterPreloadStatusOK = 0, AgoraMusicContentCenterPreloadStatusError = 1, AgoraMusicContentCenterPreloadStatusPreloading = 2, AgoraMusicContentCenterPreloadStatusRemoveCache = 3 }
enum | AgoraMusicContentCenterStatusCode { AgoraMusicContentCenterStatusCodeOK = 0, AgoraMusicContentCenterStatusCodeError = 1, AgoraMusicContentCenterStatusCodeErrorGateway = 2, AgoraMusicContentCenterStatusCodeErrorPermissionAndResource = 3, AgoraMusicContentCenterStatusCodeErrorInternalDataParse = 4, AgoraMusicContentCenterStatusCodeErrorMusicLoading = 5, AgoraMusicContentCenterStatusCodeErrorMusicDecryption = 6, AgoraMusicContentCenterStatusCodeErrorHttpInternalError = 7 }

## Enumeration Type Documentation

## ◆ AgoraMusicPlayMode

enum AgoraMusicPlayMode

The play mode of music player.

Enumerator
AgoraMusicPlayModeOriginal | 0: The music player is in the original mode.
AgoraMusicPlayModeAccompany | The music player is in the accompany mode.
AgoraMusicPlayModeLeadsing | 2: The music player is in the lead sing mode.

## ◆ AgoraMusicContentCenterPreloadStatus

enum AgoraMusicContentCenterPreloadStatus

The status of preload request

Enumerator
AgoraMusicContentCenterPreloadStatusOK | 0: No error occurs and preload succeeds.
AgoraMusicContentCenterPreloadStatusError | 1: A general error occurs.
AgoraMusicContentCenterPreloadStatusPreloading | 2: The media file is preloading.
AgoraMusicContentCenterPreloadStatusRemoveCache | 3: The media file is removed.

## ◆ AgoraMusicContentCenterStatusCode

enum AgoraMusicContentCenterStatusCode

the status of search or get top list request

Enumerator
AgoraMusicContentCenterStatusCodeOK | 0: No error occurs and request succeeds.
AgoraMusicContentCenterStatusCodeError | 1: The gateway error. There are several possible reasons: Token is expired. Check if your token is expired. Token is invalid. Check the type of token you passed in. Network error. Check your network.
AgoraMusicContentCenterStatusCodeErrorGateway | 2: The gateway error. There are several possible reasons: Token is expired. Check if your token is expired. Token is invalid. Check the type of token you passed in. Network error. Check your network.
AgoraMusicContentCenterStatusCodeErrorPermissionAndResource | 3: Permission and resource error. There are several possible reasons: Your appid may not have the mcc permission. Please contact technical support The resource may not exist. Please contact technical support
AgoraMusicContentCenterStatusCodeErrorInternalDataParse | 4: Internal data parse error. Please contact technical support
AgoraMusicContentCenterStatusCodeErrorMusicLoading | 5: Music loading error. Please contact technical support
AgoraMusicContentCenterStatusCodeErrorMusicDecryption | 6: Music decryption error. Please contact technical support
AgoraMusicContentCenterStatusCodeErrorHttpInternalError | 7: Http internal error. Please retry later.

## ◆ AgoraMusicCacheStatusType

enum AgoraMusicCacheStatusType

Enumerator
AgoraMusicCacheStatusTypeCached | 0: The media file is already cached.
AgoraMusicCacheStatusTypeCaching | 1: The media file is being cached.