Class SourceDescription
-
- All Implemented Interfaces:
public final class SourceDescriptionA Source Description.
This contains the settings to be applied for a source.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classSourceDescription.BuilderThe builder for SourceDescription.
-
Field Summary
Fields Modifier and Type Field Description private final List<TypedSource>sourcesprivate final List<AdDescription>adsprivate final List<TextTrackDescription>textTracksprivate final Stringposterprivate final MetadataDescriptionmetadataprivate final StringtimeServerprivate final SourceAbrConfigurationabrprivate final StreamTypestreamType
-
Constructor Summary
Constructors Constructor Description SourceDescription(List<TypedSource> sources, List<AdDescription> ads, List<TextTrackDescription> textTracks, String poster, MetadataDescription metadata, String timeServer, SourceAbrConfiguration abr, StreamType streamType, SourceDVRConfiguration dvr)
-
Method Summary
Modifier and Type Method Description final List<TypedSource>getSources()List of TypedSources that represent the available sources in this SourceDescription. final List<AdDescription>getAds()List of AdDescriptions of the source. final List<TextTrackDescription>getTextTracks()List of side-loaded text tracks of the source. final StringgetPoster()The poster image url of this source description. final MetadataDescriptiongetMetadata()The MetadataDescription for this source description. final StringgetTimeServer()The URL of the time server. final SourceAbrConfigurationgetAbr()Describes the ABR configuration for a specific source. final StreamTypegetStreamType()The stream type. -
-
Constructor Detail
-
SourceDescription
SourceDescription(List<TypedSource> sources, List<AdDescription> ads, List<TextTrackDescription> textTracks, String poster, MetadataDescription metadata, String timeServer, SourceAbrConfiguration abr, StreamType streamType, SourceDVRConfiguration dvr)
-
-
Method Detail
-
getSources
final List<TypedSource> getSources()
List of TypedSources that represent the available sources in this SourceDescription. (NonNull)
The first element of the list will initially be used as the player’s source.
When that source is unavailable, the player will fall back to the other elements of this list.
-
getAds
final List<AdDescription> getAds()
List of AdDescriptions of the source. (NonNull)
All valid and supported advertisement files will be cued for playback in the player following the provided advertisement specification.
Each ad in the list should be described as an AdDescription.
-
getTextTracks
final List<TextTrackDescription> getTextTracks()
List of side-loaded text tracks of the source. (NonNull)
All valid tracks will be available during playback.
Each text track should be described as a TextTrackDescription.
-
getPoster
final String getPoster()
The poster image url of this source description. (Nullable)
A placeholder for the content between the time that the content has loaded and the user presses play.
-
getMetadata
final MetadataDescription getMetadata()
The MetadataDescription for this source description. (Nullable)
-
getTimeServer
final String getTimeServer()
The URL of the time server. (Nullable)
The time server should return time in ISO-8601 format.
Applies for all sources.
-
getAbr
final SourceAbrConfiguration getAbr()
Describes the ABR configuration for a specific source.
-
getStreamType
final StreamType getStreamType()
The stream type. (Nullable)
This is used as a hint for the player to show the correct UI while loading the stream, for example to avoid showing a seek bar when the stream is known in advance to be live.
This is required for live and DVR streams when casting to Chromecast, in order for the Chromecast receiver to show the correct UI.
- Since:
v10.2.0
-
-
-
-