AVPDef.h File Reference

import <Foundation/Foundation.h>
import "AVPErrorCode.h"

Classes
struct	_AVPStsInfo
class	AVPErrorModel
	AVPErrorModel represents playback error descriptions. More...
class	AVPTimeShiftModel
	AVPTimeShiftModel represents broadcasting timeshift descriptions. More...

Typedefs
typedef enum AVPAlphaRenderMode	AVPAlphaRenderMode
	Rendring mode.
typedef enum BizScene	AVPBizScene
	Scenario of adaptive downgrade switching URL, player or preloader.
typedef enum CodecType	AVPCodecType
	The original URL encoding format for adaptive downgrade switching URL.
typedef enum AVPEventType	AVPEventType
	Player event type.
typedef enum AVPIpResolveType	AVPIpResolveType
typedef enum AVPLogLevel	AVPLogLevel
typedef enum AVPLogOption	AVPLogOption
typedef enum AVPMirrorMode	AVPMirrorMode
	Mirroring mode.
typedef enum AVPMultiBitratesMode	AVPMultiBitratesMode
	multiBitrates preload mode, effect only on multiBitrates hls stream.
typedef enum AVPOption	AVPOption
typedef enum AVPOutputAudioChannel	AVPOutputAudioChannel
	Output audio channel.
typedef enum AVPPIPShowMode	AVPPIPShowMode
	picture in picture show mode
typedef enum AVPPixelNumber	AVPPixelNumber
typedef enum AVPPropertyKey	AVPPropertyKey
	The key to get property.
typedef enum AVPRotateMode	AVPRotateMode
	Rotate mode.
typedef enum AVPScalingMode	AVPScalingMode
	Zoom mode.
typedef enum AVPSceneType	AVPSceneType
	scene type
typedef enum AVPSeekMode	AVPSeekMode
	Seeking mode: accurate seeking or inaccurate seeking.
typedef enum AVPStatus	AVPStatus
typedef enum AVPStrategyType	AVPStrategyType
	strategy type
typedef struct _AVPStsInfo	AVPStsInfo
typedef enum _AVPStsStatus	AVPStsStatus
typedef enum _GlobalOption	GlobalOption
	specified option on GlobalSettings
typedef enum _PlayerOption	PlayerOption
	specified option on AliPlayer
typedef bool(*	PlayURLConverCallback) (const char *srcURL, const char *srcFormat, char **destURL)
typedef enum _SupportFeatureType	SupportFeatureType
	The type of the feature.

Enumerations
enum	_AVPStsStatus { Valid , Invalid , Pending }
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 }
	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 }
	specified option on AliPlayer More...
enum	_SupportFeatureType : NSUInteger { FeatureDolbyAudio }
	The type of the feature. 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 }
	Rendring mode. More...
enum	AVPEventType : NSUInteger {   AVPEventPrepareDone , AVPEventAutoPlayStart , AVPEventFirstRenderedStart , AVPEventCompletion ,   AVPEventLoadingStart , AVPEventLoadingEnd , AVPEventSeekEnd , AVPEventLoopingStart ,   AVPEventClearScreenDone }
	Player event type. More...
enum	AVPIpResolveType : NSUInteger { AVPIpResolveWhatEver , AVPIpResolveV4 , AVPIpResolveV6 }
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 }
enum	AVPLogOption : NSUInteger { FRAME_LEVEL_LOGGING_ENABLED = 1 }
enum	AVPMirrorMode : NSUInteger { AVP_MIRRORMODE_NONE , AVP_MIRRORMODE_HORIZONTAL , AVP_MIRRORMODE_VERTICAL }
	Mirroring mode. 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	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 }
enum	AVPOutputAudioChannel : NSUInteger { AVP_AUDIO_CHANNEL_NONE = 0 , AVP_AUDIO_CHANNEL_LEFT = 1 , AVP_AUDIO_CHANNEL_RIGHT = 2 }
	Output audio channel. More...
enum	AVPPIPShowMode : NSUInteger { AVP_SHOW_MODE_DEFAULT = 0 , AVP_SHOW_MODE_HIDE_FAST_FORWARD_REWIND = 1 }
	picture in picture show mode 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 }
enum	AVPPropertyKey : NSUInteger { AVP_KEY_RESPONSE_INFO = 0 , AVP_KEY_CONNECT_INFO = 1 }
	The key to get property. More...
enum	AVPRotateMode : NSUInteger { AVP_ROTATE_0 = 0 , AVP_ROTATE_90 = 90 , AVP_ROTATE_180 = 180 , AVP_ROTATE_270 = 270 }
	Rotate mode. More...
enum	AVPScalingMode : NSUInteger { AVP_SCALINGMODE_SCALETOFILL , AVP_SCALINGMODE_SCALEASPECTFIT , AVP_SCALINGMODE_SCALEASPECTFILL }
	Zoom mode. 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 More...
enum	AVPSeekMode : NSUInteger { AVP_SEEKMODE_ACCURATE = 0x01 , AVP_SEEKMODE_INACCURATE = 0x10 }
	Seeking mode: accurate seeking or inaccurate seeking. More...
enum	AVPStatus : NSUInteger {   AVPStatusIdle = 0 , AVPStatusInitialzed , AVPStatusPrepared , AVPStatusStarted ,   AVPStatusPaused , AVPStatusStopped , AVPStatusCompletion , AVPStatusError }
enum	AVPStrategyType : NSUInteger { AVP_STRATEGY_DYNAMIC_PRELOAD = 1 }
	strategy type More...
enum	BizScene : NSUInteger { AVP_Player = 0 , AVP_Loader = 1 }
	Scenario of adaptive downgrade switching URL, player or preloader. More...
enum	CodecType : NSUInteger { AVP_H265 = 0 }
	The original URL encoding format for adaptive downgrade switching URL. More...

Typedef Documentation

AVPAlphaRenderMode

typedef enum AVPAlphaRenderMode AVPAlphaRenderMode

Rendring mode.

AVPBizScene

typedef enum BizScene AVPBizScene

Scenario of adaptive downgrade switching URL, player or preloader.

AVPCodecType

typedef enum CodecType AVPCodecType

The original URL encoding format for adaptive downgrade switching URL.

AVPEventType

typedef enum AVPEventType AVPEventType

Player event type.

AVPIpResolveType

typedef enum AVPIpResolveType AVPIpResolveType

AVPLogLevel

typedef enum AVPLogLevel AVPLogLevel

AVPLogOption

typedef enum AVPLogOption AVPLogOption

AVPMirrorMode

typedef enum AVPMirrorMode AVPMirrorMode

Mirroring mode.

AVPMultiBitratesMode

typedef enum AVPMultiBitratesMode AVPMultiBitratesMode

multiBitrates preload mode, effect only on multiBitrates hls stream.

AVPOption

typedef enum AVPOption AVPOption

AVPOutputAudioChannel

typedef enum AVPOutputAudioChannel AVPOutputAudioChannel

Output audio channel.

AVPPIPShowMode

typedef enum AVPPIPShowMode AVPPIPShowMode

picture in picture show mode

AVPPixelNumber

typedef enum AVPPixelNumber AVPPixelNumber

AVPPropertyKey

typedef enum AVPPropertyKey AVPPropertyKey

The key to get property.

AVPRotateMode

typedef enum AVPRotateMode AVPRotateMode

Rotate mode.

AVPScalingMode

typedef enum AVPScalingMode AVPScalingMode

Zoom mode.

AVPSceneType

typedef enum AVPSceneType AVPSceneType

scene type

AVPSeekMode

typedef enum AVPSeekMode AVPSeekMode

Seeking mode: accurate seeking or inaccurate seeking.

AVPStatus

typedef enum AVPStatus AVPStatus

AVPStrategyType

typedef enum AVPStrategyType AVPStrategyType

strategy type

AVPStsInfo

typedef struct _AVPStsInfo AVPStsInfo

AVPStsStatus

typedef enum _AVPStsStatus AVPStsStatus

GlobalOption

typedef enum _GlobalOption GlobalOption

specified option on GlobalSettings

PlayerOption

typedef enum _PlayerOption PlayerOption

specified option on AliPlayer

PlayURLConverCallback

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

SupportFeatureType

typedef enum _SupportFeatureType SupportFeatureType

The type of the feature.

Enumeration Type Documentation

_AVPStsStatus

enum _AVPStsStatus

Enumerator
Valid
Invalid
Pending

_GlobalOption

enum _GlobalOption : NSUInteger

specified option on GlobalSettings

Enumerator
SET_PRE_CONNECT_DOMAIN
SET_DNS_PRIORITY_LOCAL_FIRST
ENABLE_H2_MULTIPLEX
SET_EXTRA_DATA
ENABLE_ANDROID_DECODE_REUSE
NOT_PAUSE_WHEN_PREPARING
ALLOW_RTS_DEGRADE
ENABLE_DECODER_FAST_FIRST_FRAME
DISABLE_CAPTURE_SCALE

_PlayerOption

enum _PlayerOption : NSUInteger

specified option on AliPlayer

Enumerator
SET_MEDIA_TYPE
ALLOW_DECODE_BACKGROUND
ALLOW_PRE_RENDER
PLAYED_DURATION_INCLUDE_SPEED

_SupportFeatureType

enum _SupportFeatureType : NSUInteger

The type of the feature.

Enumerator
FeatureDolbyAudio	whether the device support Dolby Audio.

AVPAlphaRenderMode

enum AVPAlphaRenderMode : NSUInteger

Rendring mode.

Enumerator
AVP_RENDERMODE_ALPHA_NONE
AVP_RENDERMODE_ALPHA_AT_RIGHT
AVP_RENDERMODE_ALPHA_AT_LEFT
AVP_RENDERMODE_ALPHA_AT_TOP
AVP_RENDERMODE_ALPHA_AT_BOTTOM

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

Enumerator
AVPIpResolveWhatEver
AVPIpResolveV4
AVPIpResolveV6

AVPLogLevel

enum AVPLogLevel : NSUInteger

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

Mirroring mode.

Enumerator
AVP_MIRRORMODE_NONE
AVP_MIRRORMODE_HORIZONTAL
AVP_MIRRORMODE_VERTICAL

AVPMultiBitratesMode

enum AVPMultiBitratesMode : NSUInteger

multiBitrates preload mode, effect only on multiBitrates hls stream.

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.

AVPOption

enum AVPOption : NSUInteger

Enumerator
AVP_OPTION_RENDER_FPS	render fps. Return value type is Float
AVP_OPTION_DOWNLOAD_BITRATE	current download bitrate. Return value type is Float
AVP_OPTION_VIDEO_BITRATE	current playback video bitrate. Return value type is Float
AVP_OPTION_AUDIO_BITRATE	current playback audio bitrate. Return value type is Float
AVP_OPTION_IS_ABRSWITCHING	When switched the resolution to AUTO (automatic bitrate switching), it determines whether the current state is undergoing ABR (Adaptive Bitrate) switching. The return type is Int. If it is in the state of ABR switching, it returns "1"; otherwise, it returns "0".

AVPOutputAudioChannel

enum AVPOutputAudioChannel : NSUInteger

Output audio channel.

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 show mode

Enumerator
AVP_SHOW_MODE_DEFAULT	default mode: show all picture in picture button
AVP_SHOW_MODE_HIDE_FAST_FORWARD_REWIND	hide fast forward and fast rewind mode

AVPPixelNumber

enum AVPPixelNumber : NSUInteger

Enumerator
Resolution_360P
Resolution_480P
Resolution_540P
Resolution_720P
Resolution_1080P
Resolution_2K
Resolution_4K
Resolution_NoLimit

AVPPropertyKey

enum AVPPropertyKey : NSUInteger

The key to get property.

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.

Enumerator
AVP_ROTATE_0
AVP_ROTATE_90
AVP_ROTATE_180
AVP_ROTATE_270

AVPScalingMode

enum AVPScalingMode : NSUInteger

Zoom mode.

Enumerator
AVP_SCALINGMODE_SCALETOFILL	Auto stretch to fit.
AVP_SCALINGMODE_SCALEASPECTFIT	Keep aspect ratio and add black borders.
AVP_SCALINGMODE_SCALEASPECTFILL	Keep aspect ratio and crop.

AVPSceneType

enum AVPSceneType : NSInteger

scene type

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

Seeking mode: accurate seeking or inaccurate seeking.

Enumerator
AVP_SEEKMODE_ACCURATE
AVP_SEEKMODE_INACCURATE

AVPStatus

enum AVPStatus : NSUInteger

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 of adaptive downgrade switching URL, player or preloader.

Enumerator
AVP_Player
AVP_Loader

CodecType

enum CodecType : NSUInteger

The original URL encoding format for adaptive downgrade switching URL.

Enumerator
AVP_H265