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

#import "AliVRPlayer.h"

Inheritance diagram for AliVRPlayer:
AliPlayer

Instance Methods

(void) - handlePanGesture:
 通过手势控制vr播放器的角度 More...
 
(instancetype) - init
 初始化播放器 More...
 
(instancetype) - init:
 初始化播放器 More...
 
(void) - rotateVRSceneWithX:andY:
 设置VR播放器旋转的角度 More...
 
(void) - setDisplayMode:
 设置VR播放器的展示方式 More...
 
(void) - setInteractionOptions:enabled:
 设置VR播放器的交互类型为开启或者关闭 More...
 
(void) - setVRDisplayContentsWithImage:
 设置播放器显示全景图 More...
 
(void) - setVRSceneRotate:
 设置VR播放器场景的旋转 More...
 
(void) - setVRSceneScale:
 设置VR播放器的放大倍数 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...
 

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...
 
- 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...
 

Method Documentation

◆ handlePanGesture:

- (void) handlePanGesture: (UIPanGestureRecognizer *)  paramSender

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

Parameters
paramSender滑动手势

Set VRPlayer rotate radians with axis

Parameters
paramSenderPan Gesture

◆ init

- (instancetype) init

初始化播放器

Initialize the player.

Implements AliPlayer.

◆ init:

- (instancetype) init: (NSString *)  traceID

初始化播放器

Parameters
traceID便于跟踪日志,设为"DisableAnalytics"可关闭日志分析系统(不推荐)。

Initialize the player.

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

Implements AliPlayer.

◆ rotateVRSceneWithX:andY:

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

设置VR播放器旋转的角度

Parameters
xx轴旋转的角度
yy轴旋转的角度

Set VRPlayer rotate radians with axis

Parameters
xradians of rotate on x axis
yradians of rotate on y axis

◆ setDisplayMode:

- (void) setDisplayMode: (AliVRPlayerViewDisplayMode)  displayMode

设置VR播放器的展示方式

Parameters
displayModeAliVRPlayerViewDisplayMode360 or AliVRPlayerViewDisplayModeGlass,默认值为 AliVRPlayerViewDisplayMode360

Set VRPlayer display mode (AliVRPlayerViewDisplayMode360 or AliVRPlayerViewDisplayModeGlass)

Parameters
displayModeAliVRPlayerViewDisplayMode360 or AliVRPlayerViewDisplayModeGlass (Default value is AliVRPlayerViewDisplayMode360)

◆ setInteractionOptions:enabled:

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

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

Parameters
optionAliVRPlayerInteractiveOptionsPinch、AliVRPlayerInteractiveOptionsVerticalEnabled、AliVRPlayerInteractiveOptionsHorizontal、AliVRPlayerInteractiveOptionsDeviceMotion
enableYES or NO (默认是AliVRPlayerInteractiveOptionsDeviceMotion开启状态,其他的为关闭状态)

Set VRPlayer Interactive mode

Parameters
optionAliVRPlayerInteractiveOptionsPinch、AliVRPlayerInteractiveOptionsVerticalEnabled、AliVRPlayerInteractiveOptionsHorizontal、AliVRPlayerInteractiveOptionsDeviceMotion
enableYES or NO (Default is AliVRPlayerInteractiveOptionsDeviceMotion YES,others is NO )

◆ setVRDisplayContentsWithImage:

- (void) setVRDisplayContentsWithImage: (UIImage *)  image

设置播放器显示全景图

Parameters
image要展示的全景图

Set VRPlayer display with 360 image

Parameters
image360 image

◆ setVRSceneRotate:

- (void) setVRSceneRotate: (CGFloat)  rotate

设置VR播放器场景的旋转

Parameters
rotate旋转的弧度数

Set VRPlayer scene rotate

Parameters
rotateradians 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: