#include "AliPlayer.h"
◆ addExtSubtitle:
- (void) addExtSubtitle: |
|
(NSString *) | URL |
|
◆ clearScreen
◆ clearScreenSync
◆ destroy
◆ destroyAsync
异步销毁播放器。当实例不再需要时,省去stop的调用并使用destroyAsync进行异步释放,可以加快页面响应速度,提高体验,释放后不要再调用prepare进行新的起播,否则调用效果不可预知。
Implemented in AliListPlayer.
◆ enableDowngrade:config:
◆ getCacheFilePath:
- (NSString *) getCacheFilePath: |
|
(NSString *) | URL |
|
根据url获取缓存的文件名。如果有自定义的规则,请实现delegate onGetCacheNameByURL
。
如果没有实现delegate,将会采用默认逻辑生成文件名。
- Parameters
-
- 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
◆ getCurrentTrack:
◆ getDeviceUUID
+ (NSString *) getDeviceUUID |
|
|
|
◆ getMediaInfo
◆ getOption:
获取播放器的参数
- Parameters
-
- Returns
- 相关信息
◆ getPlayer
◆ getPlayerName
- (NSString *) getPlayerName |
|
|
|
◆ getPropertyString:
根据key获取相应的信息。
- Parameters
-
- Returns
- 相应信息(找不到相应信息返回空字符串)。
◆ getSDKVersion
+ (NSString *) getSDKVersion |
|
|
|
◆ getSubMediaInfo
◆ getThumbnail:
- (void) getThumbnail: |
|
(int64_t) | positionMs |
|
◆ getUserData
- (NSString *) getUserData |
|
|
|
◆ init
◆ init:
- (instancetype) init: |
|
(NSString *) | traceID |
|
◆ initPlayerComponent:function:
+ (void) initPlayerComponent: |
|
(NSString *) | functionName |
function: |
|
(void *) | function |
初始化播放器组件。这些组件是可裁剪的。App可删除相应动态库,去掉初始化组件代码,实现裁剪。
◆ invokeComponent:
- (int) invokeComponent: |
|
(NSString *) | content |
|
向播放器的组件发送命令。
- Parameters
-
- Returns
- 命令执行结果, < 0 失败。
◆ isFeatureSupport:
返回某项功能是否支持
- Parameters
-
type | 是否支持的功能的类型。 参考SupportFeatureType。 |
◆ netWorkReConnect
+ (void) netWorkReConnect |
|
|
|
重连所有网络连接,网络路由发生变化后,调用此接口,可以让播放器所有的连接切换到新的路由上去。
- Deprecated
◆ pause
◆ prepare
◆ redraw
◆ reload
◆ reset
◆ 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
-
◆ setAuthSource:
使用vid+playauth方式播放。可参考:https://help.aliyun.com/document_detail/57294.html
- Parameters
-
source | AVPVidAuthSource的输入类型 |
- See also
- AVPVidAuthSource
◆ setBitStreamSource:
◆ setCacheConfig:
设置缓存配置
- Parameters
-
- Returns
- 设置成功返回YES
◆ setConfig:
◆ setDefaultBandWidth:
- (void) setDefaultBandWidth: |
|
(int) | bandWidth |
|
设置多码率时默认播放的码率。将会选择与之最接近的一路流播放。
- Parameters
-
◆ setEnableLog:
+ (void) setEnableLog: |
|
(BOOL) | enableLog |
|
是否打开log输出
- Parameters
-
- See also
- 使用setLogCallbackInfo
◆ setEventReportParamsDelegate:
◆ setFilterConfig:
设置滤镜配置。在prepare之前调用此方法。如果想更新,调用updateFilterConfig()
- Parameters
-
◆ setFilterInvalid:invalid:
- (void) setFilterInvalid: |
|
(NSString *) | target |
invalid: |
|
(BOOL) | invalid |
开启关闭滤镜.
- Parameters
-
target | 如果为空,则对所有滤镜生效 |
invalid | true: 开启; false: 关闭 |
◆ setLiveStsSource:
使用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 |
◆ setLogOption:value:
+ (void) setLogOption: |
|
(AVPLogOption) | logOption |
value: |
|
(int) | value |
设置日志打印选项
- Parameters
-
logOption | logOption |
value | 选项value 0代表关闭 1代表打开 |
◆ setMaxAccurateSeekDelta:
- (void) setMaxAccurateSeekDelta: |
|
(int) | delta |
|
设置精准seek的最大间隔。
- Parameters
-
◆ setMpsSource:
用vid和MPS信息来播放视频。可参考:https://help.aliyun.com/document_detail/53522.html?spm=5176.doc53534.2.5.mhSfOh
- Parameters
-
source | AVPVidMpsSource的输入类型 |
- See also
- AVPVidMpsSource
◆ setOption:value:
- (void) setOption: |
|
(PlayerOption) | key |
value: |
|
(NSString *) | value |
◆ setOption:valueInt:
- (void) setOption: |
|
(PlayerOption) | key |
valueInt: |
|
(int) | value |
◆ setPictureinPictureDelegate:
◆ setPictureInPictureEnable:
- (void) setPictureInPictureEnable: |
|
(BOOL) | enable |
|
设置画中画功能开启/关闭 (目前播放器自带的画中画功能需要iOS15以上的系统,如果其他系统,可以通过播放器CicadaRenderingDelegate返回的pixelbuffer来自定义实现)
◆ setPictureInPictureShowMode:
◆ setPlayUrlConvertCallback:
设置转换播放的url的回调函数,一般用于p2p中的url地址转换
- Parameters
-
◆ setPreferPlayerName:
- (void) setPreferPlayerName: |
|
(NSString *) | name |
|
◆ setStartTime:seekMode:
- (void) setStartTime: |
|
(int64_t) | time |
seekMode: |
|
(AVPSeekMode) | seekMode |
以指定位置起播,每次prepare前调用,仅生效一次。(用于代替原先的起播前seek的方案)
- Parameters
-
time | 新的播放位置,单位毫秒 |
seekMode | seek模式 |
- See also
- AVPSeekMode
◆ setStreamDelayTime:time:
- (void) setStreamDelayTime: |
|
(int) | index |
time: |
|
(int) | time |
设置某路流相对于主时钟的延时时间,默认是0, 目前只支持外挂字幕
- Parameters
-
◆ setStsSource:
用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 |
|
◆ setTraceID:
- (void) setTraceID: |
|
(NSString *) | traceID |
|
◆ setUrlSource:
◆ setUserData:
- (void) setUserData: |
|
(NSString *) | userData |
|
设置UserData,用于一些全局API的透传,以区分player实例。
◆ setVerifyStsCallback:
设置校验AVPStsInfo是否过期回调
- Parameters
-
◆ setVideoTag:size:
- (void) setVideoTag: |
|
(int *) | tags |
size: |
|
(int) | size |
◆ snapShot
截图 AVPImage: mac平台返回NSImage,iOS平台返回UIImage
◆ start
◆ stop
◆ switchStream:
- (void) switchStream: |
|
(NSString *) | URL |
|
根据url进行多清晰度切换,选择成功与否的结果通过AVPDelegate onStreamSwitchedSuccess/onStreamSwitchedFail回调。 注意:
- 必须是阿里云的直播地址。
- 必须是直播流的不同清晰度。
- 切换到无关流地址可能会失败。
- Parameters
-
◆ updateFilterConfig:options:
- (void) updateFilterConfig: |
|
(NSString *) | target |
options: |
|
(AVPFilterOptions *) | options |
◆ updateLiveStsInfo:accKey:token:region:
- (void) updateLiveStsInfo: |
|
(NSString *) | accId |
accKey: |
|
(NSString *) | accKey |
token: |
|
(NSString *) | token |
region: |
|
(NSString *) | region |
◆ __deprecated
- (id<CicadaRenderDelegate> renderDelegate) __deprecated |
|
readwritenonatomicweak |
设置渲染回调。废弃,使用renderingDelegate。
◆ alphaRenderMode
◆ autoPlay
◆ bufferedPosition
- (int64_t) bufferedPosition |
|
readnonatomicassign |
◆ currentDownloadSpeed
- (int64_t) currentDownloadSpeed |
|
readnonatomicassign |
◆ currentPosition
- (int64_t) currentPosition |
|
readnonatomicassign |
◆ currentUtcTime
- (int64_t) currentUtcTime |
|
readnonatomicassign |
◆ delegate
◆ duration
◆ enableHardwareDecoder
- (BOOL) enableHardwareDecoder |
|
readwritenonatomicassign |
◆ eventReportParamsDelegate
◆ height
◆ localCacheLoadedSize
- (int64_t) localCacheLoadedSize |
|
readnonatomicassign |
◆ loop
◆ mirrorMode
◆ muted
◆ outputAudioChannel
◆ playerStatus
◆ playerView
设置播放器的视图playerView AVPView: mac下为NSOpenGLView,iOS下为UIView
◆ rate
播放速率,0.5-2.0之间,1为正常播放,支持KVO
◆ renderingDelegate
- (id<CicadaRenderingDelegate>) renderingDelegate |
|
readwritenonatomicweak |
◆ rotateMode
◆ rotation
获取视频的旋转角度,从metadata中获取出来,支持KVO
◆ scalingMode
◆ volume
获取/设置播放器的音量(非系统音量),支持KVO,范围0.0~2.0,当音量大于1.0时,可能出现噪音,不推荐使用。
◆ width
The documentation for this class was generated from the following file: