org.digitalmediaserver.cast

Class Media.MediaBuilder

java.lang.Object

org.digitalmediaserver.cast.Media.MediaBuilder

Enclosing class:

Media

public static class Media.MediaBuilder
extends Object

A builder class for the Media class.

Author:

Nadahar

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 category (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

Modifier	Constructor and Description
	MediaBuilder(String contentUrl, String contentType, Media.StreamType streamType) Creates a new instance using the specified parameters.
protected	MediaBuilder(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) "modify()" constructor that simply copies an existing Media instance's fields.

Method Summary

Modifier and Type	Method and Description
Media.MediaBuilder	addTrack(int index, Track track) Inserts the specified Track at the specified position in this Media.MediaBuilder's tracks.
Media.MediaBuilder	addTrack(Track track) Appends the specified Track to the end of this Media.MediaBuilder's tracks.
Media	build()
Media.MediaBuilder	clearTracks() Removes all tracks from this Media.MediaBuilder.
String	contentId()
Media.MediaBuilder	contentId(String contentId)
String	contentType()
Media.MediaBuilder	contentTypeId(String contentType)
String	contentUrl()
Media.MediaBuilder	contentUrl(String contentUrl)
Map<String,Object>	customData()
Media.MediaBuilder	customData(Map<String,Object> customData)
Double	duration()
Media.MediaBuilder	duration(Double duration)
String	entity()
Media.MediaBuilder	entity(String entity)
Media.HlsSegmentFormat	hlsSegmentFormat()
Media.MediaBuilder	hlsSegmentFormat(Media.HlsSegmentFormat hlsSegmentFormat)
Media.HlsVideoSegmentFormat	hlsVideoSegmentFormat()
Media.MediaBuilder	hlsVideoSegmentFormat(Media.HlsVideoSegmentFormat hlsVideoSegmentFormat)
Media.MediaCategory	mediaCategory()
Media.MediaBuilder	mediaCategory(Media.MediaCategory mediaCategory)
Map<String,Object>	metadata()
Media.MediaBuilder	metadata(Map<String,Object> metadata)
Media.MediaBuilder	removeTrack(int index) Removes the Track at the specified position in this Media.MediaBuilder.
Media.MediaBuilder	removeTrack(Track track) Removed the first occurrence specified Track from this Media.MediaBuilder, if it's present.
Long	startAbsoluteTime()
Media.MediaBuilder	startAbsoluteTime(Long startAbsoluteTime)
Media.StreamType	streamType()
Media.MediaBuilder	streamType(Media.StreamType streamType)
TextTrackStyle	textTrackStyle()
Media.MediaBuilder	textTrackStyle(TextTrackStyle textTrackStyle)
List<Track>	tracks()
Media.MediaBuilder	tracks(List<Track> tracks)

Methods inherited from class java.lang.Object

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

Field Detail

contentId

@Nonnull
protected String contentId

Typically the URL of the media

contentType

@Nonnull
protected String contentType

The content MIME-type

contentUrl

@Nullable
protected 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

@Nullable
protected Map<String,Object> customData

Application-specific media information

duration

@Nullable
protected Double duration

The media duration

entity

@Nullable
protected String entity

Optional Google Assistant deep link to a media entity

hlsSegmentFormat

@Nullable
protected Media.HlsSegmentFormat hlsSegmentFormat

The format of the HLS audio segment

hlsVideoSegmentFormat

@Nullable
protected Media.HlsVideoSegmentFormat hlsVideoSegmentFormat

The format of the HLS video segment

mediaCategory

@Nullable
protected Media.MediaCategory mediaCategory

The media category (audio, video, picture)

metadata

@Nullable
protected Map<String,Object> metadata

The media metadata

startAbsoluteTime

@Nullable
protected 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 Media.StreamType streamType

The stream type (required)

textTrackStyle

@Nullable
protected TextTrackStyle textTrackStyle

The style of text track

tracks

@Nullable
protected List<Track> tracks

The media tracks

Constructor Detail

MediaBuilder

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

Creates a new instance using the specified parameters.

Parameters:

contentUrl - the URL of the media content.

contentType - the content MIME-type.

streamType - the stream type.

MediaBuilder

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

"modify()" constructor that simply copies an existing Media instance's fields.

Parameters:

contentId - the content ID, typically the URL of the media.

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.

textTrackStyle - the style of text track.

tracks - the media tracks.

Method Detail

contentId

@Nonnull
public String contentId()

Returns:

The content ID, typically the URL of the media.

contentId

@Nonnull
public Media.MediaBuilder contentId(@Nonnull
                                              String contentId)

Parameters:

contentId - the content ID, typically the URL of the media.

Returns:

This Media.MediaBuilder.

contentType

@Nonnull
public String contentType()

Returns:

The content MIME-type.

contentTypeId

@Nonnull
public Media.MediaBuilder contentTypeId(@Nonnull
                                                  String contentType)

Parameters:

contentType - the content MIME-type.

Returns:

This Media.MediaBuilder.

contentUrl

@Nullable
public String contentUrl()

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.

contentUrl

@Nonnull
public Media.MediaBuilder contentUrl(@Nullable
                                               String contentUrl)

Parameters:

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.

Returns:

This Media.MediaBuilder.

customData

@Nullable
public Map<String,Object> customData()

Returns:

The application-specific media information.

customData

@Nonnull
public Media.MediaBuilder customData(@Nullable
                                               Map<String,Object> customData)

Parameters:

customData - the application-specific media information.

Returns:

This Media.MediaBuilder.

duration

@Nullable
public Double duration()

Returns:

The media duration.

duration

@Nonnull
public Media.MediaBuilder duration(@Nullable
                                             Double duration)

Parameters:

duration - the media duration.

Returns:

This Media.MediaBuilder.

entity

@Nullable
public String entity()

Returns:

The optional Google Assistant deep link to a media entity.

entity

@Nonnull
public Media.MediaBuilder entity(@Nullable
                                           String entity)

Parameters:

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

Returns:

This Media.MediaBuilder.

hlsSegmentFormat

@Nullable
public Media.HlsSegmentFormat hlsSegmentFormat()

Returns:

The format of the HLS audio segment.

hlsSegmentFormat

@Nonnull
public Media.MediaBuilder hlsSegmentFormat(@Nullable
                                                     Media.HlsSegmentFormat hlsSegmentFormat)

Parameters:

hlsSegmentFormat - the format of the HLS audio segment.

Returns:

This Media.MediaBuilder.

hlsVideoSegmentFormat

@Nullable
public Media.HlsVideoSegmentFormat hlsVideoSegmentFormat()

Returns:

The format of the HLS video segment.

hlsVideoSegmentFormat

@Nonnull
public Media.MediaBuilder hlsVideoSegmentFormat(@Nullable
                                                          Media.HlsVideoSegmentFormat hlsVideoSegmentFormat)

Parameters:

hlsVideoSegmentFormat - the format of the HLS video segment.

Returns:

This Media.MediaBuilder.

mediaCategory

@Nullable
public Media.MediaCategory mediaCategory()

Returns:

The media category.

mediaCategory

@Nonnull
public Media.MediaBuilder mediaCategory(@Nullable
                                                  Media.MediaCategory mediaCategory)

Parameters:

mediaCategory - the media category.

Returns:

This Media.MediaBuilder.

metadata

@Nullable
public Map<String,Object> metadata()

Returns:

The media metadata.

metadata

@Nonnull
public Media.MediaBuilder metadata(@Nullable
                                             Map<String,Object> metadata)

Parameters:

metadata - the media metadata.

Returns:

This Media.MediaBuilder.

startAbsoluteTime

@Nullable
public Long startAbsoluteTime()

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.

startAbsoluteTime

@Nonnull
public Media.MediaBuilder startAbsoluteTime(@Nullable
                                                      Long startAbsoluteTime)

Parameters:

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.

Returns:

This Media.MediaBuilder.

streamType

@Nonnull
public Media.StreamType streamType()

Returns:

The stream type.

streamType

@Nonnull
public Media.MediaBuilder streamType(@Nonnull
                                               Media.StreamType streamType)

Parameters:

streamType - the stream type.

Returns:

This Media.MediaBuilder.

textTrackStyle

@Nullable
public TextTrackStyle textTrackStyle()

Returns:

The style of text track.

textTrackStyle

@Nonnull
public Media.MediaBuilder textTrackStyle(@Nullable
                                                   TextTrackStyle textTrackStyle)

Parameters:

textTrackStyle - the style of text track.

Returns:

This Media.MediaBuilder.

tracks

@Nullable
public List<Track> tracks()

Returns:

The media Tracks.

addTrack

@Nonnull
public Media.MediaBuilder addTrack(@Nullable
                                             Track track)

Appends the specified Track to the end of this Media.MediaBuilder's tracks. If tracks is null, a new ArrayList is created first.

Parameters:

track - the Track to add.

Returns:

This Media.MediaBuilder.

addTrack

@Nonnull
public Media.MediaBuilder addTrack(int index,
                                             @Nullable
                                             Track track)

Inserts the specified Track at the specified position in this Media.MediaBuilder's tracks. If tracks is null, a new ArrayList is created first.

Parameters:

index - the index where the Track should be inserted.

track - the Track to add.

Returns:

This Media.MediaBuilder.

clearTracks

@Nonnull
public Media.MediaBuilder clearTracks()

Removes all tracks from this Media.MediaBuilder.

Returns:

This Media.MediaBuilder.

removeTrack

@Nonnull
public Media.MediaBuilder removeTrack(int index)

Removes the Track at the specified position in this Media.MediaBuilder.

Parameters:

index - the index of the Track to be removed.

Returns:

This Media.MediaBuilder.

Throws:

IndexOutOfBoundsException - If the index is out of range.

removeTrack

@Nonnull
public Media.MediaBuilder removeTrack(@Nullable
                                                Track track)

Removed the first occurrence specified Track from this Media.MediaBuilder, if it's present.

Parameters:

track - the Track to remove.

Returns:

This Media.MediaBuilder.

tracks

@Nonnull
public Media.MediaBuilder tracks(@Nullable
                                           List<Track> tracks)

Parameters:

tracks - the media Tracks.

Returns:

This Media.MediaBuilder.

build

@Nonnull
public Media build()

Returns:

A new Media instance with the content from this Media.MediaBuilder.