AliVRPlayer Class Reference

#include "AliVRPlayer.h"

Inheritance diagram for AliVRPlayer:

Instance Methods
(void)	- handlePanGesture:
	通过手势控制vr播放器的角度
(instancetype)	- init
	初始化播放器
(instancetype)	- init:
	初始化播放器
(void)	- resetGestureAngle
	重设播放器VR的手势角度
(void)	- rotateVRSceneWithX:andY:
	设置VR播放器旋转的角度
(void)	- setDisplayMode:
	设置VR播放器的展示方式
(void)	- setFovDegrees:
	设置缩放
(void)	- setInteractionOptions:enabled:
	设置VR播放器的交互类型为开启或者关闭
(void)	- setVideoBackgroundColor:
	设置播放器VR视频背景色
(void)	- setVRDelegate:
	设置播放器VR代理，用来接收 回调信息或进行代理操作
(void)	- setVRDisplayContentsWithImage:
	设置播放器显示全景图
(void)	- setVRPlayerType:
	设置播放器VR处理器类型
(void)	- setVRSceneRotate:
	设置VR播放器场景的旋转
(void)	- setVRSceneScale:
	设置VR播放器的放大倍数
Instance Methods inherited from AliPlayer
(void)	- addExtSubtitle:
	添加外挂字幕文件。支持多种字幕格式，如SRT、ASS、VTT等。
(void)	- clearScreen
	清空画面。
(void)	- clearScreenSync
	同步清空画面。
(void)	- destroy
	同步销毁播放器
(void)	- destroyAsync
	异步销毁播放器。当实例不再需要时，省去stop的调用并使用destroyAsync进行异步释放，可以加快页面响应速度，提高体验，释放后不要再调用prepare进行新的起播，否则调用效果不可预知。
(void)	- enableDowngrade:config:
	播放器降级设置
(NSString *)	- getCacheFilePath:
	根据url获取缓存的文件名。如果有自定义的规则，请实现delegate onGetCacheNameByURL。
(NSString *)	- getCacheFilePath:format:definition:
	根据url获取缓存的文件名。如果有自定义的规则，请实现delegate onCacheNameByVidCallback。
(NSString *)	- getCacheFilePath:format:definition:previewTime:
	根据url获取缓存的文件名。如果有自定义的规则，请实现delegate onCacheNameByVidCallback。
(AVPConfig *)	- getConfig
	获取播放器设置
(AVPTrackInfo *)	- getCurrentTrack:
	获取当前播放track
(AVPMediaInfo *)	- getMediaInfo
	获取媒体信息，包括track信息
(NSString *)	- getOption:
	获取播放器的参数
(int64_t)	- getPlayedDuration
	@breif 获取当前播放时长，不受seek的影响
(void *)	- getPlayer
(NSString *)	- getPlayerName
	获取播放时使用的播放器名字
(NSString *)	- getPropertyString:
	根据key获取相应的信息。
(AVPMediaInfo *)	- getSubMediaInfo
	获取媒体子流信息，包括track信息
(void)	- getThumbnail:
	获取指定位置的缩略图
(NSString *)	- getUserData
	获取UserData，一个实例绑定一个。
(int)	- invokeComponent:
	向播放器的组件发送命令。
(BOOL)	- isAutoBandWidth
	获取当前是否开启了多码率播放时自适应选择起播清晰度的功能状态。
(BOOL)	- isEnableSubtitleRender
(void)	- pause
	暂停播放
(void)	- prepare
	播放准备，异步
(void)	- redraw
	刷新view，例如view size变化时。
(void)	- reload
	重新加载。比如网络超时时，可以重新加载。
(void)	- reset
	重置播放
(void)	- seekToTime:seekMode:
	跳转到指定的播放位置
(void)	- selectExtSubtitle:enable:
	选择或关闭指定的外挂字幕轨道。
(void)	- selectTrack:
	根据轨道索引切换视频清晰度。支持手动指定清晰度或开启自适应码率模式。
(void)	- selectTrack:accurate:
	根据轨道索引切换视频清晰度，支持精准跳转选项。
(void)	- sendCustomEvent:
	发送用户自定义事件，将通过AVPEventReportParamsDelegate 回调，用于将业务事件/埋点统一走播放器的埋点回调，方便业务统一流程。用户自定义事件 e = 5001，args为透传的参数。
(void)	- setAuthSource:
	使用vid+playauth方式播放。可参考：https://help.aliyun.com/document_detail/57294.html
(void)	- setAutoBandWidth:
	设置多码率播放时是否开启自适应选择起播清晰度功能。注意：该接口仅影响起播时的清晰度选择，起播后不会动态调整清晰度。可通过AVPConfig.maxAllowedAbrVideoPixelNumber限制自适应选择的最大清晰度。
(void)	- setBitStreamSource:
	使用bitstream方式来播放视频
(BOOL)	- setCacheConfig:
	设置缓存配置
(void)	- setConfig:
	播放器设置
(void)	- setDefaultBandWidth:
	设置多码率播放时的默认起播码率。播放器将选择与指定码率最接近的流进行播放。
(void)	- setDefaultResolution:
	设置多码率播放时的默认起播清晰度。通过分辨率乘积值选择最接近的清晰度流进行播放。
(void)	- setEnableSubtitleRender:
	是否关闭字幕渲染
(void)	- setEventReportParamsDelegate:
	设置代理 参考AVPEventReportParamsDelegate
(void)	- setFilterConfig:
	设置滤镜配置。在prepare之前调用此方法。如果想更新，调用updateFilterConfig()
(void)	- setFilterInvalid:invalid:
	开启关闭滤镜.
(void)	- setLiveStsSource:
	使用LiveSts 方式播放直播流
(void)	- setMaxAccurateSeekDelta:
	设置精准seek的最大间隔。
(void)	- setMpsSource:
	用vid和MPS信息来播放视频。可参考：https://help.aliyun.com/document_detail/53522.html
(void)	- setOption:value:
	设置特定功能选项。
(void)	- setOption:valueInt:
	设置特定功能选项。
(void)	- setPictureinPictureDelegate:
	为画中画功能设置代理
(void)	- setPictureInPictureEnable:
	设置画中画功能开启/关闭 (目前播放器自带的画中画功能需要iOS15以上的系统，如果其他系统，可以通过播放器CicadaRenderingDelegate返回的pixelbuffer来自定义实现)
(void)	- setPictureInPictureShowMode:
	为画中画功能设置显示模式
(void)	- setPlayerScene:
	设置播放器场景
(void)	- setPlayUrlConvertCallback:
	设置转换播放的url的回调函数，一般用于p2p中的url地址转换
(void)	- setPreferPlayerName:
	设置播放时选择的播放器内核，默认为自研内核，可切换至系统内核，调用prepare前设置。
(void)	- setStartTime:seekMode:
	以指定位置起播，每次prepare前调用，仅生效一次。（用于代替原先的起播前seek的方案）
(void)	- setStreamDelayTime:time:
	设置某路流相对于主时钟的延时时间，默认是0, 目前只支持外挂字幕
(void)	- setStsSource:
	用vid和sts来播放视频，sts可参考：https://help.aliyun.com/document_detail/28756.html
(void)	- setThumbnailUrl:
	设置缩略图URL
(void)	- setTraceID:
	用于跟踪debug信息
(void)	- setUrlSource:
	使用url方式来播放视频
(void)	- setUserData:
	设置player实例的UserData，多实例下可用于区分不同的player实例，可通过AliPlayer::getUserData获取到。
(void)	- setVerifyStsCallback:
	加密直播播放过程中可能会有更换加密Key的过程，换Key时则会通过STS去请求到最新的Key。开发者需要监听STS是否有效。如果无效则会影响加密直播流的播放。获取STS成功之后，需要调用updateLiveStsInfo方法去更新。
(void)	- setVideoTag:size:
	设置视频标签。值范围[0,99]。
(void)	- snapShot
	截取当前画面。截图结果通过AVPDelegate::onCaptureScreen回调。
(void)	- start
	开始播放
(void)	- stop
	停止播放
(void)	- switchStream:
	根据url进行多清晰度切换，选择成功与否的结果通过AVPDelegate onStreamSwitchedSuccess/onStreamSwitchedFail回调。 注意：
(void)	- updateFilterConfig:options:
	更新滤镜配置
(void)	- updateLiveStsInfo:accKey:token:region:
	更新LiveStsInfo

Additional Inherited Members
Class Methods inherited from AliPlayer
(NSString *)	+ getDeviceUUID
	获取设备UUID
(NSString *)	+ getSDKVersion
	获取SDK版本号信息
(void)	+ initPlayerComponent:function:
	初始化播放器组件。这些组件是可裁剪的。App可删除相应动态库，去掉初始化组件代码，实现裁剪。
(BOOL)	+ isFeatureSupport:
	返回某项功能是否支持
(void)	+ netWorkReConnect
	重连所有网络连接，网络路由发生变化后，调用此接口，可以让播放器所有的连接切换到新的路由上去。
(void)	+ setAudioSessionDelegate:
	设置AudioSession的Delegate
(void)	+ setEnableLog:
	是否打开log输出
(void)	+ setLogCallbackInfo:callbackBlock:
	设置日志打印回调block，异步
(void)	+ setLogOption:value:
	设置日志打印选项
Properties inherited from AliPlayer
id< CicadaRenderDelegate > renderDelegate	__deprecated
	设置渲染回调。废弃，使用renderingDelegate。
AVPAlphaRenderMode	alphaRenderMode
	设置透明渲染模式，支持如直播礼物播放等场景。详细用法参考：doc
BOOL	autoPlay
	设置是否自动播放，支持KVO
int64_t	bufferedPosition
	获取已经缓存的位置，支持KVO
int64_t	currentDownloadSpeed
	获取当前下载速度，支持KVO
int64_t	currentPosition
	获取当前播放位置，支持KVO
int64_t	currentUtcTime
	获取当前播放位置的utc时间，支持KVO
id< AVPDelegate >	delegate
	设置代理，参考AVPDelegate
id< AVPDrmDelegate >	drmDelegate
	设置DRM的请求回调，该回调只会在通过URLsetUrlSource起播时会触发，通过VidAuth、VidSts不会触发，目前只支持Fairplay。
int64_t	duration
	获取视频的长度，支持KVO
BOOL	enableHardwareDecoder
	是否启用硬解码，默认开启。 失败后降级软解，若设置了自适应降级AliPlayerGlobalSettings::setAdaptiveDecoderGetBackupURLCallback ，可降级播放不同编码的视频，如H265->H264。
id< AVPEventReportParamsDelegate >	eventReportParamsDelegate
	设置埋点事件回调。
int	height
	获取视频的高度，支持KVO
int64_t	localCacheLoadedSize
	获取当前播放命中的缓存文件大小，支持KVO
BOOL	loop
	设置是否循环播放，支持KVO
AVPMirrorMode	mirrorMode
	渲染镜像模式，支持KVO
BOOL	muted
	设置是否静音，支持KVO
AVPOutputAudioChannel	outputAudioChannel
	设置输出声道，若输入源是双声道，则支持切换为左声道、右声道；若输入源是单声道，则设置无效。该设置会同时影响音频渲染及PCM数据回调
AVPStatus	playerStatus
	获取播放器状态，支持KVO
AVPView *	playerView
	设置播放器的视图playerView AVPView: mac下为NSOpenGLView，iOS下为UIView
float	rate
	播放速率，0.5-2.0之间，1为正常播放，支持KVO
id< CicadaRenderingDelegate >	renderingDelegate
	设置渲染回调。
AVPRotateMode	rotateMode
	渲染旋转模式，支持KVO
int	rotation
	获取视频的旋转角度，从metadata中获取出来，支持KVO
AVPScalingMode	scalingMode
	渲染填充模式，支持KVO
float	volume
	获取/设置播放器的音量（非系统音量），支持KVO，范围0.0~2.0，当音量大于1.0时，可能出现噪音，不推荐使用。
int	width
	获取视频的宽度，支持KVO

Method Documentation

handlePanGesture:

- (void) handlePanGesture:

(UIPanGestureRecognizer *)

paramSender

通过手势控制vr播放器的角度

Parameters

paramSender

滑动手势

Set VRPlayer rotate radians with axis

Parameters

paramSender

Pan Gesture

init

- (instancetype) init

初始化播放器

Initialize the player.

Implements AliPlayer.

init:

- (instancetype) init:

(NSString *)

traceID

初始化播放器

Parameters

traceID

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

Initialize the player.

Parameters

traceID

A trace ID for debugging. Set as "DisableAnalytics" to disable report analytics data to server(not recommended).

Implements AliPlayer.

resetGestureAngle

- (void) resetGestureAngle

重设播放器VR的手势角度

reset VR gesture angle

rotateVRSceneWithX:andY:

- (void) rotateVRSceneWithX:		(CGFloat)	x
andY:		(CGFloat)	y

设置VR播放器旋转的角度

Parameters

x	x轴旋转的角度
y	y轴旋转的角度

Set VRPlayer rotate radians with axis

Parameters

x	radians of rotate on x axis
y	radians of rotate on y axis

setDisplayMode:

- (void) setDisplayMode:

(AliVRPlayerViewDisplayMode)

displayMode

设置VR播放器的展示方式

Parameters

displayMode

AliVRPlayerViewDisplayMode360 or AliVRPlayerViewDisplayModeGlass，默认值为 AliVRPlayerViewDisplayMode360

Set VRPlayer display mode (AliVRPlayerViewDisplayMode360 or AliVRPlayerViewDisplayModeGlass)

Parameters

displayMode

AliVRPlayerViewDisplayMode360 or AliVRPlayerViewDisplayModeGlass (Default value is AliVRPlayerViewDisplayMode360)

setFovDegrees:

- (void) setFovDegrees:

(CGFloat)

degrees

设置缩放

Parameters

degrees

缩放程度

set scale

Parameters

degrees

setInteractionOptions:enabled:

- (void) setInteractionOptions:		(AliVRPlayerInteractiveOptions)	option
enabled:		(BOOL)	enable

设置VR播放器的交互类型为开启或者关闭

Parameters

option	AliVRPlayerInteractiveOptionsPinch、AliVRPlayerInteractiveOptionsVerticalEnabled、AliVRPlayerInteractiveOptionsHorizontal、AliVRPlayerInteractiveOptionsDeviceMotion
enable	YES or NO (默认是AliVRPlayerInteractiveOptionsDeviceMotion开启状态，其他的为关闭状态)

Set VRPlayer Interactive mode

Parameters

option	AliVRPlayerInteractiveOptionsPinch、AliVRPlayerInteractiveOptionsVerticalEnabled、AliVRPlayerInteractiveOptionsHorizontal、AliVRPlayerInteractiveOptionsDeviceMotion
enable	YES or NO (Default is AliVRPlayerInteractiveOptionsDeviceMotion YES，others is NO )

setVideoBackgroundColor:

- (void) setVideoBackgroundColor:

(UIColor *)

color

设置播放器VR视频背景色

Parameters

color

背景颜色

set VR video background color

Parameters

color

background color

setVRDelegate:

- (void) setVRDelegate:

(id< AliVRPlayerDelegate >)

delegate

设置播放器VR代理，用来接收 回调信息或进行代理操作

Parameters

delegate

VR代理

set VR delegate, to receive callback information or delegate operation

Parameters

delegate

VR delegate

setVRDisplayContentsWithImage:

- (void) setVRDisplayContentsWithImage:

(UIImage *)

image

设置播放器显示全景图

Parameters

image

要展示的全景图

Set VRPlayer display with 360 image

Parameters

image

360 image

setVRPlayerType:

- (void) setVRPlayerType:

(AliVRPlayerType)

vrType

设置播放器VR处理器类型

Parameters

vrType

VR处理器的类型

set VR processor type

Parameters

vrType

VR processor type

setVRSceneRotate:

- (void) setVRSceneRotate:

(CGFloat)

rotate

设置VR播放器场景的旋转

Parameters

rotate

旋转的弧度数

Set VRPlayer scene rotate

Parameters

rotate

radians of rotate

setVRSceneScale:

- (void) setVRSceneScale:

(CGFloat)

scale

设置VR播放器的放大倍数

Parameters

scale

Set VRPlayer view scale

Parameters

scale

---

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

• AliVRPlayer.h