org.digitalmediaserver.cast

Class ContainerMetadata

java.lang.Object

org.digitalmediaserver.cast.ContainerMetadata

@Immutable
public class ContainerMetadata
extends Object

Common container metadata used as part of QueueData.

Author:

Nadahar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ContainerMetadata.ContainerType Possible types of container metadata.

Field Summary

Fields

Modifier and Type	Field and Description
protected Double	containerDuration Container duration in seconds.
protected List<Image>	containerImages Container images.
protected ContainerMetadata.ContainerType	containerType The type of container object
protected String	title The title of the container, for example an audiobook title, a TV channel name, etc.

Constructor Summary

Constructors

Constructor and Description
ContainerMetadata(Double containerDuration, List<Image> containerImages, ContainerMetadata.ContainerType containerType, String title) Creates a new instance using the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Double	getContainerDuration()
List<Image>	getContainerImages()
ContainerMetadata.ContainerType	getContainerType()
String	getTitle()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

containerDuration

@Nullable
protected final Double containerDuration

Container duration in seconds. For example an audiobook playback time.

containerImages

@Nonnull
protected final List<Image> containerImages

Container images. For example a live TV channel logo, audiobook cover, album cover art, etc.

containerType

@Nonnull
protected final ContainerMetadata.ContainerType containerType

The type of container object

title

@Nullable
protected final String title

The title of the container, for example an audiobook title, a TV channel name, etc.

Constructor Detail

ContainerMetadata

public ContainerMetadata(@Nullable
                         Double containerDuration,
                         @Nullable
                         List<Image> containerImages,
                         @Nonnull
                         ContainerMetadata.ContainerType containerType,
                         @Nullable
                         String title)

Creates a new instance using the specified parameters.

Parameters:

containerDuration - the container duration in seconds.

containerImages - the container images. For example a live TV channel logo, audiobook cover, album cover art, etc.

containerType - the type of container object.

title - the title of the container, for example an audiobook title, a TV channel name, etc.

Method Detail

getContainerDuration

@Nullable
public Double getContainerDuration()

Returns:

The container duration in seconds.

getContainerImages

@Nonnull
public List<Image> getContainerImages()

Returns:

The container images. For example a live TV channel logo, audiobook cover, album cover art, etc.

getContainerType

@Nonnull
public ContainerMetadata.ContainerType getContainerType()

Returns:

The type of container object.

getTitle

@Nonnull
public String getTitle()

Returns:

The title of the container, for example an audiobook title, a TV channel name, etc.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object