AliyunPlayer v5.5.0.0
Aliyun Player API Reference Manual for iOS Platforms
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties
AliListPlayer Class Reference

#import "AliListPlayer.h"

Inheritance diagram for AliListPlayer:
AliPlayer

Instance Methods

(void) - addUrlSource:uid:
 添加资源到播放列表中 More...
 
(void) - addVidSource:uid:
 添加资源到播放列表中 More...
 
(void) - clear
 清除播放列表 More...
 
(NSString *) - currentUid
 获取当前播放资源的uid More...
 
(void) - destroy
 销毁播放器 More...
 
(instancetype) - init
 初始化播放列表 More...
 
(instancetype) - init:
 初始化播放器 More...
 
(BOOL) - moveTo:
 移动到指定位置开始准备播放,url播放方式 More...
 
(BOOL) - moveTo:accId:accKey:token:region:
 移动到指定位置开始准备播放,sts播放方式,需要更新sts信息 More...
 
(BOOL) - moveToNext
 当前位置移动到下一个进行准备播放,url播放方式 More...
 
(BOOL) - moveToNext:accKey:token:region:
 当前位置移动到下一个进行准备播放,sts播放方式,需要更新sts信息 More...
 
(BOOL) - moveToPre
 当前位置移动到上一个进行准备播放,url播放方式 More...
 
(BOOL) - moveToPre:accKey:token:region:
 当前位置移动到上一个进行准备播放,sts播放方式,需要更新sts信息 More...
 
(void) - removeSource:
 从播放列表中删除指定资源 More...
 
(void) - stop
 停止播放 More...
 
- Instance Methods inherited from AliPlayer
(void) - addExtSubtitle:
 添加外挂字幕。 More...
 
(void) - clearScreen
 清空画面。 More...
 
(void) - destroy
 销毁播放器 More...
 
(NSString *) - getCacheFilePath:
 根据url获取缓存的文件名。如果有自定义的规则,请实现delegate onGetCacheNameByURLMore...
 
(NSString *) - getCacheFilePath:format:definition:
 根据url获取缓存的文件名。如果有自定义的规则,请实现delegate onCacheNameByVidCallbackMore...
 
(NSString *) - getCacheFilePath:format:definition:previewTime:
 根据url获取缓存的文件名。如果有自定义的规则,请实现delegate onCacheNameByVidCallbackMore...
 
(AVPConfig *) - getConfig
 获取播放器设置 More...
 
(AVPTrackInfo *) - getCurrentTrack:
 获取当前播放track More...
 
(AVPMediaInfo *) - getMediaInfo
 获取媒体信息,包括track信息 More...
 
(NSString *) - getOption:
 获取播放器的参数 More...
 
(void *) - getPlayer
 
(NSString *) - getPlayerName
 获取播放时使用的播放器名字 More...
 
(NSString *) - getPropertyString:
 根据key获取相应的信息。 More...
 
(void) - getThumbnail:
 获取指定位置的缩略图 More...
 
(instancetype) - init
 初始化播放器 More...
 
(instancetype) - init:
 初始化播放器 More...
 
(int) - invokeComponent:
 向播放器的组件发送命令。 More...
 
(void) - pause
 暂停播放 More...
 
(void) - prepare
 播放准备,异步 More...
 
(void) - redraw
 刷新view,例如view size变化时。 More...
 
(void) - reload
 重新加载。比如网络超时时,可以重新加载。 More...
 
(void) - reset
 重置播放 More...
 
(void) - seekToTime:seekMode:
 跳转到指定的播放位置 More...
 
(void) - selectExtSubtitle:enable:
 选择外挂字幕 More...
 
(void) - selectTrack:
 根据trackIndex,切换清晰度 More...
 
(void) - selectTrack:accurate:
 根据trackIndex,切换清晰度 More...
 
(void) - sendCustomEvent:
 发送用户自定义事件,将通过AVPEventReportParamsDelegate回调。事件 e = 5001。 More...
 
(void) - setAuthSource:
 使用vid+playauth方式播放。可参考:https://help.aliyun.com/document_detail/57294.html More...
 
(void) - setBitStreamSource:
 使用bitstream方式来播放视频 More...
 
(BOOL) - setCacheConfig:
 设置缓存配置 More...
 
(void) - setConfig:
 播放器设置 More...
 
(void) - setDefaultBandWidth:
 设置多码率时默认播放的码率。将会选择与之最接近的一路流播放。 More...
 
(void) - setEventReportParamsDelegate:
 设置代理 参考AVPEventReportParamsDelegate More...
 
(void) - setFilterConfig:
 设置滤镜配置。在prepare之前调用此方法。如果想更新,调用updateFilterConfig() More...
 
(void) - setFilterInvalid:invalid:
 开启关闭滤镜. More...
 
(void) - setLiveStsSource:
 使用LiveSts 方式播放直播流 More...
 
(void) - setMaxAccurateSeekDelta:
 设置精准seek的最大间隔。 More...
 
(void) - setMpsSource:
 用vid和MPS信息来播放视频。可参考:https://help.aliyun.com/document_detail/53522.html?spm=5176.doc53534.2.5.mhSfOh More...
 
(void) - setPictureInPictureEnable:
 设置画中画功能开启/关闭 (目前播放器自带的画中画功能需要iOS15以上的系统,如果其他系统,可以通过播放器CicadaRenderingDelegate返回的pixelbuffer来自定义实现) More...
 
(void) - setPlayUrlConvertCallback:
 设置转换播放的url的回调函数,一般用于p2p中的url地址转换 More...
 
(void) - setPreferPlayerName:
 设置期望使用的播放器名字。 More...
 
(void) - setStreamDelayTime:time:
 设置某路流相对于主时钟的延时时间,默认是0, 目前只支持外挂字幕 More...
 
(void) - setStsSource:
 用vid和sts来播放视频,sts可参考:https://help.aliyun.com/document_detail/28756.html?spm=a2c4g.11186623.4.4.6f554c07q7B7aS More...
 
(void) - setThumbnailUrl:
 设置缩略图URL More...
 
(void) - setTraceID:
 用于跟踪debug信息 More...
 
(void) - setUrlSource:
 使用url方式来播放视频 More...
 
(void) - setVerifyStsCallback:
 设置校验AVPStsInfo是否过期回调 More...
 
(void) - setVideoTag:size:
 设置视频标签。值范围[0,99]。 More...
 
(void) - snapShot
 截图 AVPImage: mac平台返回NSImage,iOS平台返回UIImage More...
 
(void) - start
 开始播放 More...
 
(void) - stop
 停止播放 More...
 
(void) - updateFilterConfig:options:
 更新滤镜配置 More...
 
(void) - updateLiveStsInfo:accKey:token:region:
 更新LiveSts信息 More...
 

Properties

int maxPreloadMemorySizeMB
 设置最大的预缓存的内存大小,默认100M,最小20M More...
 
int preloadCount
 获取/设置预加载的个数,当前位置的前preloadCount和后preloadCount,默认preloadCount = 2 More...
 
NSString * stsPreloadDefinition
 获取/设置列表播放的sts播放方式,指定默认的清晰度,如"LD、HD"等,moveTo之前调用,一旦预加载后不能更改 More...
 
- Properties inherited from AliPlayer
id< CicadaRenderDelegate > renderDelegate __deprecated
 设置渲染回调。废弃,使用renderingDelegate。 More...
 
BOOL autoPlay
 设置是否自动播放,支持KVO More...
 
int64_t bufferedPosition
 获取已经缓存的位置,支持KVO More...
 
int64_t currentDownloadSpeed
 获取当前下载速度,支持KVO More...
 
int64_t currentPosition
 获取当前播放位置,支持KVO More...
 
int64_t currentUtcTime
 获取当前播放位置的utc时间,支持KVO More...
 
id< AVPDelegatedelegate
 设置代理,参考AVPDelegate More...
 
int64_t duration
 获取视频的长度,支持KVO More...
 
BOOL enableHardwareDecoder
 是否开启硬件解码,支持KVO More...
 
id< AVPEventReportParamsDelegateeventReportParamsDelegate
 设置埋点事件回调。 More...
 
int height
 获取视频的高度,支持KVO More...
 
int64_t localCacheLoadedSize
 获取当前播放命中的缓存文件大小,支持KVO More...
 
BOOL loop
 设置是否循环播放,支持KVO More...
 
AVPMirrorMode mirrorMode
 渲染镜像模式,支持KVO More...
 
BOOL muted
 设置是否静音,支持KVO More...
 
id< AliPlayerPictureInPictureDelegate > pictureInPictureDelegate
 设置画中画的回调。 More...
 
AVPView * playerView
 设置播放器的视图playerView AVPView: mac下为NSOpenGLView,iOS下为UIView More...
 
float rate
 播放速率,0.5-2.0之间,1为正常播放,支持KVO More...
 
id< CicadaRenderingDelegate > renderingDelegate
 设置渲染回调。 More...
 
AVPRotateMode rotateMode
 渲染旋转模式,支持KVO More...
 
int rotation
 获取视频的旋转角度,从metadata中获取出来,支持KVO More...
 
AVPScalingMode scalingMode
 渲染填充模式,支持KVO More...
 
float volume
 获取/设置播放器的音量(非系统音量),支持KVO,范围0.0~2.0,当音量大于1.0时,可能出现噪音,不推荐使用。 More...
 
int width
 获取视频的宽度,支持KVO More...
 

Additional Inherited Members

- Class Methods inherited from AliPlayer
(NSString *) + getDeviceUUID
 获取设备UUID More...
 
(NSString *) + getSDKVersion
 获取SDK版本号信息 More...
 
(void) + initPlayerComponent:function:
 初始化播放器组件。这些组件是可裁剪的。App可删除相应动态库,去掉初始化组件代码,实现裁剪。 More...
 
(BOOL) + isFeatureSupport:
 返回某项功能是否支持 More...
 
(void) + netWorkReConnect
 重连所有网络连接,网络路由发生变化后,调用此接口,可以让播放器所有的连接切换到新的路由上去。 More...
 
(void) + setAudioSessionDelegate:
 设置AudioSession的Delegate More...
 
(void) + setEnableLog:
 是否打开log输出 More...
 
(void) + setLogCallbackInfo:callbackBlock:
 设置日志打印回调block,异步 More...
 

Method Documentation

◆ addUrlSource:uid:

- (void) addUrlSource: (NSString *)  url
uid: (NSString *)  uid 

添加资源到播放列表中

Parameters
urlurl的播放方式
uid该资源的uid,代表在列表中的唯一标识

◆ addVidSource:uid:

- (void) addVidSource: (NSString *)  vid
uid: (NSString *)  uid 

添加资源到播放列表中

Parameters
vidvid的播放方式
uid该资源的uid,代表在列表中的唯一标识

◆ clear

- (void) clear

清除播放列表

◆ currentUid

- (NSString *) currentUid

获取当前播放资源的uid

◆ destroy

- (void) destroy

销毁播放器

Implements AliPlayer.

◆ init

- (instancetype) init

初始化播放列表

Implements AliPlayer.

◆ init:

- (instancetype) init: (NSString *)  traceID

初始化播放器

Parameters
traceID用于跟踪debug信息

Implements AliPlayer.

◆ moveTo:

- (BOOL) moveTo: (NSString *)  uid

移动到指定位置开始准备播放,url播放方式

Parameters
uid指定资源的uid,代表在列表中的唯一标识

◆ moveTo:accId:accKey:token:region:

- (BOOL) moveTo: (NSString *)  uid
accId: (NSString *)  accId
accKey: (NSString *)  accKey
token: (NSString *)  token
region: (NSString *)  region 

移动到指定位置开始准备播放,sts播放方式,需要更新sts信息

Parameters
uid指定资源的uid,代表在列表中的唯一标识
accIdvid sts播放方式的accessKeyID
accKeyvid sts播放方式的accessKeySecret
tokenvid sts播放方式的securtiToken
regionvid sts播放方式的region 默认cn-shanghai

◆ moveToNext

- (BOOL) moveToNext

当前位置移动到下一个进行准备播放,url播放方式

◆ moveToNext:accKey:token:region:

- (BOOL) moveToNext: (NSString *)  accId
accKey: (NSString *)  accKey
token: (NSString *)  token
region: (NSString *)  region 

当前位置移动到下一个进行准备播放,sts播放方式,需要更新sts信息

Parameters
accIdvid sts播放方式的accessKeyID
accKeyvid sts播放方式的accessKeySecret
tokenvid sts播放方式的securtiToken
regionvid sts播放方式的region 默认cn-shanghai

◆ moveToPre

- (BOOL) moveToPre

当前位置移动到上一个进行准备播放,url播放方式

◆ moveToPre:accKey:token:region:

- (BOOL) moveToPre: (NSString *)  accId
accKey: (NSString *)  accKey
token: (NSString *)  token
region: (NSString *)  region 

当前位置移动到上一个进行准备播放,sts播放方式,需要更新sts信息

Parameters
accIdvid sts播放方式的accessKeyID
accKeyvid sts播放方式的accessKeySecret
tokenvid sts播放方式的securtiToken
regionvid sts播放方式的region 默认cn-shanghai

◆ removeSource:

- (void) removeSource: (NSString *)  uid

从播放列表中删除指定资源

Parameters
uid该资源的uid,代表在列表中的唯一标识

◆ stop

- (void) stop

停止播放

Implements AliPlayer.

Property Documentation

◆ maxPreloadMemorySizeMB

- (int) maxPreloadMemorySizeMB
readwritenonatomicassign

设置最大的预缓存的内存大小,默认100M,最小20M

◆ preloadCount

- (int) preloadCount
readwritenonatomicassign

获取/设置预加载的个数,当前位置的前preloadCount和后preloadCount,默认preloadCount = 2

◆ stsPreloadDefinition

- (NSString*) stsPreloadDefinition
readwritenonatomiccopy

获取/设置列表播放的sts播放方式,指定默认的清晰度,如"LD、HD"等,moveTo之前调用,一旦预加载后不能更改


The documentation for this class was generated from the following file: