AliyunPlayer v7.9.0
Aliyun Player API Reference Manual for iOS Platforms
Loading...
Searching...
No Matches
AVPPreloadConfig Class Reference

预加载配置类。 More...

#include "AVPPreloadConfig.h"

Inheritance diagram for AVPPreloadConfig:

Instance Methods

(NSArray< NSString * > *) - getCustomHeaders
 获取自定义 Headers。
 
(int) - getDefaultBandWidth
 获取已设置的预加载码率。
 
(NSString *) - getDefaultQuality
 获取已设置的预加载清晰度。
 
(int) - getDefaultResolution
 获取已设置的预加载分辨率。
 
(AVPPreloadOptionType) - getDefaultType
 获取当前设置的默认预加载选项类型。
 
(int) - getDuration
 获取预加载时长。
 
(int) - getNetworkRetryCount
 获取网络重试次数。
 
(int) - getNetworkTimeout
 获取网络超时时间。
 
(NSString *) - getReferrer
 获取 Referrer。
 
(instancetype) - init
 默认构造函数。
 
(instancetype) - initWithDuration:
 使用指定时长构造预加载配置。
 
(void) - setCustomHeaders:
 设置自定义 Headers。
 
(void) - setDefaultBandWidth:
 为多码率流设置预加载的码率。
 
(void) - setDefaultQuality:
 为多码率流设置预加载的清晰度。
 
(void) - setDefaultResolution:
 为多码率流设置预加载的分辨率。
 
(void) - setDuration:
 设置预加载时长。
 
(void) - setNetworkRetryCount:
 设置网络重试次数。
 
(void) - setNetworkTimeout:
 设置网络超时时间。
 
(void) - setReferrer:
 设置 Referrer。
 

Properties

NSArray< NSString * > * customHeaders
 自定义 HTTP Headers。
 
int networkRetryCount
 网络重试次数。
 
int networkTimeout
 网络超时时间,单位为毫秒。
 
int optionIntValue
 preloadOptionTypeAVPPreloadOptionTypeResolutionAVPPreloadOptionTypeBandWidth 时,此属性存储对应的整数值。
 
NSString * optionStringValue
 preloadOptionTypeAVPPreloadOptionTypeQuality 时,此属性存储对应的字符串值。
 
int preloadDuration
 预加载时长,单位为毫秒。
 
AVPPreloadOptionType preloadOptionType
 多码率流预加载的选项类型。
 
NSString * referrer
 HTTP 请求的 Referrer。
 

Detailed Description

预加载配置类。

该类用于配置预加载任务的具体参数,如预加载时长、网络参数以及多码率流的选择策略。 通常与 AVPPreloadTask 一起使用。

See also
AVPPreloadTask

Method Documentation

◆ getCustomHeaders

- (NSArray< NSString * > *) getCustomHeaders

获取自定义 Headers。

Returns
自定义 Headers 数组。
See also
AVPPreloadConfig::customHeaders

◆ getDefaultBandWidth

- (int) getDefaultBandWidth

获取已设置的预加载码率。

Note
仅当预加载选项类型为 AVPPreloadOptionTypeBandWidth 时,返回值才有意义。
Returns
目标码率。

◆ getDefaultQuality

- (NSString *) getDefaultQuality

获取已设置的预加载清晰度。

Note
仅当预加载选项类型为 AVPPreloadOptionTypeQuality 时,返回值才有意义。
Returns
目标清晰度的描述字符串。

◆ getDefaultResolution

- (int) getDefaultResolution

获取已设置的预加载分辨率。

Note
仅当预加载选项类型为 AVPPreloadOptionTypeResolution 时,返回值才有意义。
Returns
分辨率的宽和高的乘积。

◆ getDefaultType

- (AVPPreloadOptionType) getDefaultType

获取当前设置的默认预加载选项类型。

Returns
当前的预加载选项类型。
See also
AVPPreloadOptionType

◆ getDuration

- (int) getDuration

获取预加载时长。

Returns
预加载时长,单位为毫秒。
See also
AVPPreloadConfig::preloadDuration

◆ getNetworkRetryCount

- (int) getNetworkRetryCount

获取网络重试次数。

Returns
网络重试次数。
See also
AVPPreloadConfig::networkRetryCount

◆ getNetworkTimeout

- (int) getNetworkTimeout

获取网络超时时间。

Returns
网络超时时间,单位为毫秒。
See also
AVPPreloadConfig::networkTimeout

◆ getReferrer

- (NSString *) getReferrer

获取 Referrer。

Returns
Referrer 字符串。
See also
AVPPreloadConfig::referrer

◆ init

- (instancetype) init

默认构造函数。

Returns
一个已初始化的 AVPPreloadConfig 实例。

◆ initWithDuration:

- (instancetype) initWithDuration: (int) duration

使用指定时长构造预加载配置。

Parameters
duration预加载时长,单位为毫秒。
Returns
一个已初始化的 AVPPreloadConfig 实例。

◆ setCustomHeaders:

- (void) setCustomHeaders: (NSArray< NSString * > *) customHeaders

设置自定义 Headers。

Parameters
customHeaders自定义 Headers 数组。
See also
AVPPreloadConfig::customHeaders

◆ setDefaultBandWidth:

- (void) setDefaultBandWidth: (int) bandWidth

为多码率流设置预加载的码率。

Note
调用此方法会设置预加载选项类型为 AVPPreloadOptionTypeBandWidth
Parameters
bandWidth目标码率。SDK 将选择与此值最接近的码率档位进行预加载。

◆ setDefaultQuality:

- (void) setDefaultQuality: (NSString *) quality

为多码率流设置预加载的清晰度。

Note
调用此方法会设置预加载选项类型为 AVPPreloadOptionTypeQuality
Parameters
quality目标清晰度的描述字符串。

◆ setDefaultResolution:

- (void) setDefaultResolution: (int) resolution

为多码率流设置预加载的分辨率。

Note
调用此方法会设置预加载选项类型为 AVPPreloadOptionTypeResolution
Parameters
resolution分辨率的宽和高的乘积。SDK 将选择与此值最接近的码率档位进行预加载。

◆ setDuration:

- (void) setDuration: (int) duration

设置预加载时长。

Parameters
duration预加载时长,单位为毫秒。
See also
AVPPreloadConfig::preloadDuration

◆ setNetworkRetryCount:

- (void) setNetworkRetryCount: (int) networkRetryCount

设置网络重试次数。

Parameters
networkRetryCount网络重试次数。
See also
AVPPreloadConfig::networkRetryCount

◆ setNetworkTimeout:

- (void) setNetworkTimeout: (int) networkTimeout

设置网络超时时间。

Parameters
networkTimeout网络超时时间,单位为毫秒。
See also
AVPPreloadConfig::networkTimeout

◆ setReferrer:

- (void) setReferrer: (NSString *) referrer

设置 Referrer。

Parameters
referrerReferrer 字符串。
See also
AVPPreloadConfig::referrer

Property Documentation

◆ customHeaders

- (NSArray<NSString *>*) customHeaders
readwritenonatomicstrong

◆ networkRetryCount

- (int) networkRetryCount
readwritenonatomicassign

◆ networkTimeout

- (int) networkTimeout
readwritenonatomicassign

网络超时时间,单位为毫秒。

See also
-[AVPPreloadConfig - setNetworkTimeout:]
-[AVPPreloadConfig - getNetworkTimeout]

◆ optionIntValue

- (int) optionIntValue
readwritenonatomicassign

preloadOptionTypeAVPPreloadOptionTypeResolutionAVPPreloadOptionTypeBandWidth 时,此属性存储对应的整数值。

◆ optionStringValue

- (NSString*) optionStringValue
readwritenonatomicstrong

preloadOptionTypeAVPPreloadOptionTypeQuality 时,此属性存储对应的字符串值。

◆ preloadDuration

- (int) preloadDuration
readwritenonatomicassign

预加载时长,单位为毫秒。

See also
-[AVPPreloadConfig - setDuration:]
-[AVPPreloadConfig - getDuration]

◆ preloadOptionType

- (AVPPreloadOptionType) preloadOptionType
readwritenonatomicassign

多码率流预加载的选项类型。

See also
AVPPreloadOptionType

◆ referrer

- (NSString*) referrer
readwritenonatomicstrong

HTTP 请求的 Referrer。

See also
-[AVPPreloadConfig - setReferrer:]
-[AVPPreloadConfig - getReferrer]

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