![]() |
AliyunPlayer v7.10.0
Aliyun Player API Reference Manual for iOS Platforms
|
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 |
| 功能支持类型枚举。用于查询播放器是否支持特定的硬件或软件功能。 | |
| typedef enum AVPAlphaRenderMode AVPAlphaRenderMode |
Alpha渲染模式 用于处理包含Alpha通道(透明度)的视频帧。视频帧被划分为图像区域和Alpha通道区域, 播放器将根据指定的布局方式,从帧中分离出RGB图像和Alpha数据,并进行透明合成渲染。 常用于直播礼物、动态贴纸等需要透明叠加的场景。 可以参考 视频帧处理.
| typedef enum BizScene AVPBizScene |
自适应降级切换URL的应用场景枚举。用于标识URL切换发生在播放器还是预加载器中。
当播放器或预加载器因编码格式不支持(如H.265不支持)需要切换到备用URL时, 此枚举用于区分切换发生的具体场景。
| typedef enum CodecType AVPCodecType |
自适应降级时的原始URL编码格式枚举。
用于表示在自适应降级场景下,原始URL所对应的编码格式。 当编码格式不被支持时,播放器可基于此信息切换到备用URL。
| typedef enum AVPEventType AVPEventType |
播放器事件类型
| typedef enum AVPIpResolveType AVPIpResolveType |
IP地址解析类型枚举。用于指定网络连接时使用的IP地址类型。
在DNS解析时,可指定优先使用IPv4或IPv6,或支持两者自动选择。
| typedef enum AVPLogLevel AVPLogLevel |
日志级别枚举。用于控制播放器日志输出的详细程度。
日志级别从低到高分别为:NONE、FATAL、ERROR、WARNING、INFO、DEBUG、TRACE。 数值越大,输出的日志信息越详细。
| typedef enum AVPLogOption AVPLogOption |
日志选项枚举。用于控制日志输出的特定功能。
通过这些选项可启用或禁用日志系统的特定功能。
| typedef enum AVPMirrorMode AVPMirrorMode |
镜像模式枚举。用于控制视频画面的镜像翻转效果。
支持水平镜像(左右翻转)和垂直镜像(上下翻转)两种效果。
| typedef enum AVPMultiBitratesMode AVPMultiBitratesMode |
多码率预加载类型,只对多码率HLS流生效
| typedef enum AVPNetworkLevel AVPNetworkLevel |
| typedef enum AVPOutputAudioChannel AVPOutputAudioChannel |
音频输出声道枚举。用于指定音频输出时选择的声道。
当输入音源为双声道(立体声)时,可通过此枚举选择仅输出左声道或右声道; 若输入为单声道,则此设置无效,音频将正常播放。
| typedef enum AVPPIPShowMode AVPPIPShowMode |
画中画(PIP)显示模式枚举。用于控制画中画功能的UI展示方式。
定义了在启用画中画模式时,控制按钮的显示或隐藏方式。
| typedef enum AVPPixelNumber AVPPixelNumber |
特定分辨率的像素数量参考值枚举。
该枚举列举了常见视频分辨率对应的像素总数(宽×高)。 这些值可用于 AVPConfig::maxAllowedAbrVideoPixelNumber 的参考
| typedef enum AVPPropertyKey AVPPropertyKey |
获取播放器信息的关键字枚举。用于查询播放器的特定属性或统计信息。
通过这些关键字可获取HTTP响应信息、连接信息等调试和性能相关的数据。
| typedef enum AVPRotateMode AVPRotateMode |
旋转模式枚举。用于控制视频画面的旋转角度。
所有旋转均为顺时针旋转。
| typedef enum AVPScalingMode AVPScalingMode |
缩放模式枚举。用于控制视频画面的缩放和填充方式。
定义了视频在显示区域内如何进行缩放、裁剪或拉伸的几种模式。
播放场景枚举。用于为播放器指定最适合的播放场景配置。
播放器会根据指定的场景自动应用优化的配置策略, 无需开发者手动调整各个参数。
| typedef enum AVPSceneType AVPSceneType |
播放场景类型枚举。用于指定媒体的播放场景,以便播放器优化相关配置。
阿里云播放器为不同场景预设了最优配置,通过指定场景类型可自动应用相应的优化策略, 无需手动调整各个配置参数。
| typedef enum AVPSeekMode AVPSeekMode |
跳转模式枚举。控制seek操作时是否精确定位。
精准seek会准确地跳转到指定的时间位置,但速度相对较慢。 不精准seek会跳转到指定时间位置之前的最近一个关键帧开始播放,速度较快, 但可能与指定位置存在偏差。
| typedef enum AVPStrategyType AVPStrategyType |
策略类型
| typedef struct _AVPStsInfo AVPStsInfo |
STS信息结构体。用于存储临时安全令牌相关的凭证信息。
包含访问ID、访问密钥、安全令牌、地域和格式等信息, 用于身份验证和授权访问阿里云资源。
| typedef enum _AVPStsStatus AVPStsStatus |
STS(临时安全令牌)状态枚举。用于表示STS令牌的有效状态。
| typedef enum _GlobalOption GlobalOption |
<<<<<<< Updated upstream
GlobalSettings的特定功能选项。全局设置选项枚举。用于配置播放器全局行为的选项。 +setOption:valueInt:
| typedef enum _PlayerOption PlayerOption |
播放器特定功能选项枚举。用于配置单个播放器实例的行为选项。
这些选项可在创建播放器后进行设置,每个播放器实例可单独配置。
| typedef bool(* PlayURLConverCallback) (const char *srcURL, const char *srcFormat, char **destURL) |
播放URL转换回调函数
| srcURL | [in] 输入的原始URL字符串,不能为NULL。 |
| srcFormat | [in] 输入URL的格式,通常为"m3u8"、"mp4"或其他格式标识,格式未知时为空字符串。 |
| destURL | [out] 输出的转换后URL字符串。函数需负责分配内存,调用者需在使用后释放该内存。 |
| typedef enum _SupportFeatureType SupportFeatureType |
功能支持类型枚举。用于查询播放器是否支持特定的硬件或软件功能。
通过这些类型可检查设备是否支持特定的高级音视频功能。
| enum _AVPScene |
| enum _AVPStsStatus |
| 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 格式进行解析。 |
| enum _PlayerOption : NSUInteger |
播放器特定功能选项枚举。用于配置单个播放器实例的行为选项。
这些选项可在创建播放器后进行设置,每个播放器实例可单独配置。
| Enumerator | |
|---|---|
| SET_MEDIA_TYPE | |
| ALLOW_DECODE_BACKGROUND | 允许后台解码。在应用进入后台时继续进行视频解码,保持播放状态。 |
| ALLOW_PRE_RENDER | 允许预渲染。启用视频帧的预先渲染,加速首帧显示。 |
| PLAYED_DURATION_INCLUDE_SPEED | 播放时长包含播放速度。计算播放时长时考虑播放倍速的影响。
|
| PRE_RENDER_MAX_BUFFER_MS | 预渲染最大缓冲时长。指定预渲染功能的最大缓冲时长,单位毫秒。 仅在ALLOW_PRE_RENDER启用时生效。 |
| LINE_FALLBACK_URL | 线路优先设置备流。为多线路场景设置备用流URL,提高播放质量和可用性。 |
| enum _SupportFeatureType : NSUInteger |
| enum AVPAlphaRenderMode : NSUInteger |
Alpha渲染模式 用于处理包含Alpha通道(透明度)的视频帧。视频帧被划分为图像区域和Alpha通道区域, 播放器将根据指定的布局方式,从帧中分离出RGB图像和Alpha数据,并进行透明合成渲染。 常用于直播礼物、动态贴纸等需要透明叠加的场景。 可以参考 视频帧处理.
| enum AVPEventType : NSUInteger |
| enum AVPIpResolveType : NSUInteger |
| enum AVPLogLevel : NSUInteger |
| enum AVPLogOption : NSUInteger |
| enum AVPMirrorMode : NSUInteger |
| enum AVPMultiBitratesMode : NSUInteger |
多码率预加载类型,只对多码率HLS流生效
| enum AVPNetworkLevel : NSInteger |
| enum AVPOption : NSUInteger |
播放器可获取的选项枚举。用于实时查询播放器的性能指标。
通过这些选项可获取当前的渲染帧率、网络码率、视频码率等动态信息。
| enum AVPOutputAudioChannel : NSUInteger |
| enum AVPPIPShowMode : NSUInteger |
| enum AVPPixelNumber : NSUInteger |
特定分辨率的像素数量参考值枚举。
该枚举列举了常见视频分辨率对应的像素总数(宽×高)。 这些值可用于 AVPConfig::maxAllowedAbrVideoPixelNumber 的参考
| Enumerator | |
|---|---|
| Resolution_360P | |
| Resolution_480P | |
| Resolution_540P | |
| Resolution_720P | |
| Resolution_1080P | |
| Resolution_2K | |
| Resolution_4K | |
| Resolution_NoLimit | |
| enum AVPPropertyKey : NSUInteger |
获取播放器信息的关键字枚举。用于查询播放器的特定属性或统计信息。
通过这些关键字可获取HTTP响应信息、连接信息等调试和性能相关的数据。
| enum AVPRotateMode : NSUInteger |
| enum AVPScalingMode : NSUInteger |
| enum AVPSceneType : NSInteger |
| enum AVPSeekMode : NSUInteger |
| enum AVPStatus : NSUInteger |
| enum AVPStrategyType : NSUInteger |
| enum BizScene : NSUInteger |
| enum CodecType : NSUInteger |