org.digitalmediaserver.cast

Class Media

java.lang.Object

org.digitalmediaserver.cast.Media

@Immutable
public class Media
extends Object

Represents the media information.

See Also:

https://developers.google.com/cast/docs/reference/receiver/cast.receiver.media.MediaInformation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Media.HlsSegmentFormat The format of a HLS audio segment.
static class	Media.HlsVideoSegmentFormat The format of a HLS video segment.
static class	Media.MediaBuilder A builder class for the Media class.
static class	Media.MediaCategory The media category.
static class	Media.StreamType Represents the stream types.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	contentId Typically the URL of the media
protected String	contentType The content MIME-type
protected String	contentUrl Optional media URL, to allow using contentId for real ID.
protected Map<String,Object>	customData Application-specific media information
protected Double	duration The media duration
protected String	entity Optional Google Assistant deep link to a media entity
protected Media.HlsSegmentFormat	hlsSegmentFormat The format of the HLS audio segment
protected Media.HlsVideoSegmentFormat	hlsVideoSegmentFormat The format of the HLS video segment
protected Media.MediaCategory	mediaCategory The media cateory (audio, video, picture)
protected Map<String,Object>	metadata The media metadata
protected Long	startAbsoluteTime Provides absolute time (Epoch Unix time in seconds) for live streams.
protected Media.StreamType	streamType The stream type (required)
protected TextTrackStyle	textTrackStyle The style of text track
protected List<Track>	tracks The media tracks

Constructor Summary

Constructors

Constructor and Description

Media(String contentId, String contentType, String contentUrl, Map<String,Object> customData, Double duration, String entity, Media.HlsSegmentFormat hlsSegmentFormat, Media.HlsVideoSegmentFormat hlsVideoSegmentFormat, Media.MediaCategory mediaCategory, Map<String,Object> metadata, Long startAbsoluteTime, Media.StreamType streamType, TextTrackStyle textTrackStyle, List<Track> tracks) Creates a new instance using the specified parameters.

Method Summary

Modifier and Type	Method and Description
static Media.MediaBuilder	builder(String contentUrl, String contentType, Media.StreamType streamType) Creates a new Media.MediaBuilder using the specified parameters.
boolean	equals(Object obj)
String	getContentId()
String	getContentType()
String	getContentUrl()
Map<String,Object>	getCustomData()
Double	getDuration()
String	getEntity()
Media.HlsSegmentFormat	getHlsSegmentFormat()
Media.HlsVideoSegmentFormat	getHlsVideoSegmentFormat()
List<Image>	getImages()
Media.MediaCategory	getMediaCategory()
Map<String,Object>	getMetadata()
Metadata.MetadataType	getMetadataType()
Long	getStartAbsoluteTime()
Media.StreamType	getStreamType()
TextTrackStyle	getTextTrackStyle()
List<Track>	getTracks()
String	getUrl() Two different fields might hold the media URL, either contentId or contentUrl.
int	hashCode()
Media.MediaBuilder	modify() Creates a new Media.MediaBuilder initialized with the information from this Media.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

contentId

@Nonnull
protected final String contentId

Typically the URL of the media

contentType

@Nonnull
protected final String contentType

The content MIME-type

contentUrl

@Nullable
protected final String contentUrl

Optional media URL, to allow using contentId for real ID. If contentUrl is provided, it will be used as media the URL, otherwise contentId will be used as the media URL.

customData

@Nonnull
protected final Map<String,Object> customData

Application-specific media information

duration

protected final Double duration

The media duration

entity

protected final String entity

Optional Google Assistant deep link to a media entity

hlsSegmentFormat

protected final Media.HlsSegmentFormat hlsSegmentFormat

The format of the HLS audio segment

hlsVideoSegmentFormat

protected final Media.HlsVideoSegmentFormat hlsVideoSegmentFormat

The format of the HLS video segment

mediaCategory

protected final Media.MediaCategory mediaCategory

The media cateory (audio, video, picture)

metadata

@Nonnull
protected final Map<String,Object> metadata

The media metadata

startAbsoluteTime

@Nullable
protected final Long startAbsoluteTime

Provides absolute time (Epoch Unix time in seconds) for live streams. For live event it would be the time the event started, otherwise it will be start of the seekable range when the streaming started.

streamType

@Nonnull
protected final Media.StreamType streamType

The stream type (required)

textTrackStyle

@Nullable
protected final TextTrackStyle textTrackStyle

The style of text track

tracks

@Nonnull
protected final List<Track> tracks

The media tracks

Constructor Detail

Media

public Media(String contentId,
             String contentType,
             String contentUrl,
             Map<String,Object> customData,
             Double duration,
             String entity,
             Media.HlsSegmentFormat hlsSegmentFormat,
             Media.HlsVideoSegmentFormat hlsVideoSegmentFormat,
             Media.MediaCategory mediaCategory,
             Map<String,Object> metadata,
             Long startAbsoluteTime,
             Media.StreamType streamType,
             TextTrackStyle textTrackStyle,
             List<Track> tracks)

Creates a new instance using the specified parameters.

Parameters:

contentId - the content ID, typically the URL of the media (required).

contentType - the content MIME-type.

contentUrl - the optional media URL, to allow using contentId for real ID. If contentUrl is provided, it will be used as media the URL, otherwise contentId will be used as the media URL.

customData - the application-specific media information.

duration - the media duration.

entity - the optional Google Assistant deep link to a media entity.

hlsSegmentFormat - the format of the HLS audio segment.

hlsVideoSegmentFormat - the format of the HLS video segment.

mediaCategory - the media category.

metadata - the media metadata.

startAbsoluteTime - the absolute time (Epoch Unix time in seconds) for live streams. For live event it would be the time the event started, otherwise it will be start of the seekable range when the streaming started.

streamType - the stream type (required).

textTrackStyle - the style of text track.

tracks - the media Tracks.

Method Detail

getContentId

@Nonnull
public String getContentId()

Returns:

The content ID, typically the URL of the media.

getContentType

@Nonnull
public String getContentType()

Returns:

The content MIME-type.

getContentUrl

@Nullable
public String getContentUrl()

Returns:

The optional media URL, to allow using contentId for real ID. If contentUrl is provided, it will be used as media the URL, otherwise contentId will be used as the media URL.

getUrl

@Nullable
public String getUrl()

Two different fields might hold the media URL, either contentId or contentUrl. The "rules" is that contentUrl is the URL if it is populated, otherwise contentId is the URL.

This method returns the URL for this Media instance according to these rules.

Returns:

The URL for this Media or null if none is defined.

getCustomData

@Nonnull
public Map<String,Object> getCustomData()

Returns:

The application-specific media information.

getDuration

@Nullable
public Double getDuration()

Returns:

The media duration.

getEntity

@Nullable
public String getEntity()

Returns:

The optional Google Assistant deep link to a media entity.

getHlsSegmentFormat

@Nullable
public Media.HlsSegmentFormat getHlsSegmentFormat()

Returns:

The format of the HLS audio segment.

getHlsVideoSegmentFormat

@Nullable
public Media.HlsVideoSegmentFormat getHlsVideoSegmentFormat()

Returns:

The format of the HLS video segment.

getMediaCategory

@Nullable
public Media.MediaCategory getMediaCategory()

Returns:

The media category (audio, video, picture).

getMetadata

@Nonnull
public Map<String,Object> getMetadata()

Returns:

The media metadata.

getImages

@Nonnull
public List<Image> getImages()

Returns:

The List of zero or more Images from the media metadata.

getStartAbsoluteTime

@Nullable
public Long getStartAbsoluteTime()

Returns:

The absolute time (Epoch Unix time in seconds) for live streams. For live event it would be the time the event started, otherwise it will be start of the seekable range when the streaming started.

getStreamType

@Nonnull
public Media.StreamType getStreamType()

Returns:

The stream type.

getTextTrackStyle

@Nullable
public TextTrackStyle getTextTrackStyle()

Returns:

The style of text track.

getTracks

@Nonnull
public List<Track> getTracks()

Returns:

The media Tracks.

getMetadataType

@Nullable
public Metadata.MetadataType getMetadataType()

Returns:

The Metadata.MetadataType defined by the key Metadata.METADATA_TYPE or null.

modify

@Nonnull
public Media.MediaBuilder modify()

Creates a new Media.MediaBuilder initialized with the information from this Media.

Returns:

The new Media.MediaBuilder.

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

builder

public static Media.MediaBuilder builder(@Nullable
                                         String contentUrl,
                                         @Nonnull
                                         String contentType,
                                         @Nonnull
                                         Media.StreamType streamType)

Creates a new Media.MediaBuilder using the specified parameters.

Parameters:

contentUrl - the URL of the media content.

contentType - the content MIME-type.

streamType - the stream type.

Returns:

The new Media.MediaBuilder.