AliMediaDownloader Class Reference

媒体文件下载器类。 More...

#include "AliMediaDownloader.h"

Inheritance diagram for AliMediaDownloader:

Instance Methods
(void)	- deleteFile
	删除与当前下载器实例关联的已下载文件。
(void)	- destroy
	销毁下载器实例。
(AVDConfig *)	- getConfig
	获取当前的下载配置。
(instancetype)	- init
	初始化下载器实例。
(void)	- prepareWithPlayAuth:
	使用 VidAuthSource 准备下载。
(void)	- prepareWithVid:
	使用 VidStsSource 准备下载。
(void)	- selectTrack:
	选择要下载的媒体轨道。
(void)	- setConfig:
	设置下载配置。
(void)	- setPlayUrlConvertCallback:
	设置一个用于转换播放 URL 的回调函数。
(void)	- setSaveDirectory:
	设置下载文件的保存目录。
(void)	- start
	开始下载。
(void)	- stop
	停止下载。
(void)	- updateWithPlayAuth:
	更新 VidAuthSource 信息。
(void)	- updateWithVid:
	更新 VidStsSource 信息。

Class Methods
(int)	+ deleteFile:vid:format:index:
	删除一个已下载的文件（类方法）。
(NSString *)	+ getSDKVersion
	获取 SDK 版本号。

Properties
id< AMDDelegate >	delegate
	设置下载事件的代理。
NSString *	downloadedFilePath
	获取已下载文件的路径。

Detailed Description

媒体文件下载器类。

该类提供了媒体文件的下载功能，包括准备、开始、停止、更新凭证和删除等操作。 下载过程中的状态通过 AMDDelegate 协议进行回调。

Method Documentation

deleteFile

- (void) deleteFile

删除与当前下载器实例关联的已下载文件。

deleteFile:vid:format:index:

+ (int) deleteFile:		(NSString *)	saveDir
vid:		(NSString *)	vid
format:		(NSString *)	format
index:		(int)	index

删除一个已下载的文件（类方法）。

Parameters

saveDir	文件保存的目录路径。
vid	媒体文件的 VID。
format	媒体文件的格式。
index	对应 VID 的下载索引。

Returns

返回一个整型值，表示操作的结果。

destroy

- (void) destroy

销毁下载器实例。

调用此方法以释放下载器占用的资源。

getConfig

- (AVDConfig *) getConfig

获取当前的下载配置。

Returns

当前的 AVDConfig 配置对象。

See also

setConfig:]

getSDKVersion

+ (NSString *) getSDKVersion

获取 SDK 版本号。

Returns

包含 SDK 版本信息的字符串。

init

- (instancetype) init

初始化下载器实例。

Returns

一个已初始化的 AliMediaDownloader 实例。

prepareWithPlayAuth:

- (void) prepareWithPlayAuth:

(AVPVidAuthSource *)

source

使用 VidAuthSource 准备下载。

这是一个异步操作。准备成功后，会触发 onPrepared:mediaInfo:] 回调。

Parameters

source

AVPVidAuthSource 对象，包含了下载所需的 VID 和 PlayAuth 凭证信息。

See also

onPrepared:mediaInfo:]

onError:errorModel:]

prepareWithVid:

- (void) prepareWithVid:

(AVPVidStsSource *)

source

使用 VidStsSource 准备下载。

这是一个异步操作。准备成功后，会触发 onPrepared:mediaInfo:] 回调。

Parameters

source

AVPVidStsSource 对象，包含了下载所需的 VID 和 STS 凭证信息。

See also

onPrepared:mediaInfo:]

onError:errorModel:]

selectTrack:

- (void) selectTrack:

(int)

trackIndex

选择要下载的媒体轨道。

Note

可用的轨道索引（trackIndex）可以在 onPrepared:mediaInfo:] 回调的 AVPMediaInfo 对象中获取。

Parameters

trackIndex

要下载的轨道的索引。

setConfig:

- (void) setConfig:

(AVDConfig *)

config

设置下载配置。

Parameters

config

一个 AVDConfig 对象，包含了下载的相关配置。

See also

getConfig]

setPlayUrlConvertCallback:

- (void) setPlayUrlConvertCallback:

(PlayURLConverCallback)

callback

设置一个用于转换播放 URL 的回调函数。

Note

此回调通常用于 P2P 场景下的 URL 地址转换。

Parameters

callback

一个回调函数指针。其具体签名（参数和返回值）未在此文件中定义，请参考其定义源。

setSaveDirectory:

- (void) setSaveDirectory:

(NSString *)

dir

设置下载文件的保存目录。

Parameters

dir	用于保存下载文件的文件夹路径。

start

- (void) start

开始下载。

See also

onDownloadingProgress:percentage:]

onCompletion:]

stop

- (void) stop

停止下载。

See also

start]

updateWithPlayAuth:

- (void) updateWithPlayAuth:

(AVPVidAuthSource *)

source

更新 VidAuthSource 信息。

当 PlayAuth 凭证过期时，调用此方法以更新凭证信息。

Parameters

source

新的 AVPVidAuthSource 对象，包含了更新后的 PlayAuth 凭证。

updateWithVid:

- (void) updateWithVid:

(AVPVidStsSource *)

source

更新 VidStsSource 信息。

当 STS 凭证过期时，调用此方法以更新凭证信息。

Parameters

source

新的 AVPVidStsSource 对象，包含了更新后的 STS 凭证。

Property Documentation

delegate

- (id<AMDDelegate>) delegate

readwritenonatomicweak

设置下载事件的代理。

See also

AMDDelegate

downloadedFilePath

- (NSString*) downloadedFilePath

readnonatomicassign

获取已下载文件的路径。

Note

该属性在下载完成（即 onCompletion:] 回调触发）后才会有有效值。

Returns

一个表示已下载文件本地路径的字符串。如果下载未完成，可能为 nil 或空。

---

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

• AliMediaDownloader.h