AliyunPlayer  v5.2.0
Aliyun Player API Reference Manual for Windows Platforms
alivc_player::AliPlayer Class Referenceabstract

Public Member Functions

virtual void addExtSubtitle (const char *URL)=0
 添加外挂字幕。 More...
 
virtual void destroy ()=0
 销毁播放器 More...
 
virtual void enableHardwareDecoder (bool bEnabled)=0
 是否开启硬件解码 More...
 
virtual int64_t getBufferedPosition ()=0
 获取已经缓存的位置 More...
 
virtual const char * getCacheFilePath (const char *URL)=0
 根据url获取缓存的文件名。 More...
 
virtual const char * getCacheFilePath (const char *vid, const char *format, const char *definition, int previewTime)=0
 根据vid获取缓存的文件名。如果有自定义的规则。 More...
 
virtual AVPConfiggetConfig ()=0
 获取播放器设置 More...
 
virtual int64_t getCurrentPosition ()=0
 获取当前播放位置 More...
 
virtual AVPTrackInfo getCurrentTrack (AVPTrackType type)=0
 获取当前播放track More...
 
virtual int64_t getDuration ()=0
 获取视频的长度 More...
 
virtual int getHeight ()=0
 获取视频的高度 More...
 
virtual IAVPListenergetListener ()=0
 获取监听 More...
 
virtual int64_t getMasterClockPts ()=0
 获取主时钟pts More...
 
virtual AVPMediaInfo getMediaInfo ()=0
 获取媒体信息,包括track信息 More...
 
virtual AVPMirrorMode getMirrorMode ()=0
 获取渲染镜像模式 More...
 
virtual float getRate ()=0
 获取播放速率 More...
 
virtual AVPRotateMode getRotateMode ()=0
 获取渲染旋转模式 More...
 
virtual int getRotation ()=0
 获取视频的旋转角度,从metadata中获取出来 More...
 
virtual AVPScalingMode getScalingMode ()=0
 获取渲染填充模式 More...
 
virtual void getThumbnail (int64_t positionMs)=0
 获取指定位置的缩略图 More...
 
virtual void * getView ()=0
 获取播放器的视图view More...
 
virtual float getVolume ()=0
 获取播放器的音量(非系统音量) More...
 
virtual int getWidth ()=0
 获取视频的宽度 More...
 
virtual bool isAutoPlay ()=0
 获取是否自动播放 More...
 
virtual bool isEnabledHardwareDecoder ()=0
 获取是否开启硬件解码 More...
 
virtual bool isLoop ()=0
 获取是否循环播放 More...
 
virtual bool isMuted ()=0
 获取是否静音 More...
 
virtual void pause ()=0
 暂停播放 More...
 
virtual void prepare ()=0
 播放准备,异步 More...
 
virtual void redraw ()=0
 刷新view,例如view size变化时。 More...
 
virtual void reset ()=0
 重置播放 More...
 
virtual void seekToTime (int64_t time, AVPSeekMode seekMode)=0
 跳转到指定的播放位置 More...
 
virtual void selectExtSubtitle (int trackIndex, bool enable)=0
 选择外挂字幕 More...
 
virtual void selectTrack (int trackIndex)=0
 根据trackIndex,切换清晰度 More...
 
virtual void setAudioRenderingCallback (AudioRenderingCallback func, void *userData)=0
 设置音频渲染回调。需要在prepare()之前设置 More...
 
virtual void setAutoPlay (bool bAutoPlay)=0
 设置是否自动播放 More...
 
virtual bool setCacheConfig (AVPCacheConfig *cacheConfig)=0
 设置缓存配置 More...
 
virtual void setConfig (AVPConfig *config)=0
 播放器设置 More...
 
virtual void setListener (IAVPListener *listener)=0
 设置监听 More...
 
virtual void setLoop (bool bLoop)=0
 设置是否循环播放 More...
 
virtual void setMirrorMode (AVPMirrorMode mirrorMode)=0
 渲染镜像模式 More...
 
virtual void setMute (bool muted)=0
 设置是否静音 More...
 
virtual void setRate (float rate)=0
 播放速率,0.5-2.0之间,1为正常播放 More...
 
virtual void setRotateMode (AVPRotateMode rotateMode)=0
 渲染旋转模式 More...
 
virtual void setScalingMode (AVPScalingMode scalingMode)=0
 渲染填充模式 More...
 
virtual void setSource (const AVPUrlSource &source)=0
 使用url方式来播放视频 More...
 
virtual void setSource (const AVPVidAuthSource &source)=0
 使用vid+playauth方式播放。可参考:https://help.aliyun.com/document_detail/57294.html More...
 
virtual void setSource (const AVPVidMpsSource &source)=0
 用vid和MPS信息来播放视频。可参考:https://help.aliyun.com/document_detail/53522.html More...
 
virtual void setSource (const AVPVidStsSource &source)=0
 用vid和sts来播放视频,sts可参考:https://help.aliyun.com/document_detail/28756.html More...
 
virtual void setTraceID (const char *traceID)=0
 用于跟踪debug信息 More...
 
virtual void setVideoRenderingCallback (VideoRenderingCallback func, void *userData)=0
 设置视频渲染回调。需要在prepare()之前设置 More...
 
virtual void setView (void *view)=0
 设置播放器的视图playerView view: windows下为HWND More...
 
virtual void setVolume (float volume)=0
 设置播放器的音量(非系统音量),范围0.0~2.0,当音量大于1.0时,可能出现噪音,不推荐使用。 More...
 
virtual void snapshot ()=0
 截图, 数据在onSnapshotImageBuffer回调中返回 More...
 
virtual void start ()=0
 开始播放 More...
 
virtual void stop ()=0
 停止播放 More...
 
virtual ~AliPlayer ()=default
 

Static Public Member Functions

static void alivcFree (void *buffer)
 释放内部分配的内存 More...
 
static AliPlayerCreatePlayer ()
 
static void enableLog (AVPLogLevel level)
 设置log输出级别 More...
 
static const char * getSDKVersion ()
 获取SDK版本号信息 More...
 
static void setLogCallback (ApsaraPlayerLogCallback func, void *arg)
 设置日志打印回调,异步 More...
 

Constructor & Destructor Documentation

◆ ~AliPlayer()

virtual alivc_player::AliPlayer::~AliPlayer ( )
virtualdefault

Member Function Documentation

◆ addExtSubtitle()

virtual void alivc_player::AliPlayer::addExtSubtitle ( const char *  URL)
pure virtual

添加外挂字幕。

Parameters
URL字幕地址

◆ alivcFree()

static void alivc_player::AliPlayer::alivcFree ( void *  buffer)
static

释放内部分配的内存

See also
getCacheFilePath

◆ CreatePlayer()

static AliPlayer* alivc_player::AliPlayer::CreatePlayer ( )
static

◆ destroy()

virtual void alivc_player::AliPlayer::destroy ( )
pure virtual

销毁播放器

◆ enableHardwareDecoder()

virtual void alivc_player::AliPlayer::enableHardwareDecoder ( bool  bEnabled)
pure virtual

是否开启硬件解码

◆ enableLog()

static void alivc_player::AliPlayer::enableLog ( AVPLogLevel  level)
static

设置log输出级别

◆ getBufferedPosition()

virtual int64_t alivc_player::AliPlayer::getBufferedPosition ( )
pure virtual

获取已经缓存的位置

◆ getCacheFilePath() [1/2]

virtual const char* alivc_player::AliPlayer::getCacheFilePath ( const char *  URL)
pure virtual

根据url获取缓存的文件名。

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

Parameters
URLURL
Returns
最终缓存的文件名(不包括后缀。缓存文件的后缀名统一为.alv)。使用后需要使用alivcFree释放。

◆ getCacheFilePath() [2/2]

virtual const char* alivc_player::AliPlayer::getCacheFilePath ( const char *  vid,
const char *  format,
const char *  definition,
int  previewTime 
)
pure virtual

根据vid获取缓存的文件名。如果有自定义的规则。

Parameters
vid视频id
format视频格式
definition视频清晰度
previewTime试看时长, 0则忽略该参数
Returns
最终缓存的文件名(不包括后缀。缓存文件的后缀名统一为.alv)。使用后需要使用alivcFree释放。

◆ getConfig()

virtual AVPConfig* alivc_player::AliPlayer::getConfig ( )
pure virtual

获取播放器设置

See also
AVPConfig

◆ getCurrentPosition()

virtual int64_t alivc_player::AliPlayer::getCurrentPosition ( )
pure virtual

获取当前播放位置

◆ getCurrentTrack()

virtual AVPTrackInfo alivc_player::AliPlayer::getCurrentTrack ( AVPTrackType  type)
pure virtual

获取当前播放track

Parameters
typetrack类型
See also
AVPTrackType

◆ getDuration()

virtual int64_t alivc_player::AliPlayer::getDuration ( )
pure virtual

获取视频的长度

◆ getHeight()

virtual int alivc_player::AliPlayer::getHeight ( )
pure virtual

获取视频的高度

◆ getListener()

virtual IAVPListener* alivc_player::AliPlayer::getListener ( )
pure virtual

获取监听

◆ getMasterClockPts()

virtual int64_t alivc_player::AliPlayer::getMasterClockPts ( )
pure virtual

获取主时钟pts

◆ getMediaInfo()

virtual AVPMediaInfo alivc_player::AliPlayer::getMediaInfo ( )
pure virtual

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

◆ getMirrorMode()

virtual AVPMirrorMode alivc_player::AliPlayer::getMirrorMode ( )
pure virtual

获取渲染镜像模式

See also
AVPMirrorMode

◆ getRate()

virtual float alivc_player::AliPlayer::getRate ( )
pure virtual

获取播放速率

◆ getRotateMode()

virtual AVPRotateMode alivc_player::AliPlayer::getRotateMode ( )
pure virtual

获取渲染旋转模式

See also
AVPRotateMode

◆ getRotation()

virtual int alivc_player::AliPlayer::getRotation ( )
pure virtual

获取视频的旋转角度,从metadata中获取出来

◆ getScalingMode()

virtual AVPScalingMode alivc_player::AliPlayer::getScalingMode ( )
pure virtual

获取渲染填充模式

See also
AVPScalingMode

◆ getSDKVersion()

static const char* alivc_player::AliPlayer::getSDKVersion ( )
static

获取SDK版本号信息

◆ getThumbnail()

virtual void alivc_player::AliPlayer::getThumbnail ( int64_t  positionMs)
pure virtual

获取指定位置的缩略图

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

◆ getView()

virtual void* alivc_player::AliPlayer::getView ( )
pure virtual

获取播放器的视图view

Query player view

◆ getVolume()

virtual float alivc_player::AliPlayer::getVolume ( )
pure virtual

获取播放器的音量(非系统音量)

◆ getWidth()

virtual int alivc_player::AliPlayer::getWidth ( )
pure virtual

获取视频的宽度

◆ isAutoPlay()

virtual bool alivc_player::AliPlayer::isAutoPlay ( )
pure virtual

获取是否自动播放

◆ isEnabledHardwareDecoder()

virtual bool alivc_player::AliPlayer::isEnabledHardwareDecoder ( )
pure virtual

获取是否开启硬件解码

◆ isLoop()

virtual bool alivc_player::AliPlayer::isLoop ( )
pure virtual

获取是否循环播放

◆ isMuted()

virtual bool alivc_player::AliPlayer::isMuted ( )
pure virtual

获取是否静音

◆ pause()

virtual void alivc_player::AliPlayer::pause ( )
pure virtual

暂停播放

◆ prepare()

virtual void alivc_player::AliPlayer::prepare ( )
pure virtual

播放准备,异步

◆ redraw()

virtual void alivc_player::AliPlayer::redraw ( )
pure virtual

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

◆ reset()

virtual void alivc_player::AliPlayer::reset ( )
pure virtual

重置播放

◆ seekToTime()

virtual void alivc_player::AliPlayer::seekToTime ( int64_t  time,
AVPSeekMode  seekMode 
)
pure virtual

跳转到指定的播放位置

Parameters
time新的播放位置,单位毫秒
seekModeseek模式
See also
AVPSeekMode

◆ selectExtSubtitle()

virtual void alivc_player::AliPlayer::selectExtSubtitle ( int  trackIndex,
bool  enable 
)
pure virtual

选择外挂字幕

Parameters
trackIndex字幕索引
enabletrue:选择,false:关闭

◆ selectTrack()

virtual void alivc_player::AliPlayer::selectTrack ( int  trackIndex)
pure virtual

根据trackIndex,切换清晰度

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

◆ setAudioRenderingCallback()

virtual void alivc_player::AliPlayer::setAudioRenderingCallback ( AudioRenderingCallback  func,
void *  userData 
)
pure virtual

设置音频渲染回调。需要在prepare()之前设置

◆ setAutoPlay()

virtual void alivc_player::AliPlayer::setAutoPlay ( bool  bAutoPlay)
pure virtual

设置是否自动播放

◆ setCacheConfig()

virtual bool alivc_player::AliPlayer::setCacheConfig ( AVPCacheConfig cacheConfig)
pure virtual

设置缓存配置

Parameters
AVPCacheConfig缓存配置。AVPCacheConfig
Returns
设置成功返回YES

◆ setConfig()

virtual void alivc_player::AliPlayer::setConfig ( AVPConfig config)
pure virtual

播放器设置

Parameters
configAVPConfig类型
See also
AVPConfig

◆ setListener()

virtual void alivc_player::AliPlayer::setListener ( IAVPListener listener)
pure virtual

设置监听

◆ setLogCallback()

static void alivc_player::AliPlayer::setLogCallback ( ApsaraPlayerLogCallback  func,
void *  arg 
)
static

设置日志打印回调,异步

◆ setLoop()

virtual void alivc_player::AliPlayer::setLoop ( bool  bLoop)
pure virtual

设置是否循环播放

◆ setMirrorMode()

virtual void alivc_player::AliPlayer::setMirrorMode ( AVPMirrorMode  mirrorMode)
pure virtual

渲染镜像模式

See also
AVPMirrorMode

◆ setMute()

virtual void alivc_player::AliPlayer::setMute ( bool  muted)
pure virtual

设置是否静音

◆ setRate()

virtual void alivc_player::AliPlayer::setRate ( float  rate)
pure virtual

播放速率,0.5-2.0之间,1为正常播放

◆ setRotateMode()

virtual void alivc_player::AliPlayer::setRotateMode ( AVPRotateMode  rotateMode)
pure virtual

渲染旋转模式

See also
AVPRotateMode

◆ setScalingMode()

virtual void alivc_player::AliPlayer::setScalingMode ( AVPScalingMode  scalingMode)
pure virtual

渲染填充模式

See also
AVPScalingMode

◆ setSource() [1/4]

virtual void alivc_player::AliPlayer::setSource ( const AVPUrlSource source)
pure virtual

使用url方式来播放视频

Parameters
sourceAVPUrlSource的输入类型
See also
AVPUrlSource

◆ setSource() [2/4]

virtual void alivc_player::AliPlayer::setSource ( const AVPVidAuthSource source)
pure virtual

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

Parameters
sourceAVPVidAuthSource的输入类型
See also
AVPVidAuthSource

◆ setSource() [3/4]

virtual void alivc_player::AliPlayer::setSource ( const AVPVidMpsSource source)
pure virtual

用vid和MPS信息来播放视频。可参考:https://help.aliyun.com/document_detail/53522.html

Parameters
sourceAVPVidMpsSource的输入类型
See also
AVPVidMpsSource

◆ setSource() [4/4]

virtual void alivc_player::AliPlayer::setSource ( const AVPVidStsSource source)
pure virtual

用vid和sts来播放视频,sts可参考:https://help.aliyun.com/document_detail/28756.html

Parameters
sourceAVPVidStsSource的输入类型
See also
AVPVidStsSource

◆ setTraceID()

virtual void alivc_player::AliPlayer::setTraceID ( const char *  traceID)
pure virtual

用于跟踪debug信息

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

◆ setVideoRenderingCallback()

virtual void alivc_player::AliPlayer::setVideoRenderingCallback ( VideoRenderingCallback  func,
void *  userData 
)
pure virtual

设置视频渲染回调。需要在prepare()之前设置

◆ setView()

virtual void alivc_player::AliPlayer::setView ( void *  view)
pure virtual

设置播放器的视图playerView view: windows下为HWND

◆ setVolume()

virtual void alivc_player::AliPlayer::setVolume ( float  volume)
pure virtual

设置播放器的音量(非系统音量),范围0.0~2.0,当音量大于1.0时,可能出现噪音,不推荐使用。

◆ snapshot()

virtual void alivc_player::AliPlayer::snapshot ( )
pure virtual

截图, 数据在onSnapshotImageBuffer回调中返回

◆ start()

virtual void alivc_player::AliPlayer::start ( )
pure virtual

开始播放

◆ stop()

virtual void alivc_player::AliPlayer::stop ( )
pure virtual

停止播放


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