全部产品
云市场

接口变更说明

更新时间:2018-05-27 18:28:28

V3.4.4

高级播放器

变更接口

ALPlayerVideoErrorModel类更名为AliyunPlayerVideoErrorModel

  1. - (void)vodPlayer:(AliyunVodPlayer *)vodPlayer playBackErrorModel:(ALPlayerVideoErrorModel *)errorModel;
  2. 更改为:
  3. - (void)vodPlayer:(AliyunVodPlayer *)vodPlayer playBackErrorModel:(AliyunPlayerVideoErrorModel *)errorModel;

直播时移中ALPlayerVideoTimeShiftModel类名更改为AliyunPlayerVideoTimeShiftModel

  1. @property (nonatomic, strong) ALPlayerVideoTimeShiftModel *timeShiftModel;
  2. 更改为:
  3. @property (nonatomic, strong) AliyunPlayerVideoTimeShiftModel *timeShiftModel;

V3.4.2

基础播放器

新增接口

  1. /*
  2. * 功能:防盗链参数
  3. */
  4. - (void)setReferer:(NSString *)referer;

高级播放器

新增接口

  1. /*
  2. *功能:防盗链参数
  3. */
  4. @property (nonatomic, copy) NSString *referer;

V3.4.0

高级播放器

新增接口

播放器

  1. /*
  2. *功能:播放器鉴权数据过期。
  3. */
  4. - (void)onTimeExpiredErrorWithVodPlayer:(AliyunVodPlayer *)vodPlayer;
  5. /*
  6. *功能:播放地址存在过期时间,此时播放地址过期时提供的回调消息
  7. *参数:videoid:过期时播放的videoId
  8. *参数:quality:过期时播放的清晰度,playauth播放方式和STS播放方式有效。
  9. *参数:videoDefinition:过期时播放的清晰度,MTS播放方式时有效。
  10. */
  11. - (void)vodPlayerPlaybackAddressExpiredWithVideoId:(NSString *)videoId quality:(AliyunVodPlayerVideoQuality)quality videoDefinition:(NSString*)videoDefinition;

直播时移

  1. /*
  2. *直播时移接口
  3. */
  4. //直播时间
  5. @property (nonatomic, assign) NSTimeInterval liveTime;
  6. //播放时间
  7. @property (nonatomic, assign) NSTimeInterval currentPlayTime;
  8. //每60秒更新用户时移时间
  9. @property (nonatomic, strong) ALPlayerVideoTimeShiftModel *timeShiftModel;
  10. //直播地址
  11. - (void)prepareWithLiveTimeUrl:(NSURL *)liveTimeUrl;
  12. //设置时移地址
  13. - (void)setLiveTimeShiftUrl:(NSString*)liveTimeShiftUrl;
  14. /*
  15. *功能:seek到播放的时间点
  16. *参数:startTime 当前时间秒数。
  17. */
  18. - (void)seekToLiveTime:(NSTimeInterval)startTime;

播放器下载功能

  1. //AliyunDataSource类内增加 MTS下载所需参数。 支持MTS下载功能
  2. @interface AliyunMtsData :NSObject
  3. @property(nonatomic,copy)NSString *accessKeyId;
  4. @property(nonatomic,copy)NSString *accessKeySecret;
  5. @property(nonatomic,copy)NSString *securityToken;
  6. @property(nonatomic,copy)NSString *authInfo;
  7. @property(nonatomic,copy)NSString *region;
  8. @property(nonatomic,copy)NSString *playDomain;
  9. @property(nonatomic,copy)NSString *mtsHlsUriToken;
  10. @end

更新接口

播放器下载功能更新前

  1. - (void)onGetAliyunStsData:(AliyunStsData*)stsData
  2. videoID:(NSString *)videoID
  3. format:(NSString*)format
  4. quality:(AliyunVodPlayerVideoQuality)quality{
  5. //开始下载后收到回调,更新最新的stsData。主要场景是开始多个下载时,等待下载的任务自动开始下载后,stsData有可能已经过期了,需通过此回调更新(V3.2.0版本开始使用)
  6. }
  7. -(NSString*) onGetPlayAuth:(NSString*)vid format:(NSString*)format quality:(AliyunVodPlayerVideoQuality)quality{
  8. //开始下载后收到回调,更新最新的playAuth。主要场景是开始多个下载时,等待下载的任务自动开始下载后,playAuth有可能已经过期了,需通过此回调更新。(V3.2.0之前使用,兼容老用户)
  9. return newestPlayAuth
  10. }

更新后

  1. /*
  2. 功能:开始下载后收到回调,更新最新的playAuth。主要场景是开始多个下载时,等待下载的任务自动开始下载后,playAuth有可能已经过期了,需通过此回调更新
  3. 参数:返回当前数据
  4. 返回:使用代理方法,设置playauth来更新数据。
  5. */
  6. -(NSString*)onGetPlayAuth:(NSString*)vid format:(NSString*)format quality:(AliyunVodPlayerVideoQuality)quality;
  7. /*
  8. 功能:开始下载后收到回调,更新最新的stsData。主要场景是开始多个下载时,等待下载的任务自动开始下载后,stsData有可能已经过期了,需通过此回调更新
  9. 参数:返回当前数据
  10. 返回:使用代理方法,设置AliyunStsData来更新数据。
  11. */
  12. - (AliyunStsData*)onGetAliyunStsData:(NSString *)videoID
  13. format:(NSString*)format
  14. quality:(AliyunVodPlayerVideoQuality)quality;
  15. /*
  16. 功能:开始下载后收到回调,更新最新的MtsData。主要场景是开始多个下载时,等待下载的任务自动开始下载后,MtsData有可能已经过期了,需通过此回调更新
  17. 参数:返回当前数据
  18. 返回:使用代理方法,设置AliyunMtsData来更新数据。
  19. */
  20. - (AliyunMtsData*)onGetAliyunMtsData:(NSString *)videoID
  21. format:(NSString*)format
  22. quality:(NSString *)quality;

V3.3.3

基础播放器

新增接口

  1. /**
  2. * 功能:直播答题获取到的SEI数据
  3. * name:AliVcMediaPlayerSeiDataNotification
  4. */
  5. //直播答题接收的消息,用来处理题目信息或公布答案信息
  6. [[NSNotificationCenter defaultCenter] addObserver:self
  7. selector:@selector(onSeiData:)
  8. name:AliVcMediaPlayerSeiDataNotification object:self.mediaPlayer];
  9. /*
  10. * seiData结构如下
  11. {//接收到答题时
  12. "questionId": "001",
  13. "type": "startAnswer"
  14. }
  15. {//接收到答题结果时
  16. "questionId": "001",
  17. "type": "showResult",
  18. "showTime": "5"
  19. }
  20. */
  21. - (void)onSeiData:(NSNotification *)notification{
  22. NSDictionary* dict = [notification userInfo];
  23. if (dict) {
  24. NSString* seiData = [dict objectForKey:@"seiData"];
  25. if (seiData) {
  26. NSLog(@"sei data is %@",seiData);
  27. }
  28. }
  29. }

V3.3.0

高级播放器接口更改记录:

新增接口

  1. /**
  2. * 功能:循环播放开始
  3. */
  4. @protocol AliyunVodPlayerDelegate <NSObject>
  5. - (void)onCircleStartWithVodPlayer:(AliyunVodPlayer*)vodPlayer;
  6. /**
  7. * 功能:
  8. * 参数:设置渲染视图角度
  9. */
  10. -(void) setRenderRotate:(RenderRotate)rotate;
  11. /**
  12. * 功能:
  13. * 参数:设置渲染镜像
  14. */
  15. -(void) setRenderMirrorMode:(RenderMirrorMode)mirrorMode;

UI播放器接口更改记录:

新增接口

  1. /**
  2. * 功能:循环播放开始
  3. */
  4. @protocol AliyunVodPlayerViewDelegate <NSObject>
  5. - (void)onCircleStartWithVodPlayerView:(AliyunVodPlayerView *)playerView;
  6. /**
  7. * 功能:
  8. * 参数:设置渲染视图角度
  9. */
  10. -(void) setRenderRotate:(RenderRotate)rotate;
  11. /**
  12. * 功能:
  13. * 参数:设置渲染镜像
  14. */
  15. -(void) setRenderMirrorMode:(RenderMirrorMode)mirrorMode;

V3.2.0

高级播放器接口更改记录:

新增接口

prepareWithVid: accessKeyId: accessKeySecret: securityToken:

  • (void)prepareWithVid:(NSString )vid accessKeyId:(NSString)accessKeyId accessKeySecret:(NSString)accessKeySecret securityToken:(NSString )securityToken;

功能:使用vid+playAuth方式播放。参数:临时AccessKeyId、AccessKeySecret和SecurityToken:开启RAM授权,并通过STS授权系统提供的OpenAPI或SDK获取的AccessKeyId、AccessKeySecret和SecurityToken,用于播放和下载请求(V3.2.0版起推荐使用STS的播放方式)。详见:STS SDK参考

seekToTime

  • (void)seekToTime:(NSTimeInterval)time;

功能:跳转到指定位置进行播放,单位为秒;更新:3.2.0版本增加cache时间内进行seekTo功能;仅限向前seekTo,在无网状态下可播放缓存内容。

circlePlay

  • @property(nonatomic, readwrite) BOOL circlePlay;

功能:循环播放控制

snapshot

  • -(UIImage*) snapshot;

功能:截取当前正在播放图像

UI播放器接口更改记录:

新增接口

aliyunVodPlayerView:fullScreen
功能:delegate 方法
备注:返回当前播放器是否全屏。

  • (void)aliyunVodPlayerView:(AliyunVodPlayerView *)playerView fullScreen:(BOOL)isFullScreen;

prepareWithVid: accessKeyId: accessKeySecret: securityToken:

  • (void)playViewPrepareWithVid:(NSString )vid accessKeyId:(NSString)accessKeyId accessKeySecret:(NSString)accessKeySecret securityToken:(NSString )securityToken;

功能:使用vid+playAuth方式播放。参数:临时AccessKeyId、AccessKeySecret和SecurityToken:开启RAM授权,并通过STS授权系统提供的OpenAPI或SDK获取的AccessKeyId、AccessKeySecret和SecurityToken,用于播放和下载请求(V3.2.0版起推荐使用STS的播放方式)。详见:STS SDK参考

circlePlay

  • @property(nonatomic, readwrite) BOOL circlePlay;

功能:循环播放控制

snapshot

  • -(UIImage*) snapshot;

功能:截取当前正在播放图像

V3.1.0

高级播放器接口更改记录:

新增接口

bufferPercentage
功能:获取缓冲的时长,只读属性,单位为毫秒。
备注:当调用了prepareToPlay后,并且开始播放后,才能获取该值。

  • @property(nonatomic, readonly) NSTimeInterval bufferPercentage;

getAudioData
功能:音频数据回调

  • (void) getAudioData:(void (^)(NSData *data))block;

UI播放器接口更改记录:

新增接口

setPlayFinishDescribe
功能:播放器播放结束,文字描述;
参数:默认文案:@”再次观看,请点击重新播放”;

  • (void)setPlayFinishDescribe:(NSString *)des;


功能:播放器网络状态不好,文字描述;
参数:默认文案:@”当前网络不佳,请稍后点击重新播放”;

  • (void)setNetTimeOutDescribe:(NSString *)des;


功能:播放器无网络,文字描述;
参数:默认文案:@”无网络连接,检查网络后点击重新播放”;

  • (void)setNoNetDescribe:(NSString *)des;


功能:播放器加载出错,文字描述;
参数:默认文案:@”视频加载出错,请点击重新播放”;

  • (void)setLoaddataErrorDescribe:(NSString *)des;


功能:播放器4G网络状态,文字描述;
参数:默认文案:@”当前为移动网络,请点击播放”;

  • (void)setUseWanNetDescribe:(NSString *)des;

V3.0.0

高级播放器接口更改记录:

1.废弃接口

  • (void) initAccessKeyAndApiKey:(NSString )acessKeyID andAppSecret:(NSString )accessKeySecret andApiKey:(NSString)apiKey playAuth : (NSString )playAuth playUserMethod : (AliyunVodPlayerUserMethod)userMethod;

    备注:考虑用户信息保密问题,废弃此接口,请使用vid+playAuth或url的方式播放。

2.新增接口

prepareWithVid

  • (void)prepareWithVid:(NSString)vid accId:(NSString )accId accSecret:(NSString)accSecret stsToken:(NSString)stsToken authInfo:(NSString)authInfo region:(NSString)region playDomain:(NSString*)playDomain;

功能:视频转码服务用户使用播放方式

备注:部分参数参考:https://help.aliyun.com/document_detail/53522.html?spm=5176.doc53534.2.5.mhSfOh

playViewPrepareWithVid

  • (void)prepareWithVid:(NSString )vid playAuth:(NSString )playAuth;

功能:vid和playauth 播放方式.

getAliyunMediaInfo

- (AliyunVodPlayerVideo *)getAliyunMediaInfo;

功能:获取媒体信息, 当AliyunVodPlayerEventPrepareDone时,才能获取到该参数对象

setPlayingCache:saveDir:maxSize:maxDuration:

-(void) setPlayingCache:(BOOL)bEnabled saveDir:(NSString*)saveDir maxSize:(int64_t)maxSize maxDuration:(int)maxDuration;

功能:设置边播边缓存功能,在播放器prepare之前使用。

参数:

  • bEnabled:是否开启缓存功能
  • saveDir:缓存存储的路径
  • maxSize:缓存路径最大空间(MB)
  • maxDuration:缓存最大视频最大长度(秒)

isPlaying

@property (nonatomic, readonly,assign) BOOL isPlaying;

功能:播放器初始化后,获取播放器是否播放。

timeout

@property (nonatomic, readonly,assign) BOOL isPlaying;

功能:设置网络超时时间,单位毫秒

备注:当播放网络流时,设置网络超时时间,默认15000毫秒

videoWidth

@property (nonatomic, readonly,assign)int videoWidth;

功能:获取视频宽度,只读属性。

备注:当调用了prepareToPlay后,并不能立即获得playVideoWidth的值,只有当播放器发送了prepared通知后,videoWidth的值才有效,否则为默认值0。

videoHeight

@property (nonatomic, readonly,assign)int videoHeight;

功能:获取视频高度,只读属性。

备注:当调用了prepareToPlay后,并不能立即获得playVideoHeight的值,只有当播放器发送了prepared通知后,videoHeight的值才有效,否则为默认值0。

pringtLog

@property (nonatomic, getter=isPrintLog,assign) BOOL pringtLog;

功能: 功能:日志开关, default : NO

brightness

@property (nonatomic, readwrite) float brightness;

功能:亮度,调用brightness系统属性,brightness(0~1.0)

volume

@property (nonatomic, readwrite) float volume;

功能:声音调节,调用系统MPVolumeView类实现,并非视频声音;volume(0~1.0)

UI播放器接口更改记录:

1.废弃接口

initAccessKeyAndApiKey

  • (void) initAccessKeyAndApiKey:(NSString )acessKeyID andAppSecret:(NSString )accessKeySecret andApiKey:(NSString)apiKey playAuth : (NSString )playAuth playUserMethod : (AliyunVodPlayerUserMethod)userMethod;

    备注:考虑用户信息保密问题,废弃此接口,请使用vid+playAuth或url的方式播放。

2.新增接口

playViewPrepareWithVid

  • (void)playViewPrepareWithVid:(NSString )vid playAuth : (NSString )playAuth;

功能:vid和playauth 播放方式.setAutoPlay

- (void)setAutoPlay:(BOOL)autoPlay;

功能:设置是否自动播放

参数:autoPlay,为YES时表示自动播放

playWithUrl

- (void)playWithUrl:(NSURL*)url;

功能:播放器初始化视频,主要目的是分析视频内容,读取视频头信息,解析视频流中的视频和音频信息,并根据视频和音频信息去寻找解码器,创建播放线程等

参数:url,输入视频的url地址,包括本地和网络视频地址

备注:如果设置成AutoPlay,则调用此函数会进行自动播放,否则需要调用start进行播放。

resume

- (void)resume;

功能:恢复播放视频

备注:在pause暂停视频之后可以调用resume进行播放,设置视频切换清晰度的监听事件。

pause

- (void)pause;

功能:暂停播放视频

备注:在start播放视频之后可以调用pause进行暂停,设置视频播放结束的监听事件。

replay

- (void)replay;

功能:重播

pringtLog

@property (nonatomic, getter=isPrintLog,assign) BOOL pringtLog;

功能: 功能:日志开关, default : NO

brightness

@property (nonatomic, readwrite) float brightness;

功能:亮度,调用brightness系统属性,brightness(0~1.0)

volume

@property (nonatomic, readwrite) float volume;

功能:声音调节,调用系统MPVolumeView类实现,并非视频声音;volume(0~1.0)

备注:协议AliyunVodPlayerViewDelegate为

AliyunVodPlayerViewDelegate

@protocol AliyunVodPlayerViewDelegate - (void)onBackViewClick;当视频返回的时候的消息响应代理,此处可以进行一些销毁操作。

@protocol AliyunVodPlayerViewDelegate -(void)onPause:(NSTimeInterval)currentPlayTime;当视频暂停时的消息响应代理,返回播放器当前播放的位置。

@protocol AliyunVodPlayerViewDelegate -(void)onResume:(NSTimeInterval)currentPlayTime;当视频恢复播放时的消息响应代理,返回播放器当前播放的位置。

@protocol AliyunVodPlayerViewDelegate -(void)onStop:(NSTimeInterval)currentPlayTime;当视停止播放时的消息响应代理,返回播放器当前播放的位置。

@protocol AliyunVodPlayerViewDelegate - (void)aliyunVodPlayerView:(AliyunVodPlayerView)playerView onSeekDone:(NSTimeInterval)seekDoneTime;seektotime结束后消息相应代理。@protocol AliyunVodPlayerViewDelegate - (void)aliyunVodPlayerView:(AliyunVodPlayerView)playerView lockScreen:(BOOL)isLockScreen;当设定锁屏按钮时消息相应代理,返回锁屏状态。