AgoraMusicContentCenter.h

Go to the documentation of this file.

//
//  AgoraMusicContentCenter.h
//  AgoraMusicContentCenter
//
//  Created by dingyusong on 2022/6/1.
//  Copyright © 2022 Agora. All rights reserved.
//
 
#import <Foundation/Foundation.h>
 
@protocol AgoraRtcMediaPlayerProtocol;
@protocol AgoraRtcMediaPlayerDelegate;
 
typedef NS_ENUM(NSUInteger, AgoraMusicPlayMode) {
    AgoraMusicPlayModeOriginal = 0,
 
    AgoraMusicPlayModeAccompany = 1,
    AgoraMusicPlayModeLeadsing = 2,
};
 
typedef NS_ENUM(NSUInteger, AgoraMusicContentCenterPreloadState) {
    AgoraMusicContentCenterPreloadStateOK = 0,
 
    AgoraMusicContentCenterPreloadStateError = 1,
 
    AgoraMusicContentCenterPreloadStatePreloading = 2,
    
    AgoraMusicContentCenterPreloadStateRemoveCache = 3,
};
 
typedef NS_ENUM(NSUInteger, AgoraMusicContentCenterStateReason) {
    AgoraMusicContentCenterStateReasonOK = 0,
    AgoraMusicContentCenterStateReasonError = 1,
    AgoraMusicContentCenterStateReasonErrorGateway = 2,
    AgoraMusicContentCenterStateReasonErrorPermissionAndResource = 3,
    AgoraMusicContentCenterStateReasonErrorInternalDataParse = 4,
    AgoraMusicContentCenterStateReasonErrorMusicLoading = 5,
    AgoraMusicContentCenterStateReasonErrorMusicDecryption = 6,
    AgoraMusicContentCenterStateReasonErrorHttpInternalError = 7,
};
 
typedef NS_ENUM(NSUInteger, AgoraMusicCacheStatusType) {
    AgoraMusicCacheStatusTypeCached = 0,
 
    AgoraMusicCacheStatusTypeCaching = 1,
};
 
NS_ASSUME_NONNULL_BEGIN
 
__attribute__((visibility("default"))) @interface AgoraMusicCacheInfo : NSObject
@property(nonatomic, assign) NSInteger songCode;
 
@property(nonatomic, assign) AgoraMusicCacheStatusType statusType;
@end
 
__attribute__((visibility("default"))) @interface AgoraMusicChartInfo : NSObject
@property (nonatomic, copy) NSString *chartName;
@property (nonatomic, assign) NSInteger identify;
@end
 
__attribute__((visibility("default"))) @interface AgoraMvProperty : NSObject
@property (nonatomic, copy) NSString *resolution;
@property (nonatomic, copy) NSString *bandwidth;
@end
 
__attribute__((visibility("default"))) @interface AgoraClimaxSegment : NSObject
@property(nonatomic, assign) NSInteger startTimeMs;
@property(nonatomic, assign) NSInteger endTimeMs;
@end
 
__attribute__((visibility("default"))) @interface AgoraMusic : NSObject
@property(nonatomic, assign) NSInteger songCode;
@property(nonatomic, assign) NSInteger type;
@property(nonatomic, assign) NSInteger pitchType;
@property(nonatomic, copy) NSString* name;
@property(nonatomic, copy) NSString* singer;
@property(nonatomic, copy) NSString* poster;
 
@property(nonatomic, copy) NSString* releaseTime;
@property(nonatomic, assign) NSInteger durationS;
@property(nonatomic, strong) NSArray<NSNumber *>* lyricList;
@property(nonatomic, strong) NSArray<AgoraMvProperty *>* mvPropertyList;
@property(nonatomic, strong) NSArray<AgoraClimaxSegment *>* climaxSegmentList;
@end
 
__attribute__((visibility("default"))) @interface AgoraMusicCollection : NSObject
@property(nonatomic, assign) NSInteger count;
@property(nonatomic, assign) NSInteger total;
@property(nonatomic, assign) NSInteger page;
@property(nonatomic, assign) NSInteger pageSize;
@property(nonatomic, strong) NSArray<AgoraMusic *>* musicList;
@end
 
@protocol AgoraMusicContentCenterEventDelegate <NSObject>
- (void)onMusicChartsResult:(NSString *)requestId result:(NSArray<AgoraMusicChartInfo*> *)result reason:(AgoraMusicContentCenterStateReason)reason;
 
- (void)onMusicCollectionResult:(NSString *)requestId result:(AgoraMusicCollection *)result reason:(AgoraMusicContentCenterStateReason)reason;
 
- (void)onLyricResult:(NSString*)requestId songCode:(NSInteger)songCode lyricUrl:(NSString* _Nullable)lyricUrl reason:(AgoraMusicContentCenterStateReason)reason;
 
- (void)onSongSimpleInfoResult:(NSString*)requestId songCode:(NSInteger)songCode simpleInfo:(NSString* _Nullable)simpleInfo reason:(AgoraMusicContentCenterStateReason)reason;
 
- (void)onPreLoadEvent:(NSString*)requestId songCode:(NSInteger)songCode percent:(NSInteger)percent lyricUrl:(NSString * _Nullable)lyricUrl state:(AgoraMusicContentCenterPreloadState)state reason:(AgoraMusicContentCenterStateReason)reason;
@end
 
 
@class AgoraRtcEngineKit;
__attribute__((visibility("default"))) @interface AgoraMusicContentCenterConfig : NSObject
@property(assign, nonatomic) AgoraRtcEngineKit* _Nullable rtcEngine;
@property (nonatomic, copy) NSString *appId;
@property (nonatomic, copy) NSString *token;
@property (nonatomic, assign) NSInteger mccUid;
@property (nonatomic, assign) NSUInteger maxCacheSize;
@property(nonatomic, copy) NSString* mccDomain;
@property(nonatomic, weak) id<AgoraMusicContentCenterEventDelegate> eventDelegate;
@end
 
@protocol AgoraMusicPlayerProtocol <AgoraRtcMediaPlayerProtocol>
- (NSInteger)openMediaWithSongCode:(NSInteger)songCode startPos:(NSInteger)startPos NS_SWIFT_NAME(openMedia(songCode:startPos:));
 
- (NSInteger)setPlayMode:(AgoraMusicPlayMode)mode NS_SWIFT_NAME(setPlayMode(mode:));
 
@end
 
 
__attribute__((visibility("default"))) @interface AgoraMusicContentCenter : NSObject
 
+ (instancetype _Nullable)sharedContentCenterWithConfig:(AgoraMusicContentCenterConfig *)config NS_SWIFT_NAME(sharedContentCenter(config:));
 
- (NSInteger)renewToken:(NSString * _Nonnull)token;
 
- (NSInteger)registerEventDelegate:(id<AgoraMusicContentCenterEventDelegate> _Nullable)eventDelegate;
 
- (id<AgoraMusicPlayerProtocol> _Nullable)createMusicPlayerWithDelegate:(id<AgoraRtcMediaPlayerDelegate> _Nullable)delegate NS_SWIFT_NAME(createMusicPlayer(delegate:));
 
- (NSInteger)destroyMusicPlayer:(id<AgoraMusicPlayerProtocol>)musicPlayer;
 
- (NSString *)getMusicCharts;
 
- (NSString *)getMusicCollectionWithMusicChartId:(NSInteger)musicChartId page:(NSInteger)page pageSize:(NSInteger)pageSize jsonOption:(NSString * _Nullable)jsonOption NS_SWIFT_NAME(getMusicCollection(musicChartId:page:pageSize:jsonOption:));
 
- (NSString *)searchMusicWithKeyWord:(NSString *)keyWord page:(NSInteger)page pageSize:(NSInteger)pageSize jsonOption:(NSString * _Nullable)jsonOption NS_SWIFT_NAME(searchMusic(keyWord:page:pageSize:jsonOption:));
 
- (NSInteger)preloadWithSongCode:(NSInteger)songCode jsonOption:(NSString* _Nullable)jsonOption NS_SWIFT_NAME(preload(songCode:jsonOption:))  __attribute__((deprecated("Use preload(songCode:) instead.")));
 
- (NSString *)preloadWithSongCode:(NSInteger)songCode NS_SWIFT_NAME(preload(songCode:));
 
- (NSInteger)isPreloadedWithSongCode:(NSInteger)songCode NS_SWIFT_NAME(isPreloaded(songCode:));
 
- (NSInteger)removeCacheWithSongCode:(NSInteger)songCode NS_SWIFT_NAME(removeCache(songCode:));
 
- (NSArray *)getCaches NS_SWIFT_NAME(getCaches());
 
- (NSInteger)getInternalSongCode:(NSInteger)songCode jsonOption:(NSString * _Nullable)jsonOption  NS_SWIFT_NAME(getInternalSongCode(songCode:jsonOption:));
 
- (NSString *)getLyricWithSongCode:(NSInteger)songCode lyricType:(NSInteger)lyricType NS_SWIFT_NAME(getLyric(songCode:lyricType:));
 
- (NSString *)getSongSimpleInfoWithSongCode:(NSInteger)songCode NS_SWIFT_NAME(getSongSimpleInfo(songCode:));
 
- (void)enableMainQueueDispatch:(BOOL)enabled;
 
+ (void)destroy;
 
 
#pragma mark - Unavailable Delegate Methods
#if TARGET_OS_IPHONE
- (void)onMusicChartsResult:(NSString *)requestId result:(NSArray<AgoraMusicChartInfo*> *)result errorCode:(AgoraMusicContentCenterStateReason)errorCode __attribute__((availability(ios,deprecated=7_0,message="Use onMusicChartsResult:result:statusCode: instead.")));
- (void)onMusicCollectionResult:(NSString *)requestId result:(AgoraMusicCollection *)result errorCode:(AgoraMusicContentCenterStateReason)errorCode __attribute__((availability(ios,deprecated=7_0,message="Use onMusicCollectionResult:result:statusCode: instead.")));
- (void)onLyricResult:(NSString*)requestId songCode:(NSInteger)songCode lyricUrl:(NSString* _Nullable)lyricUrl errorCode:(AgoraMusicContentCenterStateReason)errorCode __attribute__((availability(ios,deprecated=7_0,message="Use onLyricResult:songCode:lyricUrl:statusCode: instead.")));
- (void)onSongSimpleInfoResult:(NSString*)requestId songCode:(NSInteger)songCode simpleInfo:(NSString* _Nullable)simpleInfo errorCode:(AgoraMusicContentCenterStateReason)errorCode __attribute__((availability(ios,deprecated=7_0,message="Use onSongSimpleInfoResult:songCode:simpleInfo:statusCode: instead.")));
- (void)onPreLoadEvent:(NSString*)requestId songCode:(NSInteger)songCode percent:(NSInteger)percent lyricUrl:(NSString * _Nullable)lyricUrl state:(AgoraMusicContentCenterPreloadState)state errorCode:(AgoraMusicContentCenterStateReason)errorCode __attribute__((availability(ios,deprecated=7_0,message="Use onPreLoadEvent:songCode:percent:lyricUrl:status:statusCode: instead.")));
#endif
 
#if (!(TARGET_OS_IPHONE) && (TARGET_OS_MAC))
- (void)onMusicChartsResult:(NSString *)requestId result:(NSArray<AgoraMusicChartInfo*> *)result errorCode:(AgoraMusicContentCenterStateReason)errorCode __attribute__((availability(macos,deprecated=10_9,message="Use onMusicChartsResult:result:statusCode: instead.")));
- (void)onMusicCollectionResult:(NSString *)requestId result:(AgoraMusicCollection *)result errorCode:(AgoraMusicContentCenterStateReason)errorCode __attribute__((availability(macos,deprecated=10_9,message="Use onMusicCollectionResult:result:statusCode: instead.")));
- (void)onLyricResult:(NSString*)requestId songCode:(NSInteger)songCode lyricUrl:(NSString* _Nullable)lyricUrl errorCode:(AgoraMusicContentCenterStateReason)errorCode __attribute__((availability(macos,deprecated=10_9,message="Use onLyricResult:songCode:lyricUrl:statusCode: instead.")));
- (void)onSongSimpleInfoResult:(NSString*)requestId songCode:(NSInteger)songCode simpleInfo:(NSString* _Nullable)simpleInfo errorCode:(AgoraMusicContentCenterStateReason)errorCode __attribute__((availability(macos,deprecated=10_9,message="Use onSongSimpleInfoResult:songCode:simpleInfo:statusCode: instead.")));
- (void)onPreLoadEvent:(NSString*)requestId songCode:(NSInteger)songCode percent:(NSInteger)percent lyricUrl:(NSString * _Nullable)lyricUrl state:(AgoraMusicContentCenterPreloadState)state errorCode:(AgoraMusicContentCenterStateReason)errorCode __attribute__((availability(macos,deprecated=10_9,message="Use onPreLoadEvent:songCode:percent:lyricUrl:status:statusCode: instead.")));
#endif
 
@end
 
NS_ASSUME_NONNULL_END