AliyunPlayer v7.10.0
Aliyun Player API Reference Manual for iOS Platforms
Loading...
Searching...
No Matches
AVPDef.h File Reference

Classes

struct  _AVPStsInfo
 STS信息结构体。用于存储临时安全令牌相关的凭证信息。 More...
class  AVPErrorModel
 播放错误信息模型类。用于描述和传递播放过程中发生的错误信息。 More...
class  AVPNetworkStat
 网络统计信息类,用于收集和表示播放器应用的网络状况。 More...
class  AVPTimeShiftModel
 AVPTimeShiftModel直播时移描述 More...
class  AVPUrlResult
 URL刷新结果 More...

Typedefs

typedef enum AVPAlphaRenderMode AVPAlphaRenderMode
 Alpha渲染模式 用于处理包含Alpha通道(透明度)的视频帧。视频帧被划分为图像区域和Alpha通道区域, 播放器将根据指定的布局方式,从帧中分离出RGB图像和Alpha数据,并进行透明合成渲染。 常用于直播礼物、动态贴纸等需要透明叠加的场景。 可以参考 视频帧处理.
typedef enum BizScene AVPBizScene
 自适应降级切换URL的应用场景枚举。用于标识URL切换发生在播放器还是预加载器中。
typedef enum CodecType AVPCodecType
 自适应降级时的原始URL编码格式枚举。
typedef enum AVPEventType AVPEventType
 播放器事件类型
typedef enum AVPIpResolveType AVPIpResolveType
 IP地址解析类型枚举。用于指定网络连接时使用的IP地址类型。
typedef enum AVPLogLevel AVPLogLevel
 日志级别枚举。用于控制播放器日志输出的详细程度。
typedef enum AVPLogOption AVPLogOption
 日志选项枚举。用于控制日志输出的特定功能。
typedef enum AVPMirrorMode AVPMirrorMode
 镜像模式枚举。用于控制视频画面的镜像翻转效果。
typedef enum AVPMultiBitratesMode AVPMultiBitratesMode
 多码率预加载类型,只对多码率HLS流生效
typedef enum AVPNetworkLevel AVPNetworkLevel
typedef enum AVPOption AVPOption
 播放器可获取的选项枚举。用于实时查询播放器的性能指标。
typedef enum AVPOutputAudioChannel AVPOutputAudioChannel
 音频输出声道枚举。用于指定音频输出时选择的声道。
typedef enum AVPPIPShowMode AVPPIPShowMode
 画中画(PIP)显示模式枚举。用于控制画中画功能的UI展示方式。
typedef enum AVPPixelNumber AVPPixelNumber
 特定分辨率的像素数量参考值枚举。
typedef enum AVPPropertyKey AVPPropertyKey
 获取播放器信息的关键字枚举。用于查询播放器的特定属性或统计信息。
typedef enum AVPRotateMode AVPRotateMode
 旋转模式枚举。用于控制视频画面的旋转角度。
typedef enum AVPScalingMode AVPScalingMode
 缩放模式枚举。用于控制视频画面的缩放和填充方式。
typedef enum _AVPScene AVPScene
 播放场景枚举。用于为播放器指定最适合的播放场景配置。
typedef enum AVPSceneType AVPSceneType
 播放场景类型枚举。用于指定媒体的播放场景,以便播放器优化相关配置。
typedef enum AVPSeekMode AVPSeekMode
 跳转模式枚举。控制seek操作时是否精确定位。
typedef enum AVPStatus AVPStatus
 播放器状态枚举
typedef enum AVPStrategyType AVPStrategyType
 策略类型
typedef struct _AVPStsInfo AVPStsInfo
 STS信息结构体。用于存储临时安全令牌相关的凭证信息。
typedef enum _AVPStsStatus AVPStsStatus
 STS(临时安全令牌)状态枚举。用于表示STS令牌的有效状态。
typedef enum _GlobalOption GlobalOption
 <<<<<<< Updated upstream
typedef enum _PlayerOption PlayerOption
 播放器特定功能选项枚举。用于配置单个播放器实例的行为选项。
typedef bool(* PlayURLConverCallback) (const char *srcURL, const char *srcFormat, char **destURL)
 播放URL转换回调函数
typedef enum _SupportFeatureType SupportFeatureType
 功能支持类型枚举。用于查询播放器是否支持特定的硬件或软件功能。

Enumerations

enum  _AVPScene {
  SceneNone , SceneLong , SceneMedium , SceneShort ,
  SceneLive , SceneRTSLive
}
 播放场景枚举。用于为播放器指定最适合的播放场景配置。 More...
enum  _AVPStsStatus { Valid , Invalid , Pending }
 STS(临时安全令牌)状态枚举。用于表示STS令牌的有效状态。 More...
enum  _GlobalOption : NSUInteger {
  SET_PRE_CONNECT_DOMAIN = 0 , SET_DNS_PRIORITY_LOCAL_FIRST = 1 , ENABLE_H2_MULTIPLEX = 2 , SET_EXTRA_DATA = 3 ,
  ENABLE_ANDROID_DECODE_REUSE = 4 , NOT_PAUSE_WHEN_PREPARING = 5 , ALLOW_RTS_DEGRADE = 6 , ENABLE_DECODER_FAST_FIRST_FRAME = 7 ,
  DISABLE_CAPTURE_SCALE = 8 , ALLOW_BOUNDS_CHANGE_ANIMATION = 10 , AV3A_DECODE_MODEL_PATH = 11 , RENDER_IGNORE_DAR_SCALE = 14 ,
  MAX_ERROR_FRAMES_HARDWARE_DECODE = 15 , ALLOW_AUDIOUNIT = 16 , DISABLE_CATCHUP_IN_LOWLATENCY_AUDIOQUEUE = 17 , ENABLE_URL_REFRESH_ON_FORBIDDEN = 18 ,
  ENABLE_PARSE_VTT_DIALOGUE_CUE_BY_JSON = 100
}
 <<<<<<< Updated upstream More...
enum  _PlayerOption : NSUInteger {
  SET_MEDIA_TYPE = 0 , ALLOW_DECODE_BACKGROUND = 1 , ALLOW_PRE_RENDER = 2 , PLAYED_DURATION_INCLUDE_SPEED = 3 ,
  PRE_RENDER_MAX_BUFFER_MS = 5 , LINE_FALLBACK_URL = 6
}
 播放器特定功能选项枚举。用于配置单个播放器实例的行为选项。 More...
enum  _SupportFeatureType : NSUInteger { FeatureDolbyAudio }
 功能支持类型枚举。用于查询播放器是否支持特定的硬件或软件功能。 More...
enum  AVPAlphaRenderMode : NSUInteger {
  AVP_RENDERMODE_ALPHA_NONE = 0 , AVP_RENDERMODE_ALPHA_AT_RIGHT = 1 , AVP_RENDERMODE_ALPHA_AT_LEFT = 2 , AVP_RENDERMODE_ALPHA_AT_TOP = 3 ,
  AVP_RENDERMODE_ALPHA_AT_BOTTOM = 4
}
 Alpha渲染模式 用于处理包含Alpha通道(透明度)的视频帧。视频帧被划分为图像区域和Alpha通道区域, 播放器将根据指定的布局方式,从帧中分离出RGB图像和Alpha数据,并进行透明合成渲染。 常用于直播礼物、动态贴纸等需要透明叠加的场景。 可以参考 视频帧处理. More...
enum  AVPEventType : NSUInteger {
  AVPEventPrepareDone , AVPEventAutoPlayStart , AVPEventFirstRenderedStart , AVPEventCompletion ,
  AVPEventLoadingStart , AVPEventLoadingEnd , AVPEventSeekEnd , AVPEventLoopingStart ,
  AVPEventClearScreenDone
}
 播放器事件类型 More...
enum  AVPIpResolveType : NSUInteger { AVPIpResolveWhatEver , AVPIpResolveV4 , AVPIpResolveV6 }
 IP地址解析类型枚举。用于指定网络连接时使用的IP地址类型。 More...
enum  AVPLogLevel : NSUInteger {
  LOG_LEVEL_NONE = 0 , LOG_LEVEL_FATAL = 8 , LOG_LEVEL_ERROR = 16 , LOG_LEVEL_WARNING = 24 ,
  LOG_LEVEL_INFO = 32 , LOG_LEVEL_DEBUG = 48 , LOG_LEVEL_TRACE = 56
}
 日志级别枚举。用于控制播放器日志输出的详细程度。 More...
enum  AVPLogOption : NSUInteger { FRAME_LEVEL_LOGGING_ENABLED = 1 }
 日志选项枚举。用于控制日志输出的特定功能。 More...
enum  AVPMirrorMode : NSUInteger { AVP_MIRRORMODE_NONE , AVP_MIRRORMODE_HORIZONTAL , AVP_MIRRORMODE_VERTICAL }
 镜像模式枚举。用于控制视频画面的镜像翻转效果。 More...
enum  AVPMultiBitratesMode : NSUInteger { AVPMultiBitratesMode_Default = 0 , AVPMultiBitratesMode_FCPrio = 1 , AVPMultiBitratesMode_FC_AND_SMOOTH = 2 , AVPMultiBitratesMode_SmoothPrio = 3 }
 多码率预加载类型,只对多码率HLS流生效 More...
enum  AVPNetworkLevel : NSInteger {
  AVPNetwork_UNKNOWN = -1 , AVPNetwork_EXCELLENT = 0 , AVPNetwork_GOOD = 1 , AVPNetwork_POOR = 2 ,
  AVPNetwork_BAD = 3 , AVPNetwork_VERY_BAD = 4 , AVPNetwork_DISCONNECTED = 5
}
enum  AVPOption : NSUInteger {
  AVP_OPTION_RENDER_FPS = 0 , AVP_OPTION_DOWNLOAD_BITRATE = 1 , AVP_OPTION_VIDEO_BITRATE = 2 , AVP_OPTION_AUDIO_BITRATE = 3 ,
  AVP_OPTION_IS_ABRSWITCHING = 4
}
 播放器可获取的选项枚举。用于实时查询播放器的性能指标。 More...
enum  AVPOutputAudioChannel : NSUInteger { AVP_AUDIO_CHANNEL_NONE = 0 , AVP_AUDIO_CHANNEL_LEFT = 1 , AVP_AUDIO_CHANNEL_RIGHT = 2 }
 音频输出声道枚举。用于指定音频输出时选择的声道。 More...
enum  AVPPIPShowMode : NSUInteger { AVP_SHOW_MODE_DEFAULT = 0 , AVP_SHOW_MODE_HIDE_FAST_FORWARD_REWIND = 1 }
 画中画(PIP)显示模式枚举。用于控制画中画功能的UI展示方式。 More...
enum  AVPPixelNumber : NSUInteger {
  Resolution_360P = 172800 , Resolution_480P = 345600 , Resolution_540P = 518400 , Resolution_720P = 921600 ,
  Resolution_1080P = 2073600 , Resolution_2K = 3686400 , Resolution_4K = 8847360 , Resolution_NoLimit = INT_MAX
}
 特定分辨率的像素数量参考值枚举。 More...
enum  AVPPropertyKey : NSUInteger { AVP_KEY_RESPONSE_INFO = 0 , AVP_KEY_CONNECT_INFO = 1 }
 获取播放器信息的关键字枚举。用于查询播放器的特定属性或统计信息。 More...
enum  AVPRotateMode : NSUInteger { AVP_ROTATE_0 = 0 , AVP_ROTATE_90 = 90 , AVP_ROTATE_180 = 180 , AVP_ROTATE_270 = 270 }
 旋转模式枚举。用于控制视频画面的旋转角度。 More...
enum  AVPScalingMode : NSUInteger { AVP_SCALINGMODE_SCALETOFILL , AVP_SCALINGMODE_SCALEASPECTFIT , AVP_SCALINGMODE_SCALEASPECTFILL }
 缩放模式枚举。用于控制视频画面的缩放和填充方式。 More...
enum  AVPSceneType : NSInteger {
  AVP_SCENE_NONE = -1 , AVP_VERY_SHOR_VIDEO = 0 , AVP_SHORT_VIDEO = 1 , AVP_MIDDLE_VIDEO = 2 ,
  AVP_LONG_VIDEO = 3
}
 播放场景类型枚举。用于指定媒体的播放场景,以便播放器优化相关配置。 More...
enum  AVPSeekMode : NSUInteger { AVP_SEEKMODE_ACCURATE = 0x01 , AVP_SEEKMODE_INACCURATE = 0x10 }
 跳转模式枚举。控制seek操作时是否精确定位。 More...
enum  AVPStatus : NSUInteger {
  AVPStatusIdle = 0 , AVPStatusInitialzed , AVPStatusPrepared , AVPStatusStarted ,
  AVPStatusPaused , AVPStatusStopped , AVPStatusCompletion , AVPStatusError
}
 播放器状态枚举 More...
enum  AVPStrategyType : NSUInteger { AVP_STRATEGY_DYNAMIC_PRELOAD = 1 }
 策略类型 More...
enum  BizScene : NSUInteger { AVP_Player = 0 , AVP_Loader = 1 }
 自适应降级切换URL的应用场景枚举。用于标识URL切换发生在播放器还是预加载器中。 More...
enum  CodecType : NSUInteger { AVP_H265 = 0 }
 自适应降级时的原始URL编码格式枚举。 More...

Typedef Documentation

◆ AVPAlphaRenderMode

Alpha渲染模式 用于处理包含Alpha通道(透明度)的视频帧。视频帧被划分为图像区域和Alpha通道区域, 播放器将根据指定的布局方式,从帧中分离出RGB图像和Alpha数据,并进行透明合成渲染。 常用于直播礼物、动态贴纸等需要透明叠加的场景。 可以参考 视频帧处理.

◆ AVPBizScene

typedef enum BizScene AVPBizScene

自适应降级切换URL的应用场景枚举。用于标识URL切换发生在播放器还是预加载器中。

当播放器或预加载器因编码格式不支持(如H.265不支持)需要切换到备用URL时, 此枚举用于区分切换发生的具体场景。

See also
AliPlayerGlobalSettings::AdaptiveDecoderGetBackupURLCallback

◆ AVPCodecType

typedef enum CodecType AVPCodecType

自适应降级时的原始URL编码格式枚举。

用于表示在自适应降级场景下,原始URL所对应的编码格式。 当编码格式不被支持时,播放器可基于此信息切换到备用URL。

See also
AliPlayerGlobalSettings::AdaptiveDecoderGetBackupURLCallback

◆ AVPEventType

typedef enum AVPEventType AVPEventType

播放器事件类型

◆ AVPIpResolveType

IP地址解析类型枚举。用于指定网络连接时使用的IP地址类型。

在DNS解析时,可指定优先使用IPv4或IPv6,或支持两者自动选择。

See also
AliPlayer::setIPResolveType

◆ AVPLogLevel

typedef enum AVPLogLevel AVPLogLevel

日志级别枚举。用于控制播放器日志输出的详细程度。

日志级别从低到高分别为:NONE、FATAL、ERROR、WARNING、INFO、DEBUG、TRACE。 数值越大,输出的日志信息越详细。

◆ AVPLogOption

typedef enum AVPLogOption AVPLogOption

日志选项枚举。用于控制日志输出的特定功能。

通过这些选项可启用或禁用日志系统的特定功能。

◆ AVPMirrorMode

镜像模式枚举。用于控制视频画面的镜像翻转效果。

支持水平镜像(左右翻转)和垂直镜像(上下翻转)两种效果。

◆ AVPMultiBitratesMode

多码率预加载类型,只对多码率HLS流生效

See also
AliListPlayer SetMultiBitratesMode

◆ AVPNetworkLevel

◆ AVPOption

typedef enum AVPOption AVPOption

播放器可获取的选项枚举。用于实时查询播放器的性能指标。

通过这些选项可获取当前的渲染帧率、网络码率、视频码率等动态信息。

See also
AliPlayer getOption

◆ AVPOutputAudioChannel

音频输出声道枚举。用于指定音频输出时选择的声道。

当输入音源为双声道(立体声)时,可通过此枚举选择仅输出左声道或右声道; 若输入为单声道,则此设置无效,音频将正常播放。

◆ AVPPIPShowMode

画中画(PIP)显示模式枚举。用于控制画中画功能的UI展示方式。

定义了在启用画中画模式时,控制按钮的显示或隐藏方式。

See also
AliPlayer::setPictureinPictureShowMode

◆ AVPPixelNumber

特定分辨率的像素数量参考值枚举。

该枚举列举了常见视频分辨率对应的像素总数(宽×高)。 这些值可用于 AVPConfig::maxAllowedAbrVideoPixelNumber 的参考

Note
像素数量为参考值,仅供参考,实际分辨率可能略有差异。

◆ AVPPropertyKey

获取播放器信息的关键字枚举。用于查询播放器的特定属性或统计信息。

通过这些关键字可获取HTTP响应信息、连接信息等调试和性能相关的数据。

See also
AliPlayer::getPropertyString

◆ AVPRotateMode

旋转模式枚举。用于控制视频画面的旋转角度。

所有旋转均为顺时针旋转。

◆ AVPScalingMode

缩放模式枚举。用于控制视频画面的缩放和填充方式。

定义了视频在显示区域内如何进行缩放、裁剪或拉伸的几种模式。

◆ AVPScene

typedef enum _AVPScene AVPScene

播放场景枚举。用于为播放器指定最适合的播放场景配置。

播放器会根据指定的场景自动应用优化的配置策略, 无需开发者手动调整各个参数。

See also
AliPlayer::setPlayerScene

◆ AVPSceneType

typedef enum AVPSceneType AVPSceneType

播放场景类型枚举。用于指定媒体的播放场景,以便播放器优化相关配置。

阿里云播放器为不同场景预设了最优配置,通过指定场景类型可自动应用相应的优化策略, 无需手动调整各个配置参数。

See also
AliListPlayer::setScene

◆ AVPSeekMode

typedef enum AVPSeekMode AVPSeekMode

跳转模式枚举。控制seek操作时是否精确定位。

精准seek会准确地跳转到指定的时间位置,但速度相对较慢。 不精准seek会跳转到指定时间位置之前的最近一个关键帧开始播放,速度较快, 但可能与指定位置存在偏差。

See also
AliPlayer::seekToTime

◆ AVPStatus

typedef enum AVPStatus AVPStatus

播放器状态枚举

◆ AVPStrategyType

策略类型

◆ AVPStsInfo

typedef struct _AVPStsInfo AVPStsInfo

STS信息结构体。用于存储临时安全令牌相关的凭证信息。

包含访问ID、访问密钥、安全令牌、地域和格式等信息, 用于身份验证和授权访问阿里云资源。

◆ AVPStsStatus

STS(临时安全令牌)状态枚举。用于表示STS令牌的有效状态。

◆ GlobalOption

<<<<<<< Updated upstream

GlobalSettings的特定功能选项。全局设置选项枚举。用于配置播放器全局行为的选项。 +setOption:valueInt:

◆ PlayerOption

播放器特定功能选项枚举。用于配置单个播放器实例的行为选项。

这些选项可在创建播放器后进行设置,每个播放器实例可单独配置。

See also
AliPlayer::setOption

◆ PlayURLConverCallback

typedef bool(* PlayURLConverCallback) (const char *srcURL, const char *srcFormat, char **destURL)

播放URL转换回调函数

Parameters
srcURL[in] 输入的原始URL字符串,不能为NULL。
srcFormat[in] 输入URL的格式,通常为"m3u8"、"mp4"或其他格式标识,格式未知时为空字符串。
destURL[out] 输出的转换后URL字符串。函数需负责分配内存,调用者需在使用后释放该内存。
Returns
true表示URL转换成功,false表示转换失败。转换失败时,播放器将使用原始URL继续播放。
See also
AliPlayer::setPlayUrlConvertCallback

◆ SupportFeatureType

功能支持类型枚举。用于查询播放器是否支持特定的硬件或软件功能。

通过这些类型可检查设备是否支持特定的高级音视频功能。

Enumeration Type Documentation

◆ _AVPScene

enum _AVPScene

播放场景枚举。用于为播放器指定最适合的播放场景配置。

播放器会根据指定的场景自动应用优化的配置策略, 无需开发者手动调整各个参数。

See also
AliPlayer::setPlayerScene
Enumerator
SceneNone 

场景:无

SceneLong 

长视频场景:适用于30min以上

SceneMedium 

中视频场景:适用于5min-30min

SceneShort 

短视频场景:适用于0s-5min

SceneLive 

直播场景

SceneRTSLive 

超低延迟直播场景

◆ _AVPStsStatus

STS(临时安全令牌)状态枚举。用于表示STS令牌的有效状态。

Enumerator
Valid 

有效。STS令牌已获取且仍在有效期内。

Invalid 

无效。STS令牌已过期或无法使用。

Pending 

待定。STS令牌正在获取中,暂时不可用。

◆ _GlobalOption

enum _GlobalOption : NSUInteger

<<<<<<< Updated upstream

GlobalSettings的特定功能选项。全局设置选项枚举。用于配置播放器全局行为的选项。 +setOption:valueInt:

Enumerator
SET_PRE_CONNECT_DOMAIN 

预连接域名选项 +setOption:value:@endlink

设置预连接的域名,用于优化首次连接速度。

SET_DNS_PRIORITY_LOCAL_FIRST 

DNS 本地优先解析选项 .

启用后,DNS 解析将优先使用本地 DNS 而非远程 DNS。

ENABLE_H2_MULTIPLEX 

启用 HTTP/2 多路复用选项 +setOption:valueInt:@endlink

启用 HTTP/2 协议的多路复用功能,提高网络传输效率。

SET_EXTRA_DATA 

设置额外数据选项 +setOption:value:@endlink

用于传递自定义的额外数据到播放器内部。

ENABLE_ANDROID_DECODE_REUSE 

启用 Android 解码器复用选项(仅 Android 平台) +setOption:valueInt:@endlink

Android 平台专用占位符选项,用于启用解码器复用功能。

NOT_PAUSE_WHEN_PREPARING 

准备时不暂停选项 +setOption:valueInt:@endlink

启用后,在准备过程中不会暂停播放。

ALLOW_RTS_DEGRADE 

允许 RTS 降级选项 +setOption:valueInt:@endlink

允许超低延迟直播(RTS)在必要时降级到普通直播模式。

ENABLE_DECODER_FAST_FIRST_FRAME 

启用解码器快速首帧选项 +setOption:valueInt:@endlink

优化解码器初始化流程,加快首帧显示速度。

DISABLE_CAPTURE_SCALE 

禁用截图缩放选项 +setOption:valueInt:@endlink

禁用截图时的自动缩放功能。

ALLOW_BOUNDS_CHANGE_ANIMATION 

允许边界变化动画选项(仅 iOS 平台) +setOption:valueInt:@endlink

iOS 平台专用选项,允许视图边界变化时显示动画效果。

AV3A_DECODE_MODEL_PATH 

AV3A 解码模型路径选项 .

指定 AV3A 解码模型的文件路径。

RENDER_IGNORE_DAR_SCALE 

忽略 DAR 缩放选项(仅 iOS 平台) +setOption:valueInt:@endlink

iOS 平台专用选项,忽略显示宽高比(DAR)的缩放处理。

MAX_ERROR_FRAMES_HARDWARE_DECODE 

硬件解码最大错误帧数选项 +setOption:valueInt:@endlink

设置硬件解码器允许的最大连续错误帧数,超过此值将触发降级。

ALLOW_AUDIOUNIT 

允许 AudioUnit 选项(仅 iOS 平台) +setOption:valueInt:@endlink

iOS 平台专用选项,允许使用 AudioUnit 进行音频处理。

DISABLE_CATCHUP_IN_LOWLATENCY_AUDIOQUEUE 

禁用低延迟音频队列追赶选项(仅 iOS 平台) +setOption:valueInt:@endlink

iOS 平台专用选项,禁用低延迟音频队列中的追赶机制。

ENABLE_URL_REFRESH_ON_FORBIDDEN 

启用 403 禁止错误时的 URL 刷新选项 +setOption:valueInt:@endlink

当收到 HTTP 403 Forbidden 错误时,自动触发 URL 刷新机制。

ENABLE_PARSE_VTT_DIALOGUE_CUE_BY_JSON 

启用 VTT 对话提示的 JSON 解析选项 +setOption:valueInt:@endlink

启用后,VTT 字幕中的对话提示将通过 JSON 格式进行解析。

◆ _PlayerOption

enum _PlayerOption : NSUInteger

播放器特定功能选项枚举。用于配置单个播放器实例的行为选项。

这些选项可在创建播放器后进行设置,每个播放器实例可单独配置。

See also
AliPlayer::setOption
Enumerator
SET_MEDIA_TYPE 
ALLOW_DECODE_BACKGROUND 

允许后台解码。在应用进入后台时继续进行视频解码,保持播放状态。

ALLOW_PRE_RENDER 

允许预渲染。启用视频帧的预先渲染,加速首帧显示。

PLAYED_DURATION_INCLUDE_SPEED 

播放时长包含播放速度。计算播放时长时考虑播放倍速的影响。

See also
- getPlayedDuration (AliPlayer)
PRE_RENDER_MAX_BUFFER_MS 

预渲染最大缓冲时长。指定预渲染功能的最大缓冲时长,单位毫秒。 仅在ALLOW_PRE_RENDER启用时生效。

LINE_FALLBACK_URL 

线路优先设置备流。为多线路场景设置备用流URL,提高播放质量和可用性。

◆ _SupportFeatureType

enum _SupportFeatureType : NSUInteger

功能支持类型枚举。用于查询播放器是否支持特定的硬件或软件功能。

通过这些类型可检查设备是否支持特定的高级音视频功能。

Enumerator
FeatureDolbyAudio 

杜比音频(Dolby Audio)支持。检查硬件是否支持杜比音频解码和输出。

◆ AVPAlphaRenderMode

enum AVPAlphaRenderMode : NSUInteger

Alpha渲染模式 用于处理包含Alpha通道(透明度)的视频帧。视频帧被划分为图像区域和Alpha通道区域, 播放器将根据指定的布局方式,从帧中分离出RGB图像和Alpha数据,并进行透明合成渲染。 常用于直播礼物、动态贴纸等需要透明叠加的场景。 可以参考 视频帧处理.

Enumerator
AVP_RENDERMODE_ALPHA_NONE 

无Alpha渲染。视频帧为普通RGB图像,不包含透明通道。

AVP_RENDERMODE_ALPHA_AT_RIGHT 

Alpha通道位于帧的右侧。视频帧的左半部分为RGB图像,右半部分为Alpha通道(灰度图)。 渲染时根据右侧Alpha值对左侧图像进行透明合成。

AVP_RENDERMODE_ALPHA_AT_LEFT 

Alpha通道位于帧的左侧。视频帧的右半部分为RGB图像,左半部分为Alpha通道(灰度图)。 渲染时根据左侧Alpha值对右侧图像进行透明合成。

AVP_RENDERMODE_ALPHA_AT_TOP 

Alpha通道位于帧的上侧。视频帧的下半部分为RGB图像,上半部分为Alpha通道(灰度图)。 渲染时根据上侧Alpha值对下侧图像进行透明合成。

AVP_RENDERMODE_ALPHA_AT_BOTTOM 

Alpha通道位于帧的下侧。视频帧的上半部分为RGB图像,下半部分为Alpha通道(灰度图)。 渲染时根据下侧Alpha值对上侧图像进行透明合成。

◆ AVPEventType

enum AVPEventType : NSUInteger

播放器事件类型

Enumerator
AVPEventPrepareDone 

准备完成事件

AVPEventAutoPlayStart 

自动启播事件

AVPEventFirstRenderedStart 

首帧显示事件

AVPEventCompletion 

播放完成事件

AVPEventLoadingStart 

缓冲开始事件

AVPEventLoadingEnd 

缓冲完成事件

AVPEventSeekEnd 

跳转完成事件

AVPEventLoopingStart 

循环播放开始事件

AVPEventClearScreenDone 

清屏完成事件

◆ AVPIpResolveType

enum AVPIpResolveType : NSUInteger

IP地址解析类型枚举。用于指定网络连接时使用的IP地址类型。

在DNS解析时,可指定优先使用IPv4或IPv6,或支持两者自动选择。

See also
AliPlayer::setIPResolveType
Enumerator
AVPIpResolveWhatEver 
AVPIpResolveV4 
AVPIpResolveV6 

◆ AVPLogLevel

enum AVPLogLevel : NSUInteger

日志级别枚举。用于控制播放器日志输出的详细程度。

日志级别从低到高分别为:NONE、FATAL、ERROR、WARNING、INFO、DEBUG、TRACE。 数值越大,输出的日志信息越详细。

Enumerator
LOG_LEVEL_NONE 
LOG_LEVEL_FATAL 
LOG_LEVEL_ERROR 
LOG_LEVEL_WARNING 
LOG_LEVEL_INFO 
LOG_LEVEL_DEBUG 
LOG_LEVEL_TRACE 

◆ AVPLogOption

enum AVPLogOption : NSUInteger

日志选项枚举。用于控制日志输出的特定功能。

通过这些选项可启用或禁用日志系统的特定功能。

Enumerator
FRAME_LEVEL_LOGGING_ENABLED 

启用帧级日志记录。当启用时,播放器将输出每一帧的详细日志信息。

◆ AVPMirrorMode

enum AVPMirrorMode : NSUInteger

镜像模式枚举。用于控制视频画面的镜像翻转效果。

支持水平镜像(左右翻转)和垂直镜像(上下翻转)两种效果。

Enumerator
AVP_MIRRORMODE_NONE 

无镜像。画面保持原始方向,不进行任何翻转。

AVP_MIRRORMODE_HORIZONTAL 

水平镜像(左右翻转)。画面沿垂直轴翻转,左右互换。

AVP_MIRRORMODE_VERTICAL 

垂直镜像(上下翻转)。画面沿水平轴翻转,上下颠倒。

◆ AVPMultiBitratesMode

enum AVPMultiBitratesMode : NSUInteger

多码率预加载类型,只对多码率HLS流生效

See also
AliListPlayer SetMultiBitratesMode
Enumerator
AVPMultiBitratesMode_Default 

默认配置,播放和预加载默认码率

AVPMultiBitratesMode_FCPrio 

首帧优先配置,起播视频默认播放已完成预加载的码率

AVPMultiBitratesMode_FC_AND_SMOOTH 

兼顾首帧和播放平滑,切换前后(moveToNext)的视频码率一致,且兼顾首帧性能

AVPMultiBitratesMode_SmoothPrio 

播放平滑优先配置,起播视频默认播放前一个视频的码率

◆ AVPNetworkLevel

enum AVPNetworkLevel : NSInteger
Enumerator
AVPNetwork_UNKNOWN 
AVPNetwork_EXCELLENT 

网络质量非常优秀。

AVPNetwork_GOOD 

网络质量良好。

AVPNetwork_POOR 

网络质量较差。

AVPNetwork_BAD 

网络质量很差。

AVPNetwork_VERY_BAD 

网络质量非常差。

AVPNetwork_DISCONNECTED 

网络已断开连接。

◆ AVPOption

enum AVPOption : NSUInteger

播放器可获取的选项枚举。用于实时查询播放器的性能指标。

通过这些选项可获取当前的渲染帧率、网络码率、视频码率等动态信息。

See also
AliPlayer getOption
Enumerator
AVP_OPTION_RENDER_FPS 

渲染的帧率(FPS)。返回值类型为Float,单位:帧/秒。

AVP_OPTION_DOWNLOAD_BITRATE 

当前的网络下行码率。返回值类型为Float,单位:bps(比特/秒)。

AVP_OPTION_VIDEO_BITRATE 

当前播放的视频码率。返回值类型为Float,单位:bps(比特/秒)。

AVP_OPTION_AUDIO_BITRATE 

当前播放的音频码率。返回值类型为Float,单位:bps(比特/秒)。

AVP_OPTION_IS_ABRSWITCHING 

自适应比特率(ABR)切换状态指示。返回值类型为Int。

在多码率HLS流且启用自动码率切换模式下,此选项用于判断当前是否处于ABR切换的状态。 返回"1"表示正在进行ABR切换,返回"0"表示未处于切换状态。

◆ AVPOutputAudioChannel

enum AVPOutputAudioChannel : NSUInteger

音频输出声道枚举。用于指定音频输出时选择的声道。

当输入音源为双声道(立体声)时,可通过此枚举选择仅输出左声道或右声道; 若输入为单声道,则此设置无效,音频将正常播放。

Enumerator
AVP_AUDIO_CHANNEL_NONE 

不指定声道,默认值

AVP_AUDIO_CHANNEL_LEFT 

左声道

AVP_AUDIO_CHANNEL_RIGHT 

右声道

◆ AVPPIPShowMode

enum AVPPIPShowMode : NSUInteger

画中画(PIP)显示模式枚举。用于控制画中画功能的UI展示方式。

定义了在启用画中画模式时,控制按钮的显示或隐藏方式。

See also
AliPlayer::setPictureinPictureShowMode
Enumerator
AVP_SHOW_MODE_DEFAULT 

默认模式。正常显示所有画中画相关按钮。

AVP_SHOW_MODE_HIDE_FAST_FORWARD_REWIND 

隐藏快进快退模式。隐藏快进/快退按钮。

◆ AVPPixelNumber

enum AVPPixelNumber : NSUInteger

特定分辨率的像素数量参考值枚举。

该枚举列举了常见视频分辨率对应的像素总数(宽×高)。 这些值可用于 AVPConfig::maxAllowedAbrVideoPixelNumber 的参考

Note
像素数量为参考值,仅供参考,实际分辨率可能略有差异。
Enumerator
Resolution_360P 
Resolution_480P 
Resolution_540P 
Resolution_720P 
Resolution_1080P 
Resolution_2K 
Resolution_4K 
Resolution_NoLimit 

◆ AVPPropertyKey

enum AVPPropertyKey : NSUInteger

获取播放器信息的关键字枚举。用于查询播放器的特定属性或统计信息。

通过这些关键字可获取HTTP响应信息、连接信息等调试和性能相关的数据。

See also
AliPlayer::getPropertyString
Enumerator
AVP_KEY_RESPONSE_INFO 

Http的response信息 返回的字符串是JSON数组,每个对象带response和type字段。type字段可以是url/video/audio/subtitle,根据流是否有相应Track返回。 例如:[{"response":"response string","type":"url"},{"response":"","type":"video"}].

AVP_KEY_CONNECT_INFO 

主URL的连接信息 返回的字符串是JSON对象,带url/ip/eagleID/cdnVia/cdncip/cdnsip等字段(如果解析不到则不添加) 例如:{"url":"http://xxx","openCost":23,"ip":"11.111.111.11","cdnVia":"xxx","cdncip":"22.222.222.22","cdnsip":"xxx"}

◆ AVPRotateMode

enum AVPRotateMode : NSUInteger

旋转模式枚举。用于控制视频画面的旋转角度。

所有旋转均为顺时针旋转。

Enumerator
AVP_ROTATE_0 

不旋转,0度。

AVP_ROTATE_90 

顺时针旋转90度。

AVP_ROTATE_180 

顺时针旋转180度。

AVP_ROTATE_270 

顺时针旋转270度。

◆ AVPScalingMode

enum AVPScalingMode : NSUInteger

缩放模式枚举。用于控制视频画面的缩放和填充方式。

定义了视频在显示区域内如何进行缩放、裁剪或拉伸的几种模式。

Enumerator
AVP_SCALINGMODE_SCALETOFILL 

不保持纵横比平铺(拉伸填充)。视频画面被拉伸以填满整个显示区域,可能导致画面变形。

AVP_SCALINGMODE_SCALEASPECTFIT 

保持纵横比,显示黑边(适应填充)。视频保持原始纵横比显示,空余区域用黑色填充。

AVP_SCALINGMODE_SCALEASPECTFILL 

保持纵横比填充,可能需要裁剪(裁剪填充)。视频保持纵横比,填满显示区域,超出部分被裁剪。

◆ AVPSceneType

enum AVPSceneType : NSInteger

播放场景类型枚举。用于指定媒体的播放场景,以便播放器优化相关配置。

阿里云播放器为不同场景预设了最优配置,通过指定场景类型可自动应用相应的优化策略, 无需手动调整各个配置参数。

See also
AliListPlayer::setScene
Enumerator
AVP_SCENE_NONE 

场景:无

AVP_VERY_SHOR_VIDEO 

超短视频场景:适用于30s以下

AVP_SHORT_VIDEO 

短视频场景:适用于30s-5min

AVP_MIDDLE_VIDEO 

中视频场景:适用于5min-30min

AVP_LONG_VIDEO 

长视频场景:适用于30min以上

◆ AVPSeekMode

enum AVPSeekMode : NSUInteger

跳转模式枚举。控制seek操作时是否精确定位。

精准seek会准确地跳转到指定的时间位置,但速度相对较慢。 不精准seek会跳转到指定时间位置之前的最近一个关键帧开始播放,速度较快, 但可能与指定位置存在偏差。

See also
AliPlayer::seekToTime
Enumerator
AVP_SEEKMODE_ACCURATE 

精确跳转模式。准确定位到指定的时间点。

AVP_SEEKMODE_INACCURATE 

非精确跳转模式。快速跳转到指定时间之前的关键帧。

◆ AVPStatus

enum AVPStatus : NSUInteger

播放器状态枚举

Enumerator
AVPStatusIdle 

空转,闲时,静态

AVPStatusInitialzed 

初始化完成

AVPStatusPrepared 

准备完成

AVPStatusStarted 

正在播放

AVPStatusPaused 

播放暂停

AVPStatusStopped 

播放停止

AVPStatusCompletion 

播放完成

AVPStatusError 

播放错误

◆ AVPStrategyType

enum AVPStrategyType : NSUInteger

策略类型

Enumerator
AVP_STRATEGY_DYNAMIC_PRELOAD 

动态预加载时长策略

◆ BizScene

enum BizScene : NSUInteger

自适应降级切换URL的应用场景枚举。用于标识URL切换发生在播放器还是预加载器中。

当播放器或预加载器因编码格式不支持(如H.265不支持)需要切换到备用URL时, 此枚举用于区分切换发生的具体场景。

See also
AliPlayerGlobalSettings::AdaptiveDecoderGetBackupURLCallback
Enumerator
AVP_Player 

播放器场景。URL切换发生在播放器中。

AVP_Loader 

预加载器场景。URL切换发生在预加载器中。

◆ CodecType

enum CodecType : NSUInteger

自适应降级时的原始URL编码格式枚举。

用于表示在自适应降级场景下,原始URL所对应的编码格式。 当编码格式不被支持时,播放器可基于此信息切换到备用URL。

See also
AliPlayerGlobalSettings::AdaptiveDecoderGetBackupURLCallback
Enumerator
AVP_H265 

H.265编码格式(HEVC)。