NECopyrightedMedia.h

Go to the documentation of this file.

// Copyright (c) 2022 NetEase, Inc. All rights reserved.
// Use of this source code is governed by a MIT license that can be
// found in the LICENSE file.
 
#import <Foundation/Foundation.h>
#import "NECopyrightedHotSong.h"
#import "NECopyrightedSong.h"
 
NS_ASSUME_NONNULL_BEGIN
 
@protocol NESongPreloadProtocol <NSObject>
@optional
 
- (void)onPreloadStart:(NSString *)songId channel:(SongChannel)channel;
 
- (void)onPreloadProgress:(NSString *)songId channel:(SongChannel)channel progress:(float)progress;
 
- (void)onPreloadComplete:(NSString *)songId
                  channel:(SongChannel)channel
                    error:(NSError *_Nullable)error;
 
@end
 
@protocol NECopyrightedEventHandler <NSObject>
 
- (void)onTokenExpired;
 
@optional
 
@end
 
@interface NECopyrightedMedia : NSObject
 
+ (instancetype)getInstance;
 
- (void)initialize:(NSString *_Nonnull)appkey
             token:(NSString *_Nonnull)token
          userUuid:(NSString *_Nullable)userUuid
            extras:(NSDictionary *_Nullable)extras
          callback:(void (^)(NSError *_Nullable error))callback;
 
- (void)preloadSong:(NSString *)songId
            channel:(SongChannel)channel
            observe:(id<NESongPreloadProtocol> _Nullable)observe;
 
- (void)clearSongCache;
 
- (void)cancelPreloadSong:(NSString *)songId channel:(SongChannel)channel;
 
- (bool)isSongPreloaded:(NSString *)songId channel:(SongChannel)channel;
 
- (void)searchSong:(NSString *_Nullable)keyword
           channel:(NSNumber *_Nullable)channel
           pageNum:(NSNumber *_Nullable)pageNum
          pageSize:(NSNumber *_Nullable)pageSize
          callback:(void (^)(NSArray<NECopyrightedSong *> *_Nullable songList,
                             NSError *_Nullable error))callback;
 
- (NSString *_Nullable)getSongURI:(NSString *_Nonnull)songId
                          channel:(SongChannel)channel
                      songResType:(SongResType)songResType;
 
- (NSString *_Nullable)getLyric:(NSString *_Nonnull)songId channel:(SongChannel)channel;
 
- (NSString *_Nullable)getPitch:(NSString *_Nonnull)songId channel:(SongChannel)channel;
 
- (void)preloadSongLyric:(NSString *)songId
                 channel:(SongChannel)channel
                callback:(void (^)(NSString *_Nullable content, NSString *_Nullable lyricType,
                                   NSError *_Nullable error))callback;
- (void)getSongList:(NSArray<NSString *> *_Nullable)tags
            channel:(NSNumber *_Nullable)channel
            pageNum:(NSNumber *_Nullable)pageNum
           pageSize:(NSNumber *_Nullable)pageSize
           callback:(void (^)(NSArray<NECopyrightedSong *> *songList, NSError *error))callback;
 
- (void)getHotSongList:(NECopyrightedHotType)hotType
          hotDimension:(NECopyrightedHotDimension)hotDimension
               channel:(NSNumber *_Nullable)channel
               pageNum:(NSNumber *_Nullable)pageNum
              pageSize:(NSNumber *_Nullable)pageSize
              callback:
                  (void (^)(NSArray<NECopyrightedHotSong *> *songList, NSError *error))callback;
- (void)setEventHandler:(id<NECopyrightedEventHandler>)observe;
 
- (void)renewToken:(NSString *)token;
 
- (BOOL)hasInitialized;
 
- (void)setSongScene:(SongScene)songScene;
 
@end
 
NS_ASSUME_NONNULL_END