Skip to content

SNCopyrightedMediaPlayer

Ju Liaoyuan edited this page Dec 20, 2022 · 1 revision

SNCopyrightedMediaPlayer Protocol Reference

  Conforms to NSObject

SNMediaPlayer
  Declared in SNCopyrightedMediaPlayer.h

Overview

版权音乐播放器接口。主要针对需要播放版权音乐(无法获取到音乐的URL)的场景。 如果需要播放网络音乐(可以获取到URL),直接使用 SNMediaPlayer 的功能即可。

NOTE: 由于版权原因,无法播放流媒体音乐,所以会需要先 download 本地,再进行播放,业务上要做相关的处理。

Tasks

– playWithMusicId:token: required method

– playWithMusicId:token:bitrate: required method

– onLoadProgress required method

– onPlayError required method

– clearCacheData

– setMaxCacheMusicCount:

– checkMusicCached:bitrate:

– setProgressInterval:

Instance Methods

checkMusicCached:bitrate:

检查本地资源是否存在

- (BOOL)checkMusicCached:(NSString *)*musicId* bitrate:(SNCopyrightedMediaBitrate)*bitrate*

Parameters

musicId
   音乐id

bitrate
   音乐资源码率

Return Value

true: 已缓存; false:未缓存

Discussion

检查本地资源是否存在

Declared In

  • SNCopyrightedMediaPlayer.h

clearCacheData

清除歌曲本地缓存

- (void)clearCacheData

Discussion

清除歌曲本地缓存

Declared In

  • SNCopyrightedMediaPlayer.h

onLoadProgress

歌曲下载进度回调

- (RACSubject *)onLoadProgress

Return Value

返回值为元组

  1. 第一个元素为歌曲id,类型为
  2. 第二个元素为下载进度百分比,类型为 NSNumber(CGFloat),值范围为 0 ~ 1
  3. 第三个元素为是否完成的标志位,类型为 NSNumber(BOOL),0 代表未结束,1 代表下载完成

Discussion

歌曲下载进度回调

Declared In

  • SNCopyrightedMediaPlayer.h

onPlayError

播放错误回调

- (RACSubject *)onPlayError

Return Value

NSError 对象

Discussion

播放错误回调

Declared In

  • SNCopyrightedMediaPlayer.h

playWithMusicId:token:

播放版权音乐

- (void)playWithMusicId:(NSString *)*musicId* token:(NSString *)*token*

Parameters

musicId
   音乐id

token
   播放的token

NOTE: 该接口无码率设置,内部会使用默认码率(low)。 如果要设置单曲的码率,可以使用 playWithMusicId:token:bitrate:

Discussion

播放版权音乐

Declared In

  • SNCopyrightedMediaPlayer.h

playWithMusicId:token:bitrate:

播放版权音乐,可以指定音乐的码率

- (void)playWithMusicId:(NSString *)*musicId* token:(NSString *)*token* bitrate:(SNCopyrightedMediaBitrate __nullable)*bitrate*

Parameters

musicId
   音乐id

token
   播放的token

bitrate
   音乐的码率,可选值参考 SNCopyrightedMediaBitrate 常量。

Discussion

播放版权音乐,可以指定音乐的码率

Declared In

  • SNCopyrightedMediaPlayer.h

setMaxCacheMusicCount:

设置最大缓冲歌曲数

- (void)setMaxCacheMusicCount:(int)*count*

Discussion

设置最大缓冲歌曲数

Declared In

  • SNCopyrightedMediaPlayer.h

setProgressInterval:

设置播放进度回调频率(Zego 房间生效)

- (void)setProgressInterval:(NSInteger)*interval*

Parameters

interval
   回调频率,单位 ms,默认 1000ms

Discussion

设置播放进度回调频率(Zego 房间生效)

Declared In

  • SNCopyrightedMediaPlayer.h
Clone this wiki locally