com.aliyun.downloader

Class AliMediaDownloader

java.lang.Object

com.aliyun.downloader.AliMediaDownloader

public abstract class AliMediaDownloader
extends java.lang.Object

The core class for media downloading, providing operations such as preparing, starting, stopping, and releasing media resources. A typical workflow is as follows: 1. Create an AliMediaDownloader instance. 2. Set up listeners, such as setOnPreparedListener(OnPreparedListener), setOnProgressListener(OnProgressListener), etc. 3. Call setSaveDir(String) to specify the directory where the downloaded file will be saved. 4. Call prepare(VidAuth) or prepare(VidSts) to asynchronously prepare the media resource. 5. In the AliMediaDownloader.OnPreparedListener.onPrepared(MediaInfo) callback, get the media information and call selectItem(int) to select the track to download. 6. Call start() to begin the download. 7. During the download, monitor progress via AliMediaDownloader.OnProgressListener. 8. When the download is complete, AliMediaDownloader.OnCompletionListener.onCompletion() will be called. 9. After the download is complete (successful or failed), call release() to release the resources occupied by the downloader.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AliMediaDownloader.ConvertURLCallback Callback interface for URL conversion.
static interface	AliMediaDownloader.OnCompletionListener Callback interface for download completion.
static interface	AliMediaDownloader.OnErrorListener Callback interface for download errors.
static interface	AliMediaDownloader.OnPreparedListener Callback interface for when the download preparation is complete.
static interface	AliMediaDownloader.OnProgressListener Callback interface for download progress.

Constructor Summary

Constructors

Constructor and Description
AliMediaDownloader()

Method Summary

Modifier and Type	Method and Description
abstract void	deleteFile() Deletes the downloaded file associated with the current downloader instance.
abstract java.lang.String	getFilePath() Gets the file path after a successful download.
abstract void	prepare(VidAuth vidAuth) Prepares the media resource for download using VidAuth credentials.
abstract void	prepare(VidSts vidSts) Prepares the media resource for download using VidSts credentials.
abstract void	release() Releases the resources occupied by the downloader instance.
abstract void	selectItem(int index) Selects an item to download from the list of tracks provided in MediaInfo.
static void	setConvertURLCallback(AliMediaDownloader.ConvertURLCallback callback) Sets a global URL conversion callback.
abstract void	setDownloaderConfig(DownloaderConfig config) Sets the downloader configuration.
abstract void	setOnCompletionListener(AliMediaDownloader.OnCompletionListener l) Sets the listener for download completion.
abstract void	setOnErrorListener(AliMediaDownloader.OnErrorListener l) Sets the listener for download errors.
abstract void	setOnPreparedListener(AliMediaDownloader.OnPreparedListener l) Sets the listener for download preparation completion.
abstract void	setOnProgressListener(AliMediaDownloader.OnProgressListener l) Sets the listener for download progress.
abstract void	setSaveDir(java.lang.String absPath) Sets the directory where the downloaded file will be saved.
abstract void	start() Starts the download.
abstract void	stop() Stops the download.
abstract void	updateSource(VidAuth vidAuth) Updates the VidAuth credential information.
abstract void	updateSource(VidSts vidSts) Updates the VidSts credential information.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AliMediaDownloader

public AliMediaDownloader()

Method Detail

setSaveDir

public abstract void setSaveDir(java.lang.String absPath)

Sets the directory where the downloaded file will be saved. This must be set before calling prepare(com.aliyun.player.source.VidAuth).

Parameters:

absPath - The absolute path of the directory. The application must ensure it has write permissions for this path.

getFilePath

public abstract java.lang.String getFilePath()

Gets the file path after a successful download. This method should be called after the AliMediaDownloader.OnCompletionListener.onCompletion() callback is received to ensure the returned path is final and valid. The return value is undefined if called before the download is complete.

Returns:

The absolute path of the successfully downloaded file. The return value is undefined if the download is not complete or has failed.

See Also:

setOnCompletionListener(OnCompletionListener)

selectItem

public abstract void selectItem(int index)

Selects an item to download from the list of tracks provided in MediaInfo. This method must be called after the AliMediaDownloader.OnPreparedListener.onPrepared(MediaInfo) callback and before calling start().

Parameters:

index - The index of the track to download in the list returned by MediaInfo.getTrackInfos().

See Also:

AliMediaDownloader.OnPreparedListener.onPrepared(MediaInfo), MediaInfo.getTrackInfos()

setOnCompletionListener

public abstract void setOnCompletionListener(AliMediaDownloader.OnCompletionListener l)

Sets the listener for download completion.

Parameters:

l - An instance of the download completion callback interface. Set to null to remove the listener.

See Also:

AliMediaDownloader.OnCompletionListener

setOnErrorListener

public abstract void setOnErrorListener(AliMediaDownloader.OnErrorListener l)

Sets the listener for download errors.

Parameters:

l - An instance of the download error callback interface. Set to null to remove the listener.

See Also:

AliMediaDownloader.OnErrorListener

setOnPreparedListener

public abstract void setOnPreparedListener(AliMediaDownloader.OnPreparedListener l)

Sets the listener for download preparation completion.

Parameters:

l - An instance of the preparation completion callback interface. Set to null to remove the listener.

See Also:

AliMediaDownloader.OnPreparedListener

setOnProgressListener

public abstract void setOnProgressListener(AliMediaDownloader.OnProgressListener l)

Sets the listener for download progress.

Parameters:

l - An instance of the download progress callback interface. Set to null to remove the listener.

See Also:

AliMediaDownloader.OnProgressListener

prepare

public abstract void prepare(VidAuth vidAuth)

Prepares the media resource for download using VidAuth credentials. After this is called, the downloader will start parsing the media information. The result will be returned via AliMediaDownloader.OnPreparedListener.onPrepared(MediaInfo) or AliMediaDownloader.OnErrorListener.onError(ErrorInfo).

Parameters:

vidAuth - The playback credentials containing Vid and PlayAuth. See VidAuth.

See Also:

setOnPreparedListener(OnPreparedListener), setOnErrorListener(OnErrorListener)

prepare

public abstract void prepare(VidSts vidSts)

Prepares the media resource for download using VidSts credentials. After this is called, the downloader will start parsing the media information. The result will be returned via AliMediaDownloader.OnPreparedListener.onPrepared(MediaInfo) or AliMediaDownloader.OnErrorListener.onError(ErrorInfo).

Parameters:

vidSts - The security credentials containing Vid and STS information. See VidSts.

See Also:

setOnPreparedListener(OnPreparedListener), setOnErrorListener(OnErrorListener)

start

public abstract void start()

Starts the download. This method must be called after a successful call to selectItem(int). After calling, download progress will be reported via AliMediaDownloader.OnProgressListener.

See Also:

selectItem(int), setOnProgressListener(OnProgressListener)

stop

public abstract void stop()

Stops the download. Calling this method will interrupt the current download task. The partially downloaded file will be preserved.

release

public abstract void release()

Releases the resources occupied by the downloader instance. This method should be called when the downloader is no longer needed to avoid memory leaks. After release, this downloader instance becomes unusable.

updateSource

public abstract void updateSource(VidSts vidSts)

Updates the VidSts credential information. When the STS credentials expire, this method can be called to provide new credentials to continue downloading without recreating the downloader.

Parameters:

vidSts - The new VidSts credentials. See VidSts.

updateSource

public abstract void updateSource(VidAuth vidAuth)

Updates the VidAuth credential information. When the PlayAuth credentials expire, this method can be called to provide new credentials to continue downloading without recreating the downloader.

Parameters:

vidAuth - The new VidAuth credentials. See VidAuth.

deleteFile

public abstract void deleteFile()

Deletes the downloaded file associated with the current downloader instance. This method deletes the file generated by the current download session.

setDownloaderConfig

public abstract void setDownloaderConfig(DownloaderConfig config)

Sets the downloader configuration. Used to apply custom configurations to the downloader, such as network timeout, custom headers, etc.

Parameters:

config - The downloader configuration object. See DownloaderConfig.

setConvertURLCallback

public static void setConvertURLCallback(AliMediaDownloader.ConvertURLCallback callback)

Sets a global URL conversion callback. This callback will be applied to all AliMediaDownloader instances. Once set, the URL will be processed through this callback before each download task begins.

Parameters:

callback - An instance of the URL conversion callback interface. Set to null to remove the global callback.

See Also:

AliMediaDownloader.ConvertURLCallback