Inheritance diagram for AliPlayer:

Instance Methods
(void)	- addExtSubtitle:
	添加外挂字幕。 More...

(void)	- clearScreen
	清空画面。 More...

(void)	- DEPRECATED_ATTRIBUTE
	重置播放 More...

("will not take effect")	- DEPRECATED_MSG_ATTRIBUTE
	刷新view，例如view size变化时。 More...

(void)	- destroy
	销毁播放器 More...

(NSString *)	- getCacheFilePath:
	根据url获取缓存的文件名。如果有自定义的规则，请实现delegate onGetCacheNameByURL。 More...

(NSString *)	- getCacheFilePath:format:definition:
	根据url获取缓存的文件名。如果有自定义的规则，请实现delegate onCacheNameByVidCallback。 More...

(NSString *)	- getCacheFilePath:format:definition:previewTime:
	根据url获取缓存的文件名。如果有自定义的规则，请实现delegate onCacheNameByVidCallback。 More...

(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)	- reload
	重新加载。比如网络超时时，可以重新加载。 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)	- 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...

Class Methods
(NSString *)	+ getDeviceUUID
	获取设备UUID More...

(NSString *)	+ getSDKVersion
	获取SDK版本号信息 More...

(void)	+ initPlayerComponent:function:
	初始化播放器组件。这些组件是可裁剪的。App可删除相应动态库，去掉初始化组件代码，实现裁剪。 More...

(void)	+ netWorkReConnect
	重连所有网络连接，网络路由发生变化后，调用此接口，可以让播放器所有的连接切换到新的路由上去。 More...

(void)	+ setAudioSessionDelegate:
	设置AudioSession的Delegate More...

(void)	+ setEnableLog:
	是否打开log输出 More...

(void)	+ setLogCallbackInfo:callbackBlock:
	设置日志打印回调block，异步 More...

Properties
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< AVPDelegate >	delegate
	设置代理，参考AVPDelegate More...

int64_t	duration
	获取视频的长度，支持KVO More...

BOOL	enableHardwareDecoder
	是否开启硬件解码，支持KVO More...

id< AVPEventReportParamsDelegate >	eventReportParamsDelegate
	设置埋点事件回调。 More...

int	height
	获取视频的高度，支持KVO More...

int64_t	localCacheLoadedSize
	获取当前播放命中的缓存文件大小，支持KVO More...

BOOL	loop
	设置是否循环播放，支持KVO More...

AVPMirrorMode	mirrorMode
	渲染镜像模式，支持KVO More...

BOOL	muted
	设置是否静音，支持KVO 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...

Method Documentation

◆ addExtSubtitle:

- (void) addExtSubtitle: (NSString *) URL

添加外挂字幕。

Parameters

URL 字幕地址

◆ clearScreen

- (void) clearScreen

清空画面。

◆ DEPRECATED_ATTRIBUTE

- (void) DEPRECATED_ATTRIBUTE

重置播放

◆ DEPRECATED_MSG_ATTRIBUTE

- ("will not take effect") DEPRECATED_MSG_ATTRIBUTE

刷新view，例如view size变化时。

◆ destroy

- (void) destroy

销毁播放器

Implemented in AliListPlayer.

◆ getCacheFilePath:

- (NSString *) getCacheFilePath: (NSString *) URL

根据url获取缓存的文件名。如果有自定义的规则，请实现delegate onGetCacheNameByURL。

如果没有实现delegate，将会采用默认逻辑生成文件名。

Parameters

URL URL

Returns: 最终缓存的文件名（不包括后缀。缓存文件的后缀名统一为.alv）。

◆ getCacheFilePath:format:definition:

- (NSString *) getCacheFilePath:	(NSString *)	vid
format:	(NSString *)	format
definition:	(NSString *)	definition

根据url获取缓存的文件名。如果有自定义的规则，请实现delegate onCacheNameByVidCallback。

如果没有实现delegate，将会采用默认逻辑生成文件名。

Parameters

vid	视频id
format	视频格式
definition	视频清晰度

Returns: 最终缓存的文件名（不包括后缀。缓存文件的后缀名统一为.alv）。

◆ getCacheFilePath:format:definition:previewTime:

- (NSString *) getCacheFilePath:	(NSString *)	vid
format:	(NSString *)	format
definition:	(NSString *)	definition
previewTime:	(int)	previewTime

根据url获取缓存的文件名。如果有自定义的规则，请实现delegate onCacheNameByVidCallback。

如果没有实现delegate，将会采用默认逻辑生成文件名。

Parameters

vid	视频id
format	视频格式
definition	视频清晰度
previewTime	试看时长

Returns: 最终缓存的文件名（不包括后缀。缓存文件的后缀名统一为.alv）。

◆ getConfig

- (AVPConfig*) getConfig

获取播放器设置

See also: AVPConfig

◆ getCurrentTrack:

- (AVPTrackInfo*) getCurrentTrack: (AVPTrackType) type

获取当前播放track

Parameters

type track类型

See also: AVPTrackType

◆ getDeviceUUID

+ (NSString *) getDeviceUUID

获取设备UUID

◆ getMediaInfo

- (AVPMediaInfo*) getMediaInfo

获取媒体信息，包括track信息

◆ getOption:

- (NSString *) getOption: (AVPOption) key

获取播放器的参数

Parameters

key 参数值

Returns: 相关信息

◆ getPlayer

- (void *) getPlayer

◆ getPlayerName

- (NSString *) getPlayerName

获取播放时使用的播放器名字

◆ getPropertyString:

- (NSString *) getPropertyString: (AVPPropertyKey) key

根据key获取相应的信息。

Parameters

key 关键字枚举值

Returns: 相应信息（找不到相应信息返回空字符串）。

◆ getSDKVersion

+ (NSString*) getSDKVersion

获取SDK版本号信息

◆ getThumbnail:

- (void) getThumbnail: (int64_t) positionMs

获取指定位置的缩略图

Parameters

positionMs 代表在哪个指定位置的缩略图

◆ init

- (instancetype) init

初始化播放器

Implemented in AliListPlayer.

◆ init:

- (instancetype) init: (NSString *) traceID

初始化播放器

Parameters

traceID 便于跟踪日志，设为"DisableAnalytics"可关闭日志分析系统（不推荐）。

Implemented in AliListPlayer.

◆ initPlayerComponent:function:

+ (void) initPlayerComponent:	(NSString *)	functionName
function:	(void *)	function

初始化播放器组件。这些组件是可裁剪的。App可删除相应动态库，去掉初始化组件代码，实现裁剪。

◆ invokeComponent:

- (int) invokeComponent: (NSString *) content

向播放器的组件发送命令。

Parameters

content 命令内容。

Returns: 命令执行结果， < 0 失败。

◆ netWorkReConnect

+ (void) netWorkReConnect

重连所有网络连接，网络路由发生变化后，调用此接口，可以让播放器所有的连接切换到新的路由上去。

◆ pause

- (void) pause

暂停播放

◆ prepare

- (void) prepare

播放准备，异步

◆ reload

- (void) reload

重新加载。比如网络超时时，可以重新加载。

◆ seekToTime:seekMode:

- (void) seekToTime:	(int64_t)	time
seekMode:	(AVPSeekMode)	seekMode

跳转到指定的播放位置

Parameters

time	新的播放位置，单位毫秒
seekMode	seek模式

See also: AVPSeekMode

◆ selectExtSubtitle:enable:

- (void) selectExtSubtitle:	(int)	trackIndex
enable:	(BOOL)	enable

选择外挂字幕

Parameters

trackIndex	字幕索引
enable	true：选择，false：关闭

◆ selectTrack:

- (void) selectTrack: (int) trackIndex

根据trackIndex，切换清晰度

Parameters

trackIndex 选择清晰度的index，SELECT_AVPTRACK_TYPE_VIDEO_AUTO代表自适应码率

◆ selectTrack:accurate:

- (void) selectTrack:	(int)	trackIndex
accurate:	(BOOL)	accurate

根据trackIndex，切换清晰度

Parameters

trackIndex	选择清晰度的index，SELECT_AVPTRACK_TYPE_VIDEO_AUTO代表自适应码率
accurate	是否精准跳转。

◆ sendCustomEvent:

- (void) sendCustomEvent: (NSString *) args

发送用户自定义事件，将通过AVPEventReportParamsDelegate回调。事件 e = 5001。

◆ setAudioSessionDelegate:

+ (void) setAudioSessionDelegate: (id< CicadaAudioSessionDelegate >) delegate

设置AudioSession的Delegate

Parameters

delegate Delegate对象

◆ setAuthSource:

- (void) setAuthSource: (AVPVidAuthSource *) source

使用vid+playauth方式播放。可参考：https://help.aliyun.com/document_detail/57294.html

Parameters

source AVPVidAuthSource的输入类型

See also: AVPVidAuthSource

◆ setBitStreamSource:

- (void) setBitStreamSource: (AVPBitStreamSource *) source

使用bitstream方式来播放视频

Parameters

source AVPBitStreamSource的输入类型

See also: AVPBitStreamSource

◆ setCacheConfig:

- (BOOL) setCacheConfig: (AVPCacheConfig *) cacheConfig

设置缓存配置

Parameters

AVPCacheConfig 缓存配置。AVPCacheConfig。

Returns: 设置成功返回YES

◆ setConfig:

- (void) setConfig: (AVPConfig *) config

播放器设置

Parameters

config AVPConfig类型

See also: AVPConfig

◆ setDefaultBandWidth:

- (void) setDefaultBandWidth: (int) bandWidth

设置多码率时默认播放的码率。将会选择与之最接近的一路流播放。

Parameters

bandWidth 播放的码率。

◆ setEnableLog:

+ (void) setEnableLog: (BOOL) enableLog

是否打开log输出

Parameters

enableLog true表示输出log

See also: 使用setLogCallbackInfo

◆ setEventReportParamsDelegate:

- (void) setEventReportParamsDelegate: (id< AVPEventReportParamsDelegate >) delegate

设置代理参考AVPEventReportParamsDelegate

See also: AVPEventReportParamsDelegate

◆ setFilterConfig:

- (void) setFilterConfig: (AVPFilterConfig *) filterConfig

设置滤镜配置。在prepare之前调用此方法。如果想更新，调用updateFilterConfig()

Parameters

filterConfig

◆ setFilterInvalid:invalid:

- (void) setFilterInvalid:	(NSString *)	target
invalid:	(BOOL)	invalid

开启关闭滤镜.

Parameters

target	如果为空，则对所有滤镜生效
invalid	true: 开启; false: 关闭

◆ setLiveStsSource:

- (void) setLiveStsSource: (AVPLiveStsSource *) source

使用LiveSts 方式播放直播流

Parameters

source AVPLiveStsSource的输入类型

◆ setLogCallbackInfo:callbackBlock:

+ (void) setLogCallbackInfo:	(AVPLogLevel)	logLevel
callbackBlock:	(void(^)(AVPLogLevel logLevel, NSString *strLog))	block

设置日志打印回调block，异步

Parameters

logLevel	log输出级别
callbackBlock	log回调block，可以为nil

◆ setMaxAccurateSeekDelta:

- (void) setMaxAccurateSeekDelta: (int) delta

设置精准seek的最大间隔。

Parameters

delta 间隔时间，单位毫秒

◆ setMpsSource:

- (void) setMpsSource: (AVPVidMpsSource *) source

用vid和MPS信息来播放视频。可参考：https://help.aliyun.com/document_detail/53522.html?spm=5176.doc53534.2.5.mhSfOh

Parameters

source AVPVidMpsSource的输入类型

See also: AVPVidMpsSource

◆ setPlayUrlConvertCallback:

- (void) setPlayUrlConvertCallback: (PlayURLConverCallback) callback

设置转换播放的url的回调函数，一般用于p2p中的url地址转换

Parameters

callback 回调函数指针

◆ setPreferPlayerName:

- (void) setPreferPlayerName: (NSString *) name

设置期望使用的播放器名字。

Parameters

name	期望使用的播放器名字

◆ setStreamDelayTime:time:

- (void) setStreamDelayTime:	(int)	index
time:	(int)	time

设置某路流相对于主时钟的延时时间，默认是0, 目前只支持外挂字幕

Parameters

index	流的索引
time	延时，单位毫秒

◆ setStsSource:

- (void) setStsSource: (AVPVidStsSource *) source

用vid和sts来播放视频，sts可参考：https://help.aliyun.com/document_detail/28756.html?spm=a2c4g.11186623.4.4.6f554c07q7B7aS

Parameters

source AVPVidStsSource的输入类型

See also: AVPVidStsSource

◆ setThumbnailUrl:

- (void) setThumbnailUrl: (NSString *) URL

设置缩略图URL

Parameters

URL 缩略图URL

◆ setTraceID:

- (void) setTraceID: (NSString *) traceID

用于跟踪debug信息

Parameters

traceID 指定和其他客户端连接可跟踪的id

◆ setUrlSource:

- (void) setUrlSource: (AVPUrlSource *) source

使用url方式来播放视频

Parameters

source AVPUrlSource的输入类型

See also: AVPUrlSource

◆ setVerifyStsCallback:

- (void) setVerifyStsCallback: (AVPStsStatus(^)(AVPStsInfo info)) callback

设置校验AVPStsInfo是否过期回调

Parameters

callback

◆ setVideoTag:size:

- (void) setVideoTag:	(int *)	tags
size:	(int)	size

设置视频标签。值范围[0,99]。

◆ snapShot

- (void) snapShot

截图 AVPImage: mac平台返回NSImage，iOS平台返回UIImage

◆ start

- (void) start

开始播放

Implemented in AVPLiveTimeShift.

◆ stop

- (void) stop

停止播放

Implemented in AVPLiveTimeShift, and AliListPlayer.

◆ updateFilterConfig:options:

- (void) updateFilterConfig:	(NSString *)	target
options:	(AVPFilterOptions *)	options

更新滤镜配置

Parameters

target
options

◆ updateLiveStsInfo:accKey:token:region:

- (void) updateLiveStsInfo:	(NSString *)	accId
accKey:	(NSString *)	accKey
token:	(NSString *)	token
region:	(NSString *)	region

更新LiveSts信息

Property Documentation

◆ __deprecated

- (id<CicadaRenderDelegate> renderDelegate) __deprecated

readwritenonatomicweak

设置渲染回调。废弃，使用renderingDelegate。

◆ autoPlay

- (BOOL) autoPlay

readwritenonatomicassign

设置是否自动播放，支持KVO

◆ bufferedPosition

- (int64_t) bufferedPosition

readnonatomicassign

获取已经缓存的位置，支持KVO

◆ currentDownloadSpeed

- (int64_t) currentDownloadSpeed

readnonatomicassign

获取当前下载速度，支持KVO

◆ currentPosition

- (int64_t) currentPosition

readnonatomicassign

获取当前播放位置，支持KVO

◆ currentUtcTime

- (int64_t) currentUtcTime

readnonatomicassign

获取当前播放位置的utc时间，支持KVO

◆ delegate

- (id<AVPDelegate>) delegate

readwritenonatomicweak

设置代理，参考AVPDelegate

See also: AVPDelegate

◆ duration

- (int64_t) duration

readnonatomicassign

获取视频的长度，支持KVO

◆ enableHardwareDecoder

- (BOOL) enableHardwareDecoder

readwritenonatomicassign

是否开启硬件解码，支持KVO

◆ eventReportParamsDelegate

- (id<AVPEventReportParamsDelegate>) eventReportParamsDelegate

readwritenonatomicweak

设置埋点事件回调。

◆ height

- (int) height

readnonatomicassign

获取视频的高度，支持KVO

◆ localCacheLoadedSize

- (int64_t) localCacheLoadedSize

readnonatomicassign

获取当前播放命中的缓存文件大小，支持KVO

◆ loop

- (BOOL) loop

readwritenonatomicassign

设置是否循环播放，支持KVO

◆ mirrorMode

- (AVPMirrorMode) mirrorMode

readwritenonatomicassign

渲染镜像模式，支持KVO

See also: AVPMirrorMode

◆ muted

- (BOOL) muted

readwritenonatomicassign

设置是否静音，支持KVO

◆ playerView

- (AVPView*) playerView

readwritenonatomicstrong

设置播放器的视图playerView AVPView: mac下为NSOpenGLView，iOS下为UIView

◆ rate

- (float) rate

readwritenonatomicassign

播放速率，0.5-2.0之间，1为正常播放，支持KVO

◆ renderingDelegate

- (id<CicadaRenderingDelegate>) renderingDelegate

readwritenonatomicweak

设置渲染回调。

◆ rotateMode

- (AVPRotateMode) rotateMode

readwritenonatomicassign

渲染旋转模式，支持KVO

See also: AVPRotateMode

◆ rotation

- (int) rotation

readnonatomicassign

获取视频的旋转角度，从metadata中获取出来，支持KVO

◆ scalingMode

- (AVPScalingMode) scalingMode

readwritenonatomicassign

渲染填充模式，支持KVO

See also: AVPScalingMode

◆ volume

- (float) volume

readwritenonatomicassign

获取/设置播放器的音量（非系统音量），支持KVO，范围0.0~2.0，当音量大于1.0时，可能出现噪音，不推荐使用。

◆ width

- (int) width

readnonatomicassign

获取视频的宽度，支持KVO

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

AliPlayer.h

Instance Methods

Class Methods

Properties

Method Documentation

◆ addExtSubtitle:

◆ clearScreen

◆ DEPRECATED_ATTRIBUTE

◆ DEPRECATED_MSG_ATTRIBUTE

◆ destroy

◆ getCacheFilePath:

◆ getCacheFilePath:format:definition:

◆ getCacheFilePath:format:definition:previewTime:

◆ getConfig

◆ getCurrentTrack:

◆ getDeviceUUID

◆ getMediaInfo

◆ getOption:

◆ getPlayer

◆ getPlayerName

◆ getPropertyString:

◆ getSDKVersion

◆ getThumbnail:

◆ init

◆ init:

◆ initPlayerComponent:function:

◆ invokeComponent:

◆ netWorkReConnect

◆ pause

◆ prepare

◆ reload

◆ seekToTime:seekMode:

◆ selectExtSubtitle:enable:

◆ selectTrack:

◆ selectTrack:accurate:

◆ sendCustomEvent:

◆ setAudioSessionDelegate:

◆ setAuthSource:

◆ setBitStreamSource:

◆ setCacheConfig:

◆ setConfig:

◆ setDefaultBandWidth:

◆ setEnableLog:

◆ setEventReportParamsDelegate:

◆ setFilterConfig:

◆ setFilterInvalid:invalid:

◆ setLiveStsSource:

◆ setLogCallbackInfo:callbackBlock:

◆ setMaxAccurateSeekDelta:

◆ setMpsSource:

◆ setPlayUrlConvertCallback:

◆ setPreferPlayerName:

◆ setStreamDelayTime:time:

◆ setStsSource:

◆ setThumbnailUrl:

◆ setTraceID:

◆ setUrlSource:

◆ setVerifyStsCallback:

◆ setVideoTag:size:

◆ snapShot

◆ start

◆ stop

◆ updateFilterConfig:options:

◆ updateLiveStsInfo:accKey:token:region:

Property Documentation

◆ __deprecated

◆ autoPlay

◆ bufferedPosition

◆ currentDownloadSpeed

◆ currentPosition

◆ currentUtcTime

◆ delegate

◆ duration

◆ enableHardwareDecoder

◆ eventReportParamsDelegate

◆ height

◆ localCacheLoadedSize

◆ loop

◆ mirrorMode

◆ muted

◆ playerView