AVPDef.h File Reference

Classes
struct	_AVPStsInfo
	STS information structure. More...
class	AVPErrorModel
	AVPErrorModel represents playback error descriptions. More...
class	AVPNetworkStat
class	AVPTimeShiftModel
	AVPTimeShiftModel represents broadcasting timeshift descriptions. More...
class	AVPUrlResult
	URL refresh result. More...

Typedefs
typedef enum AVPAlphaRenderMode	AVPAlphaRenderMode
	Alpha rendering mode Used for rendering video frames that contain an alpha channel (transparency).
typedef enum BizScene	AVPBizScene
	Scenario enumeration for adaptive downgrade URL switching.
typedef enum CodecType	AVPCodecType
	Enumeration of the original URL codec format during adaptive degradation.
typedef enum AVPEventType	AVPEventType
	Player event type.
typedef enum AVPIpResolveType	AVPIpResolveType
	IP resolve type enumeration.
typedef enum AVPLogLevel	AVPLogLevel
	Log level enumeration.
typedef enum AVPLogOption	AVPLogOption
	Log option enumeration.
typedef enum AVPMirrorMode	AVPMirrorMode
	Mirroring mode enumeration.
typedef enum AVPMultiBitratesMode	AVPMultiBitratesMode
	multiBitrates preload mode, effect only on multiBitrates hls stream.
typedef enum AVPNetworkLevel	AVPNetworkLevel
typedef enum AVPOption	AVPOption
	Player option enumeration.
typedef enum AVPOutputAudioChannel	AVPOutputAudioChannel
	Output audio channel enumeration.
typedef enum AVPPIPShowMode	AVPPIPShowMode
	Picture-in-Picture (PIP) show mode enumeration.
typedef enum AVPPixelNumber	AVPPixelNumber
	Pixel number of specific resolution enumeration.
typedef enum AVPPropertyKey	AVPPropertyKey
	Property key enumeration for querying player information.
typedef enum AVPRotateMode	AVPRotateMode
	Rotate mode enumeration.
typedef enum AVPScalingMode	AVPScalingMode
	Scaling mode enumeration.
typedef enum _AVPScene	AVPScene
	Scene enumeration.
typedef enum AVPSceneType	AVPSceneType
	Scene type enumeration.
typedef enum AVPSeekMode	AVPSeekMode
	Seek mode enumeration.
typedef enum AVPStatus	AVPStatus
	Player status enumeration.
typedef enum AVPStrategyType	AVPStrategyType
	strategy type
typedef struct _AVPStsInfo	AVPStsInfo
	STS information structure.
typedef enum _AVPStsStatus	AVPStsStatus
	STS (Security Token Service) status enumeration.
typedef enum _GlobalOption	GlobalOption
	specified option on GlobalSettings.
typedef enum _PlayerOption	PlayerOption
	Player-specific option enumeration.
typedef bool(*	PlayURLConverCallback) (const char *srcURL, const char *srcFormat, char **destURL)
	Playback URL conversion callback function.
typedef enum _SupportFeatureType	SupportFeatureType
	Feature type enumeration.

Enumerations
enum	_AVPScene {   SceneNone , SceneLong , SceneMedium , SceneShort ,   SceneLive , SceneRTSLive }
	Scene enumeration. More...
enum	_AVPStsStatus { Valid , Invalid , Pending }
	STS (Security Token Service) status enumeration. 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 }
	specified option on GlobalSettings. 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 }
	Player-specific option enumeration. More...
enum	_SupportFeatureType : NSUInteger { FeatureDolbyAudio }
	Feature type enumeration. 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 rendering mode Used for rendering video frames that contain an alpha channel (transparency). More...
enum	AVPEventType : NSUInteger {   AVPEventPrepareDone , AVPEventAutoPlayStart , AVPEventFirstRenderedStart , AVPEventCompletion ,   AVPEventLoadingStart , AVPEventLoadingEnd , AVPEventSeekEnd , AVPEventLoopingStart ,   AVPEventClearScreenDone }
	Player event type. More...
enum	AVPIpResolveType : NSUInteger { AVPIpResolveWhatEver , AVPIpResolveV4 , AVPIpResolveV6 }
	IP resolve type enumeration. 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 }
	Log level enumeration. More...
enum	AVPLogOption : NSUInteger { FRAME_LEVEL_LOGGING_ENABLED = 1 }
	Log option enumeration. More...
enum	AVPMirrorMode : NSUInteger { AVP_MIRRORMODE_NONE , AVP_MIRRORMODE_HORIZONTAL , AVP_MIRRORMODE_VERTICAL }
	Mirroring mode enumeration. More...
enum	AVPMultiBitratesMode : NSUInteger { AVPMultiBitratesMode_Default = 0 , AVPMultiBitratesMode_FCPrio = 1 , AVPMultiBitratesMode_FC_AND_SMOOTH = 2 , AVPMultiBitratesMode_SmoothPrio = 3 }
	multiBitrates preload mode, effect only on multiBitrates hls stream. 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 }
	Player option enumeration. More...
enum	AVPOutputAudioChannel : NSUInteger { AVP_AUDIO_CHANNEL_NONE = 0 , AVP_AUDIO_CHANNEL_LEFT = 1 , AVP_AUDIO_CHANNEL_RIGHT = 2 }
	Output audio channel enumeration. More...
enum	AVPPIPShowMode : NSUInteger { AVP_SHOW_MODE_DEFAULT = 0 , AVP_SHOW_MODE_HIDE_FAST_FORWARD_REWIND = 1 }
	Picture-in-Picture (PIP) show mode enumeration. 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 }
	Pixel number of specific resolution enumeration. More...
enum	AVPPropertyKey : NSUInteger { AVP_KEY_RESPONSE_INFO = 0 , AVP_KEY_CONNECT_INFO = 1 }
	Property key enumeration for querying player information. More...
enum	AVPRotateMode : NSUInteger { AVP_ROTATE_0 = 0 , AVP_ROTATE_90 = 90 , AVP_ROTATE_180 = 180 , AVP_ROTATE_270 = 270 }
	Rotate mode enumeration. More...
enum	AVPScalingMode : NSUInteger { AVP_SCALINGMODE_SCALETOFILL , AVP_SCALINGMODE_SCALEASPECTFIT , AVP_SCALINGMODE_SCALEASPECTFILL }
	Scaling mode enumeration. 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 }
	Scene type enumeration. More...
enum	AVPSeekMode : NSUInteger { AVP_SEEKMODE_ACCURATE = 0x01 , AVP_SEEKMODE_INACCURATE = 0x10 }
	Seek mode enumeration. More...
enum	AVPStatus : NSUInteger {   AVPStatusIdle = 0 , AVPStatusInitialzed , AVPStatusPrepared , AVPStatusStarted ,   AVPStatusPaused , AVPStatusStopped , AVPStatusCompletion , AVPStatusError }
	Player status enumeration. More...
enum	AVPStrategyType : NSUInteger { AVP_STRATEGY_DYNAMIC_PRELOAD = 1 }
	strategy type More...
enum	BizScene : NSUInteger { AVP_Player = 0 , AVP_Loader = 1 }
	Scenario enumeration for adaptive downgrade URL switching. More...
enum	CodecType : NSUInteger { AVP_H265 = 0 }
	Enumeration of the original URL codec format during adaptive degradation. More...

Typedef Documentation

AVPAlphaRenderMode

typedef enum AVPAlphaRenderMode AVPAlphaRenderMode

Alpha rendering mode Used for rendering video frames that contain an alpha channel (transparency).

The video frame is split into an RGB image region and an alpha channel region. The player extracts both parts based on the specified layout and performs alpha blending. Commonly used for live-stream gifts, animated overlays, and other transparent effects. Please refer to Video frame processing

AVPBizScene

typedef enum BizScene AVPBizScene

Scenario enumeration for adaptive downgrade URL switching.

Identifies whether URL switching occurs in the player or preloader.

When the player or preloader needs to switch to a backup URL due to unsupported codec format (e.g., H.265 not supported), this enumeration distinguishes the specific scenario.

See also

AliPlayerGlobalSettings::AdaptiveDecoderGetBackupURLCallback

AVPCodecType

typedef enum CodecType AVPCodecType

Enumeration of the original URL codec format during adaptive degradation.

Used to represent the codec format of the original URL in adaptive degradation scenarios. When the codec format is not supported, the player can switch to a backup URL based on this information.

See also

AliPlayerGlobalSettings::AdaptiveDecoderGetBackupURLCallback

AVPEventType

typedef enum AVPEventType AVPEventType

Player event type.

AVPIpResolveType

typedef enum AVPIpResolveType AVPIpResolveType

IP resolve type enumeration.

Used to specify the type of IP address to use during network connections.

During DNS resolution, you can specify to prioritize IPv4 or IPv6, or allow automatic selection of both.

See also

AliPlayer::setIPResolveType

AVPLogLevel

typedef enum AVPLogLevel AVPLogLevel

Log level enumeration.

Used to control the verbosity of player log output.

Log levels from lowest to highest are: NONE, FATAL, ERROR, WARNING, INFO, DEBUG, TRACE. Higher values result in more detailed log output.

AVPLogOption

typedef enum AVPLogOption AVPLogOption

Log option enumeration.

Used to control specific features of log output.

These options enable or disable specific features of the logging system.

AVPMirrorMode

typedef enum AVPMirrorMode AVPMirrorMode

Mirroring mode enumeration.

Used to control video frame mirroring (flip) effect.

AVPMultiBitratesMode

typedef enum AVPMultiBitratesMode AVPMultiBitratesMode

multiBitrates preload mode, effect only on multiBitrates hls stream.

See also

AliListPlayer SetMultiBitratesMode

AVPNetworkLevel

typedef enum AVPNetworkLevel AVPNetworkLevel

AVPOption

typedef enum AVPOption AVPOption

Player option enumeration.

Used to query player performance metrics in real-time.

See also

AliPlayer getOption

These options allow you to retrieve current rendering frame rate, network bitrate, video bitrate, and other dynamic information.

AVPOutputAudioChannel

typedef enum AVPOutputAudioChannel AVPOutputAudioChannel

Output audio channel enumeration.

Used to specify which audio channel to output.

When the input audio source is stereo, you can select to output only the left or right channel. If the input is mono, this setting has no effect and audio plays normally.

AVPPIPShowMode

typedef enum AVPPIPShowMode AVPPIPShowMode

Picture-in-Picture (PIP) show mode enumeration.

Used to control the UI display method of the picture-in-picture feature.

Defines how control buttons are shown or hidden when picture-in-picture mode is enabled.

See also

AliPlayer::setPictureinPictureShowMode

AVPPixelNumber

typedef enum AVPPixelNumber AVPPixelNumber

Pixel number of specific resolution enumeration.

This enumeration lists the number of pixels for common video resolutions. These values can be used as reference values for AVPConfig::maxAllowedAbrVideoPixelNumber.

Note

Pixel numbers are reference values for informational purposes only. Actual resolutions may vary slightly.

AVPPropertyKey

typedef enum AVPPropertyKey AVPPropertyKey

Property key enumeration for querying player information.

Used to retrieve specific player properties or statistical information.

These keys allow you to obtain HTTP response information, connection information, and other debugging and performance-related data.

See also

AliPlayer::getPropertyString

AVPRotateMode

typedef enum AVPRotateMode AVPRotateMode

Rotate mode enumeration.

Used to control video frame rotation angle (clockwise).

AVPScalingMode

typedef enum AVPScalingMode AVPScalingMode

Scaling mode enumeration.

Used to control video frame scaling and filling mode.

AVPScene

typedef enum _AVPScene AVPScene

Scene enumeration.

Used to specify the most suitable scene configuration for the player.

The player automatically applies optimized configuration strategies based on the specified scene, without requiring manual parameter adjustment by developers.

See also

AliPlayer::setPlayerScene

AVPSceneType

typedef enum AVPSceneType AVPSceneType

Scene type enumeration.

Used to specify the playback scenario, allowing the player to optimize relevant configurations.

The Alibaba Cloud player has preset optimal configurations for different scenarios. By specifying the scene type, corresponding optimization strategies are automatically applied without manual adjustment of individual configuration parameters.

See also

AliListPlayer::setScene

AVPSeekMode

typedef enum AVPSeekMode AVPSeekMode

Seek mode enumeration.

Controls whether to seek to the exact specified position.

Accurate seeking will seek to the exact specified time position but is relatively slower. Inaccurate seeking will seek to the nearest keyframe before the specified position and start playback, which is faster but may have a deviation from the specified position.

See also

AliPlayer::seekToTime

AVPStatus

typedef enum AVPStatus AVPStatus

Player status enumeration.

AVPStrategyType

typedef enum AVPStrategyType AVPStrategyType

strategy type

AVPStsInfo

typedef struct _AVPStsInfo AVPStsInfo

STS information structure.

Used to store credentials related to temporary security tokens.

Contains information such as access ID, access key, security token, region, and format, used for authentication and authorization to access Alibaba Cloud resources.

AVPStsStatus

typedef enum _AVPStsStatus AVPStsStatus

STS (Security Token Service) status enumeration.

Used to represent the validity status of STS tokens.

GlobalOption

typedef enum _GlobalOption GlobalOption

specified option on GlobalSettings.

Used to configure options for player global behavior. +setOption:valueInt:

PlayerOption

typedef enum _PlayerOption PlayerOption

Player-specific option enumeration.

Used to configure behavior options for individual player instances.

These options can be set after creating the player, and each player instance can be configured independently.

See also

AliPlayer::setOption

PlayURLConverCallback

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

Playback URL conversion callback function.

Parameters

srcURL	[in] Input original URL string, must not be NULL.
srcFormat	[in] Format of the input URL, typically "m3u8", "mp4", or other format identifiers. Empty string if format is unknown.
destURL	[out] Output converted URL string. The function is responsible for memory allocation, and the caller must release this memory after use.

Returns

true indicates successful URL conversion; false indicates conversion failure. On failure, the player will continue with the original URL.

See also

AliPlayer::setPlayUrlConvertCallback

SupportFeatureType

typedef enum _SupportFeatureType SupportFeatureType

Feature type enumeration.

Used to query whether the player supports specific hardware or software features.

These types allow you to check if the device supports specific advanced audio and video features.

Enumeration Type Documentation

_AVPScene

enum _AVPScene

Scene enumeration.

Used to specify the most suitable scene configuration for the player.

The player automatically applies optimized configuration strategies based on the specified scene, without requiring manual parameter adjustment by developers.

See also

AliPlayer::setPlayerScene

Enumerator
SceneNone	scene none
SceneLong	long scene: apply to more than 30min
SceneMedium	middle scene: apply to 5min-30min
SceneShort	short scene: apply to 0s-5min
SceneLive	live scene
SceneRTSLive	RTS live scene.

_AVPStsStatus

enum _AVPStsStatus

STS (Security Token Service) status enumeration.

Used to represent the validity status of STS tokens.

Enumerator
Valid	Valid. The STS token has been obtained and is still within its validity period.
Invalid	Invalid. The STS token has expired or cannot be used.
Pending	Pending. The STS token is being obtained and is temporarily unavailable.

_GlobalOption

enum _GlobalOption : NSUInteger

specified option on GlobalSettings.

Used to configure options for player global behavior. +setOption:valueInt:

Enumerator
SET_PRE_CONNECT_DOMAIN	Pre-connect domain option . Sets the domain for pre-connection to optimize initial connection speed.
SET_DNS_PRIORITY_LOCAL_FIRST	DNS local-first resolution option . When enabled, DNS resolution prioritizes local DNS over remote DNS.
ENABLE_H2_MULTIPLEX	Enable HTTP/2 multiplexing option. Enables HTTP/2 protocol multiplexing to improve network transmission efficiency. +setOption:valueInt:@endlink
SET_EXTRA_DATA	Set extra data option . Used to pass custom extra data to the player internals.
ENABLE_ANDROID_DECODE_REUSE	Enable Android decoder reuse option (Android only) . Android-specific placeholder option for enabling decoder reuse functionality.
NOT_PAUSE_WHEN_PREPARING	Do not pause when preparing option . When enabled, playback will not pause during preparation.
ALLOW_RTS_DEGRADE	Allow RTS degradation option . Allows Real-time Streaming (RTS) to degrade to normal live streaming mode when necessary.
ENABLE_DECODER_FAST_FIRST_FRAME	Enable decoder fast first frame option . Optimizes decoder initialization to accelerate first frame display.
DISABLE_CAPTURE_SCALE	Disable capture scaling option . Disables automatic scaling during screenshot capture.
ALLOW_BOUNDS_CHANGE_ANIMATION	Allow bounds change animation option (iOS only) . iOS-specific option that allows animation effects when view bounds change.
AV3A_DECODE_MODEL_PATH	AV3A decode model path option . Specifies the file path for the AV3A decoding model.
RENDER_IGNORE_DAR_SCALE	Ignore DAR scaling option (iOS only) . iOS-specific option that ignores Display Aspect Ratio (DAR) scaling processing.
MAX_ERROR_FRAMES_HARDWARE_DECODE	Maximum error frames for hardware decoding option . Sets the maximum number of consecutive error frames allowed for hardware decoder before triggering fallback.
ALLOW_AUDIOUNIT	Allow AudioUnit option (iOS only) . iOS-specific option that allows using AudioUnit for audio processing.
DISABLE_CATCHUP_IN_LOWLATENCY_AUDIOQUEUE	Disable catch-up in low-latency audio queue option (iOS only) . iOS-specific option that disables catch-up mechanism in low-latency audio queue.
ENABLE_URL_REFRESH_ON_FORBIDDEN	Enable URL refresh on Forbidden error option . Automatically triggers URL refresh mechanism when receiving HTTP 403 Forbidden error.
ENABLE_PARSE_VTT_DIALOGUE_CUE_BY_JSON	Enable VTT dialogue cue parsing by JSON option . When enabled, dialogue cues in VTT subtitles will be parsed in JSON format.

_PlayerOption

enum _PlayerOption : NSUInteger

Player-specific option enumeration.

Used to configure behavior options for individual player instances.

These options can be set after creating the player, and each player instance can be configured independently.

See also

AliPlayer::setOption

Enumerator
SET_MEDIA_TYPE
ALLOW_DECODE_BACKGROUND	Allow decode in background. Continue video decoding when the app enters the background, maintaining playback state.
ALLOW_PRE_RENDER	Allow pre-render. Enables pre-rendering of video frames to accelerate first frame display.
PLAYED_DURATION_INCLUDE_SPEED	Played duration includes playback speed. Playback duration calculation takes playback speed into account. See also - getPlayedDuration (AliPlayer)
PRE_RENDER_MAX_BUFFER_MS	Pre-render maximum buffer duration in milliseconds. Specifies the maximum buffer duration for the pre-rendering feature. Only effective when ALLOW_PRE_RENDER is enabled.
LINE_FALLBACK_URL	Line fallback URL. Sets backup stream URL for multi-line scenarios to improve playback quality and availability.

_SupportFeatureType

enum _SupportFeatureType : NSUInteger

Feature type enumeration.

Used to query whether the player supports specific hardware or software features.

These types allow you to check if the device supports specific advanced audio and video features.

Enumerator
FeatureDolbyAudio	Dolby Audio support. Checks whether the hardware supports Dolby Audio decoding and output.

AVPAlphaRenderMode

enum AVPAlphaRenderMode : NSUInteger

Alpha rendering mode Used for rendering video frames that contain an alpha channel (transparency).

The video frame is split into an RGB image region and an alpha channel region. The player extracts both parts based on the specified layout and performs alpha blending. Commonly used for live-stream gifts, animated overlays, and other transparent effects. Please refer to Video frame processing

Enumerator
AVP_RENDERMODE_ALPHA_NONE	No alpha rendering. The video frame is a standard RGB image without transparency.
AVP_RENDERMODE_ALPHA_AT_RIGHT	Alpha channel is on the right side of the frame. The left half contains the RGB image, and the right half contains the alpha channel (grayscale). The player uses the right-side alpha values to blend the left-side image with transparency.
AVP_RENDERMODE_ALPHA_AT_LEFT	Alpha channel is on the left side of the frame. The right half contains the RGB image, and the left half contains the alpha channel (grayscale). The player uses the left-side alpha values to blend the right-side image with transparency.
AVP_RENDERMODE_ALPHA_AT_TOP	Alpha channel is on the top of the frame. The bottom half contains the RGB image, and the top half contains the alpha channel (grayscale). The player uses the top-side alpha values to blend the bottom-side image with transparency.
AVP_RENDERMODE_ALPHA_AT_BOTTOM	Alpha channel is on the bottom of the frame. The top half contains the RGB image, and the bottom half contains the alpha channel (grayscale). The player uses the bottom-side alpha values to blend the top-side image with transparency.

AVPEventType

enum AVPEventType : NSUInteger

Player event type.

Enumerator
AVPEventPrepareDone	Preparation completion event.
AVPEventAutoPlayStart	Autoplay start event.
AVPEventFirstRenderedStart	First frame display event.
AVPEventCompletion	Playback completion event.
AVPEventLoadingStart	Buffer start event.
AVPEventLoadingEnd	Buffer completion event.
AVPEventSeekEnd	Seeking completion event.
AVPEventLoopingStart	Loop playback start event.
AVPEventClearScreenDone	clear screen done event

AVPIpResolveType

enum AVPIpResolveType : NSUInteger

IP resolve type enumeration.

Used to specify the type of IP address to use during network connections.

During DNS resolution, you can specify to prioritize IPv4 or IPv6, or allow automatic selection of both.

See also

AliPlayer::setIPResolveType

Enumerator
AVPIpResolveWhatEver
AVPIpResolveV4
AVPIpResolveV6

AVPLogLevel

enum AVPLogLevel : NSUInteger

Log level enumeration.

Used to control the verbosity of player log output.

Log levels from lowest to highest are: NONE, FATAL, ERROR, WARNING, INFO, DEBUG, TRACE. Higher values result in more detailed log output.

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

Log option enumeration.

Used to control specific features of log output.

These options enable or disable specific features of the logging system.

Enumerator
FRAME_LEVEL_LOGGING_ENABLED	Frame-level logging enabled. When enabled, the player outputs detailed log information for each frame.

AVPMirrorMode

enum AVPMirrorMode : NSUInteger

Mirroring mode enumeration.

Used to control video frame mirroring (flip) effect.

Enumerator
AVP_MIRRORMODE_NONE	No mirroring. The video is displayed in its original orientation.
AVP_MIRRORMODE_HORIZONTAL	Horizontal mirroring (left-right flip). The video is flipped along the vertical axis.
AVP_MIRRORMODE_VERTICAL	Vertical mirroring (top-bottom flip). The video is flipped along the horizontal axis.

AVPMultiBitratesMode

enum AVPMultiBitratesMode : NSUInteger

multiBitrates preload mode, effect only on multiBitrates hls stream.

See also

AliListPlayer SetMultiBitratesMode

Enumerator
AVPMultiBitratesMode_Default	default mode, play and preload default bitrate of a stream
AVPMultiBitratesMode_FCPrio	First frame cost (FC) priority, decrease first frame cost. only play bitrate of the hls stream which has been preloaded.
AVPMultiBitratesMode_FC_AND_SMOOTH	First frame and play smooth, play the same bitrate before and after moveToNext.
AVPMultiBitratesMode_SmoothPrio	Play Smooth priority, play the same bitrate before and after moveToNext.

AVPNetworkLevel

enum AVPNetworkLevel : NSInteger

Enumerator
AVPNetwork_UNKNOWN
AVPNetwork_EXCELLENT	The network quality is excellent.
AVPNetwork_GOOD	The network quality is good.
AVPNetwork_POOR	The network quality is poor.
AVPNetwork_BAD	The network quality is bad.
AVPNetwork_VERY_BAD	The network quality is very bad.
AVPNetwork_DISCONNECTED	The network is disconnected.

AVPOption

enum AVPOption : NSUInteger

Player option enumeration.

Used to query player performance metrics in real-time.

See also

AliPlayer getOption

These options allow you to retrieve current rendering frame rate, network bitrate, video bitrate, and other dynamic information.

Enumerator
AVP_OPTION_RENDER_FPS	Rendering frame rate (FPS). Return value type is Float, unit: frames per second.
AVP_OPTION_DOWNLOAD_BITRATE	Current network download bitrate. Return value type is Float, unit: bps (bits per second).
AVP_OPTION_VIDEO_BITRATE	Current video playback bitrate. Return value type is Float, unit: bps (bits per second).
AVP_OPTION_AUDIO_BITRATE	Current audio playback bitrate. Return value type is Float, unit: bps (bits per second).
AVP_OPTION_IS_ABRSWITCHING	Adaptive Bitrate (ABR) switching state indicator. Return value type is Int. For multi-bitrate HLS streams with automatic bitrate switching enabled, this option determines whether the player is currently undergoing ABR switching. Returns "1" if ABR switching is in progress; returns "0" if not switching.

AVPOutputAudioChannel

enum AVPOutputAudioChannel : NSUInteger

Output audio channel enumeration.

Used to specify which audio channel to output.

When the input audio source is stereo, you can select to output only the left or right channel. If the input is mono, this setting has no effect and audio plays normally.

Enumerator
AVP_AUDIO_CHANNEL_NONE	Not specified, default value.
AVP_AUDIO_CHANNEL_LEFT	Left audio channel.
AVP_AUDIO_CHANNEL_RIGHT	Right audio channel.

AVPPIPShowMode

enum AVPPIPShowMode : NSUInteger

Picture-in-Picture (PIP) show mode enumeration.

Used to control the UI display method of the picture-in-picture feature.

Defines how control buttons are shown or hidden when picture-in-picture mode is enabled.

See also

AliPlayer::setPictureinPictureShowMode

Enumerator
AVP_SHOW_MODE_DEFAULT	Default mode. All picture-in-picture related buttons are displayed normally.
AVP_SHOW_MODE_HIDE_FAST_FORWARD_REWIND	Hide fast forward and fast rewind mode. Hides fast forward/rewind buttons.

AVPPixelNumber

enum AVPPixelNumber : NSUInteger

Pixel number of specific resolution enumeration.

This enumeration lists the number of pixels for common video resolutions. These values can be used as reference values for AVPConfig::maxAllowedAbrVideoPixelNumber.

Note

Pixel numbers are reference values for informational purposes only. Actual resolutions may vary slightly.

Enumerator
Resolution_360P
Resolution_480P
Resolution_540P
Resolution_720P
Resolution_1080P
Resolution_2K
Resolution_4K
Resolution_NoLimit

AVPPropertyKey

enum AVPPropertyKey : NSUInteger

Property key enumeration for querying player information.

Used to retrieve specific player properties or statistical information.

These keys allow you to obtain HTTP response information, connection information, and other debugging and performance-related data.

See also

AliPlayer::getPropertyString

Enumerator
AVP_KEY_RESPONSE_INFO	Http response info Return with JSON array，each object item include 'response'/'type' filed。'type' could be url/video/audio/subtitle, depend on the stream whether have the tracks。 For example: [{"response":"response string","type":"url"},{"response":"","type":"video"}].
AVP_KEY_CONNECT_INFO	Major URL connect information Return with JSON object，include sub fileds such as url/ip/eagleID/cdnVia/cdncip/cdnsip. For example: {"url":"http://xxx","openCost":23,"ip":"11.111.111.11","cdnVia":"xxx","cdncip":"22.222.222.22","cdnsip":"xxx"}

AVPRotateMode

enum AVPRotateMode : NSUInteger

Rotate mode enumeration.

Used to control video frame rotation angle (clockwise).

Enumerator
AVP_ROTATE_0	No rotation, 0 degrees.
AVP_ROTATE_90	Rotate 90 degrees clockwise.
AVP_ROTATE_180	Rotate 180 degrees clockwise.
AVP_ROTATE_270	Rotate 270 degrees clockwise.

AVPScalingMode

enum AVPScalingMode : NSUInteger

Scaling mode enumeration.

Used to control video frame scaling and filling mode.

Enumerator
AVP_SCALINGMODE_SCALETOFILL	Auto stretch to fit. The video is stretched to fill the entire display area without preserving aspect ratio, which may cause distortion.
AVP_SCALINGMODE_SCALEASPECTFIT	Keep aspect ratio and add black borders. The video maintains its original aspect ratio; empty areas are filled with black.
AVP_SCALINGMODE_SCALEASPECTFILL	Keep aspect ratio and crop. The video maintains its aspect ratio and fills the display area; any parts exceeding the display area are cropped.

AVPSceneType

enum AVPSceneType : NSInteger

Scene type enumeration.

Used to specify the playback scenario, allowing the player to optimize relevant configurations.

The Alibaba Cloud player has preset optimal configurations for different scenarios. By specifying the scene type, corresponding optimization strategies are automatically applied without manual adjustment of individual configuration parameters.

See also

AliListPlayer::setScene

Enumerator
AVP_SCENE_NONE	scene none
AVP_VERY_SHOR_VIDEO	very short scene: apply to less 30s
AVP_SHORT_VIDEO	short scene: apply to 30-5min
AVP_MIDDLE_VIDEO	middle scene: apply to 5min-30min
AVP_LONG_VIDEO	long scene: apply to more than 30min

AVPSeekMode

enum AVPSeekMode : NSUInteger

Seek mode enumeration.

Controls whether to seek to the exact specified position.

Accurate seeking will seek to the exact specified time position but is relatively slower. Inaccurate seeking will seek to the nearest keyframe before the specified position and start playback, which is faster but may have a deviation from the specified position.

See also

AliPlayer::seekToTime

Enumerator
AVP_SEEKMODE_ACCURATE	Accurate seeking mode. Seeks to the exact specified time position.
AVP_SEEKMODE_INACCURATE	Inaccurate seeking mode. Quickly seeks to a keyframe before the specified time.

AVPStatus

enum AVPStatus : NSUInteger

Player status enumeration.

Enumerator
AVPStatusIdle	Idle.
AVPStatusInitialzed	Initialized.
AVPStatusPrepared	Prepared.
AVPStatusStarted	Playing.
AVPStatusPaused	Paused.
AVPStatusStopped	Stopped.
AVPStatusCompletion	Completed.
AVPStatusError	Error.

AVPStrategyType

enum AVPStrategyType : NSUInteger

strategy type

Enumerator
AVP_STRATEGY_DYNAMIC_PRELOAD	dynamic preload duration strategy.

BizScene

enum BizScene : NSUInteger

Scenario enumeration for adaptive downgrade URL switching.

Identifies whether URL switching occurs in the player or preloader.

When the player or preloader needs to switch to a backup URL due to unsupported codec format (e.g., H.265 not supported), this enumeration distinguishes the specific scenario.

See also

AliPlayerGlobalSettings::AdaptiveDecoderGetBackupURLCallback

Enumerator
AVP_Player	Player scenario. URL switching occurs in the player.
AVP_Loader	Preloader scenario. URL switching occurs in the preloader.

CodecType

enum CodecType : NSUInteger

Enumeration of the original URL codec format during adaptive degradation.

Used to represent the codec format of the original URL in adaptive degradation scenarios. When the codec format is not supported, the player can switch to a backup URL based on this information.

See also

AliPlayerGlobalSettings::AdaptiveDecoderGetBackupURLCallback

Enumerator
AVP_H265	H.265 codec format (HEVC).