com.google.android.exoplayer2.offline

Class DownloadAction

java.lang.Object

com.google.android.exoplayer2.offline.DownloadAction

Direct Known Subclasses:

ProgressiveDownloadAction, SegmentDownloadAction

public abstract class DownloadAction
extends java.lang.Object

Contains the necessary parameters for a download or remove action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DownloadAction.Deserializer Used to deserialize DownloadActions.

Field Summary

Fields

Modifier and Type	Field and Description
byte[]	data Custom data for this action.
boolean	isRemoveAction Whether this is a remove action.
java.lang.String	type The type of the action.
android.net.Uri	uri The uri being downloaded or removed.
int	version The action version.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DownloadAction(java.lang.String type, int version, android.net.Uri uri, boolean isRemoveAction, byte[] data)

Method Summary

Modifier and Type	Method and Description
abstract Downloader	createDownloader(DownloaderConstructorHelper downloaderConstructorHelper) Creates a Downloader with the given parameters.
static DownloadAction	deserializeFromStream(DownloadAction.Deserializer[] deserializers, java.io.InputStream input) Deserializes one action that was serialized with serializeToStream(DownloadAction, OutputStream) from the input, using the DownloadAction.Deserializers that supports the action's type.
boolean	equals(java.lang.Object o)
static DownloadAction.Deserializer[]	getDefaultDeserializers() Returns available default DownloadAction.Deserializers.
java.util.List<StreamKey>	getKeys() Returns keys of tracks to be downloaded.
int	hashCode()
boolean	isSameMedia(DownloadAction other) Returns whether this is an action for the same media as the other.
static void	serializeToStream(DownloadAction action, java.io.OutputStream output) Serializes action type and data into the output.
byte[]	toByteArray() Serializes itself into a byte array.
protected abstract void	writeToStream(java.io.DataOutputStream output) Serializes itself into the output.

Methods inherited from class java.lang.Object

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

Field Detail

type

public final java.lang.String type

The type of the action.

version

public final int version

The action version.

uri

public final android.net.Uri uri

The uri being downloaded or removed.

isRemoveAction

public final boolean isRemoveAction

Whether this is a remove action. If false, this is a download action.

data

public final byte[] data

Custom data for this action. May be empty.

Constructor Detail

DownloadAction

protected DownloadAction(java.lang.String type,
                         int version,
                         android.net.Uri uri,
                         boolean isRemoveAction,
                         @Nullable
                         byte[] data)

Parameters:

type - The type of the action.

version - The action version.

uri - The uri being downloaded or removed.

isRemoveAction - Whether this is a remove action. If false, this is a download action.

data - Optional custom data for this action.

Method Detail

getDefaultDeserializers

public static DownloadAction.Deserializer[] getDefaultDeserializers()

Returns available default DownloadAction.Deserializers.

deserializeFromStream

public static DownloadAction deserializeFromStream(DownloadAction.Deserializer[] deserializers,
                                                   java.io.InputStream input)
                                            throws java.io.IOException

Deserializes one action that was serialized with serializeToStream(DownloadAction, OutputStream) from the input, using the DownloadAction.Deserializers that supports the action's type.

The caller is responsible for closing the given InputStream.

Parameters:

deserializers - DownloadAction.Deserializers for supported actions.

input - The stream from which to read the action.

Returns:

The deserialized action.

Throws:

java.io.IOException - If there is an IO error reading from input, or if the action type isn't supported by any of the deserializers.

serializeToStream

public static void serializeToStream(DownloadAction action,
                                     java.io.OutputStream output)
                              throws java.io.IOException

Serializes action type and data into the output.

Throws:

java.io.IOException

toByteArray

public final byte[] toByteArray()

Serializes itself into a byte array.

isSameMedia

public boolean isSameMedia(DownloadAction other)

Returns whether this is an action for the same media as the other.

getKeys

public java.util.List<StreamKey> getKeys()

Returns keys of tracks to be downloaded.

writeToStream

protected abstract void writeToStream(java.io.DataOutputStream output)
                               throws java.io.IOException

Serializes itself into the output.

Throws:

java.io.IOException

createDownloader

public abstract Downloader createDownloader(DownloaderConstructorHelper downloaderConstructorHelper)

Creates a Downloader with the given parameters.

equals

public boolean equals(@Nullable
                      java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object