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 | AgoraMusicContentCenterPreloadState { AgoraMusicContentCenterPreloadStateOK = 0, AgoraMusicContentCenterPreloadStateError = 1, AgoraMusicContentCenterPreloadStatePreloading = 2, AgoraMusicContentCenterPreloadStateRemoveCache = 3 }
enum | AgoraMusicContentCenterStateReason { AgoraMusicContentCenterStateReasonOK = 0, AgoraMusicContentCenterStateReasonError = 1, AgoraMusicContentCenterStateReasonErrorGateway = 2, AgoraMusicContentCenterStateReasonErrorPermissionAndResource = 3, AgoraMusicContentCenterStateReasonErrorInternalDataParse = 4, AgoraMusicContentCenterStateReasonErrorMusicLoading = 5, AgoraMusicContentCenterStateReasonErrorMusicDecryption = 6, AgoraMusicContentCenterStateReasonErrorHttpInternalError = 7 }

## Enumeration Type Documentation

## ◆ AgoraMusicPlayMode

enum AgoraMusicPlayMode

Modes for playing songs.

Enumerator
AgoraMusicPlayModeOriginal | 0: The music player is in the origin mode, which means playing the original song.
AgoraMusicPlayModeAccompany | The music player is in the accompany mode, which means playing the accompaniment only.
AgoraMusicPlayModeLeadsing | 2: The music player is in the lead sing mode, which means playing the lead vocals.

## ◆ AgoraMusicContentCenterPreloadState

enum AgoraMusicContentCenterPreloadState

The status of preload request

Enumerator
AgoraMusicContentCenterPreloadStateOK | 0: No error occurs and preload succeeds.
AgoraMusicContentCenterPreloadStateError | 1: A general error occurs.
AgoraMusicContentCenterPreloadStatePreloading | 2: The media file is preloading.
AgoraMusicContentCenterPreloadStateRemoveCache | 3: The media file is removed.

## ◆ AgoraMusicContentCenterStateReason

enum AgoraMusicContentCenterStateReason

the status of search or get top list request

Enumerator
AgoraMusicContentCenterStateReasonOK | 0: No error occurs and request succeeds.
AgoraMusicContentCenterStateReasonError | 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.
AgoraMusicContentCenterStateReasonErrorGateway | 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.
AgoraMusicContentCenterStateReasonErrorPermissionAndResource | 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
AgoraMusicContentCenterStateReasonErrorInternalDataParse | 4: Internal data parse error. Please contact technical support
AgoraMusicContentCenterStateReasonErrorMusicLoading | 5: Music loading error. Please contact technical support
AgoraMusicContentCenterStateReasonErrorMusicDecryption | 6: Music decryption error. Please contact technical support
AgoraMusicContentCenterStateReasonErrorHttpInternalError | 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.