AVPConfig Class Reference

#include "AVPConfig.h"

Inheritance diagram for AVPConfig:

Properties
int	audioInterruptMode
	Audio interrupt mode (such as phone call), 0 means pause play during interruption and resume play after interruption; 1 means continue play during interruption period.
BOOL	clearShowWhenStop
	Whether to clear the last frame when the player is stopped.
BOOL	disableAudio
	Disable audio track.
BOOL	disableVideo
	Disable video track.
int	enableEnhancedHttpDns
	whether enable enhanced http dns, -1 : as globel setting
BOOL	enableHttp3
	Use http3 to request, supported standards:RFC 9114(HTTP3) and RFC 9000(QUIC v1), false by default.
int	enableHttpDns
	whether enable http dns, -1 : as globel setting
BOOL	enableLocalCache
	When local cached is enabled in GlobalSettings API, this config can be used to enable or disable local cache in current player instance, by default is ON.
BOOL	enableProjection
	Enable projection for current player You need to integrate projection SDK to do this Default is false.
BOOL	enableSEI
	Enable or disable SEI.
BOOL	enableStrictAuthMode
	For media that enabled URL authorization(HLS protocol), when local cache is enabled, we can choose different auth mode:Non Strict Mode(false): Auth is cached.
BOOL	enableStrictFlvHeader
	Used to fast stream start when playing pure audio or pure video in RTMP/FLV live stream.
int	highBufferDuration
	The size of data to be cached before the player can be resumed from playback lag.
NSMutableArray *	httpHeaders
	Add a custom header.
NSString *	httpProxy
	HTTP proxy.
int	liveStartIndex
	The start playing index of fragments, when HLS is live.
int	maxAllowedAbrVideoPixelNumber
	When switching the resolution to AUTO mode, the maximum pixel count corresponding to the allowable resolution upgrade for the video.
int	maxBufferDuration
	The maximum size of cache data.
int	maxDelayTime
	The maximum broadcasting delay.
int	maxProbeSize
	The size of the probe data.
uint64_t	mMAXBackwardDuration
	set the maximum backward buffer duration of the player.
int	networkRetryCount
	The maximum network reconnection attempts.
int	networkTimeout
	Network connection timeout time.
int	pixelBufferOutputFormat
int	positionTimerIntervalMs
	Set the frequencies of Progress.
BOOL	preferAudio
	prefer audio playback; prefer audio playback when under insufficient network bandwidth.
NSString *	referer
	Request Referer.
int	selectTrackBufferMode
	Whether to clear the buffer when calling SelectTrack, no matter it is high-definition or low-definition, 0 is not cleared, and 1 is cleared.
int	startBufferDuration
	The size of the cache data required for starting playback.
int	startBufferLimit
	start preload limit.
int	stopBufferLimit
	stop preload limit.
NSString *	userAgent
	UserAgent.
int	videoRenderType
	video renderType, 0 means default render; 1 means mixed render.

Property Documentation

audioInterruptMode

- (int) audioInterruptMode

readwritenonatomicassign

Audio interrupt mode (such as phone call), 0 means pause play during interruption and resume play after interruption; 1 means continue play during interruption period.

clearShowWhenStop

- (BOOL) clearShowWhenStop

readwritenonatomicassign

Whether to clear the last frame when the player is stopped.

Set to YES to clear the last frame and a black view is displayed. Default: NO.

disableAudio

- (BOOL) disableAudio

readwritenonatomicassign

Disable audio track.

disableVideo

- (BOOL) disableVideo

readwritenonatomicassign

Disable video track.

enableEnhancedHttpDns

- (int) enableEnhancedHttpDns

readwritenonatomicassign

whether enable enhanced http dns, -1 : as globel setting

enableHttp3

- (BOOL) enableHttp3

readwritenonatomicassign

Use http3 to request, supported standards:RFC 9114(HTTP3) and RFC 9000(QUIC v1), false by default.

If request failed, it will automatically downgrade to normal http.

enableHttpDns

- (int) enableHttpDns

readwritenonatomicassign

whether enable http dns, -1 : as globel setting

enableLocalCache

- (BOOL) enableLocalCache

readwritenonatomicassign

When local cached is enabled in GlobalSettings API, this config can be used to enable or disable local cache in current player instance, by default is ON.

enableProjection

- (BOOL) enableProjection

readwritenonatomicassign

Enable projection for current player You need to integrate projection SDK to do this Default is false.

enableSEI

- (BOOL) enableSEI

readwritenonatomicassign

Enable or disable SEI.

enableStrictAuthMode

- (BOOL) enableStrictAuthMode

readwritenonatomicassign

For media that enabled URL authorization(HLS protocol), when local cache is enabled, we can choose different auth mode:Non Strict Mode(false): Auth is cached.

If last play cached part of the media, and next play to non-cache part, player will use old auth to request, which may fail if the auth timeout configuration in the server is very short. Strict Mode(true): Auth is not cached. Every play will do the auth verification, so when there is no network, media cannot be played. Default is false.

enableStrictFlvHeader

- (BOOL) enableStrictFlvHeader

readwritenonatomicassign

Used to fast stream start when playing pure audio or pure video in RTMP/FLV live stream.

If live stream header states only audio or only video and the stream content really contains the same single stream, enable this option can fast start the stream. Default value is false.

highBufferDuration

- (int) highBufferDuration

readwritenonatomicassign

The size of data to be cached before the player can be resumed from playback lag.

When the size of the data cached by the player reaches this value, the playback is resumed, Unit: millisecond.

httpHeaders

- (NSMutableArray*) httpHeaders

readwritenonatomiccopy

Add a custom header.

httpProxy

- (NSString*) httpProxy

readwritenonatomiccopy

HTTP proxy.

liveStartIndex

- (int) liveStartIndex

readwritenonatomicassign

The start playing index of fragments, when HLS is live.

maxAllowedAbrVideoPixelNumber

- (int) maxAllowedAbrVideoPixelNumber

readwritenonatomicassign

When switching the resolution to AUTO mode, the maximum pixel count corresponding to the allowable resolution upgrade for the video.

for example, if the value is set to 1280 * 720 = 921600, then the highest resolution upgrade corresponds to this resolution, and it will not upgrade to 1920 * 1080." Can refer to AVPPixelNumber

maxBufferDuration

- (int) maxBufferDuration

readwritenonatomicassign

The maximum size of cache data.

Default: 50 seconds, Unit: millisecond.

maxDelayTime

- (int) maxDelayTime

readwritenonatomicassign

The maximum broadcasting delay.

Default: 5000 milliseconds, Unit: millisecond.

maxProbeSize

- (int) maxProbeSize

readwritenonatomicassign

The size of the probe data.

Default: -1. Value -1 indicates that the probe data size is not specified.

mMAXBackwardDuration

- (uint64_t) mMAXBackwardDuration

readwritenonatomicassign

set the maximum backward buffer duration of the player.

networkRetryCount

- (int) networkRetryCount

readwritenonatomicassign

The maximum network reconnection attempts.

Default: 2. networkTimeout specifies the reconnection interval. networkRetryCount=0 indicates that automatic network reconnection is disabled. The reconnection policy varies depending on the app.

networkTimeout

- (int) networkTimeout

readwritenonatomicassign

Network connection timeout time.

Default: 15 seconds, Unit: millisecond.

pixelBufferOutputFormat

- (int) pixelBufferOutputFormat

readwritenonatomicassign

positionTimerIntervalMs

- (int) positionTimerIntervalMs

readwritenonatomicassign

Set the frequencies of Progress.

Includes the current position and the buffer position.

preferAudio

- (BOOL) preferAudio

readwritenonatomicassign

prefer audio playback; prefer audio playback when under insufficient network bandwidth.

At present, it is only effective in dash live stream (the video has been switched to the lowest bit rate)

referer

- (NSString*) referer

readwritenonatomiccopy

Request Referer.

selectTrackBufferMode

- (int) selectTrackBufferMode

readwritenonatomicassign

Whether to clear the buffer when calling SelectTrack, no matter it is high-definition or low-definition, 0 is not cleared, and 1 is cleared.

startBufferDuration

- (int) startBufferDuration

readwritenonatomicassign

The size of the cache data required for starting playback.

Default: 500 milliseconds, Unit: millisecond.

startBufferLimit

- (int) startBufferLimit

readwritenonatomicassign

start preload limit.

Unit: milliseconds.

stopBufferLimit

- (int) stopBufferLimit

readwritenonatomicassign

stop preload limit.

Unit: milliseconds.

userAgent

- (NSString*) userAgent

readwritenonatomiccopy

UserAgent.

videoRenderType

- (int) videoRenderType

readwritenonatomicassign

video renderType, 0 means default render; 1 means mixed render.

---

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

• AVPConfig.h