Class TypedSource.Builder
-
- All Implemented Interfaces:
public class TypedSource.BuilderThe builder for TypedSource.
-
-
Field Summary
Fields Modifier and Type Field Description protected DRMConfigurationdrmprotected SourceTypetypeprotected Map<String, String>headersprotected DoubleliveOffsetprotected SsaiDescriptionssaiprotected BooleanhlsDateRangeprotected StringtimeServerprotected BooleanlowLatencyprotected LatencyConfigurationlatencyConfigurationprotected HlsPlaybackConfigurationhlsprotected DashPlaybackConfigurationdashprotected CMCDTransmissionModecmcdTransmissionModeprotected Stringsrc
-
Constructor Summary
Constructors Constructor Description TypedSource.Builder(String src)Creates a builder for a simple TypedSource object containing the given URL as source.
-
Method Summary
Modifier and Type Method Description final <Error class: unknown class>drm(DRMConfiguration drm)Sets the DRM configuration. final <Error class: unknown class>type(SourceType type)Sets the type of the source. final <Error class: unknown class>headers(Map<String, String> headers)Sets the headers to be added to all requests associated with this source. final <Error class: unknown class>liveOffset(Double liveOffset)Sets the live point from the end of the manifest, in seconds. <Error class: unknown class>ssai(SsaiDescription ssai)Sets the Server-side ad insertion description. final <Error class: unknown class>hlsDateRange(Boolean hlsDateRange)Sets whether the logic to expose date ranges parsed from HLS manifests is enabled. final <Error class: unknown class>timeServer(String timeServer)Sets the URL of a time server used by the player to synchronise the time in DASH sources. final <Error class: unknown class>lowLatency(Boolean lowLatency)Sets whether the source should be played in the low-latency-mode of the player. final <Error class: unknown class>latencyConfiguration(LatencyConfiguration latencyConfiguration)Sets the latency configuration for this source. final <Error class: unknown class>hls(HlsPlaybackConfiguration hlsPlaybackConfiguration)Sets the configuration for controlling playback of an HLS stream. final <Error class: unknown class>dash(DashPlaybackConfiguration dashPlaybackConfiguration)Sets the configuration for controlling playback of an DASH stream. final <Error class: unknown class>cmcdTransmissionMode(CMCDTransmissionMode cmcdTransmissionMode)Sets the transmission mode to be used for Common Media Client Data (CTA-5004). TypedSourcebuild()Builds the TypedSource. -
-
Constructor Detail
-
TypedSource.Builder
TypedSource.Builder(String src)
Creates a builder for a simple TypedSource object containing the given URL as source.- Parameters:
src- The source URL of the manifest or video file to be played.
-
-
Method Detail
-
drm
final <Error class: unknown class> drm(DRMConfiguration drm)
Sets the DRM configuration.
- Parameters:
drm- The DRMConfiguration.
-
type
final <Error class: unknown class> type(SourceType type)
Sets the type of the source.
For all possibilities, see SourceType.
- Parameters:
type- The SourceType.
-
headers
final <Error class: unknown class> headers(Map<String, String> headers)
Sets the headers to be added to all requests associated with this source.
Only supported for MP3 & MP4 sources.
- Parameters:
headers- The headers of this source.- Since:
v7.12.0
-
liveOffset
final <Error class: unknown class> liveOffset(Double liveOffset)
Sets the live point from the end of the manifest, in seconds.
If set as null, the live point offset will be 3 target durations.
- Parameters:
liveOffset- the live point from the end of the manifest, in seconds.
-
ssai
<Error class: unknown class> ssai(SsaiDescription ssai)
Sets the Server-side ad insertion description.
- Parameters:
ssai- The Server-side ad insertion description.
-
hlsDateRange
final <Error class: unknown class> hlsDateRange(Boolean hlsDateRange)
Sets whether the logic to expose date ranges parsed from HLS manifests is enabled.
If not set, TypedSource.hlsDateRange will be null.
- Parameters:
hlsDateRange- Whether the logic to expose date ranges parsed from HLS manifests is enabled.
-
timeServer
final <Error class: unknown class> timeServer(String timeServer)
Sets the URL of a time server used by the player to synchronise the time in DASH sources.
The time server should return time in ISO-8601 format.
Overrides the time server provided the DASH manifest's
<UTCTiming>.Only this source will use the time server. Alternatively, for all sources use SourceDescription.Builder.timeServer.
- Parameters:
timeServer- The URL of a time server.- Since:
v2.72.0
-
lowLatency
final <Error class: unknown class> lowLatency(Boolean lowLatency)
Sets whether the source should be played in the low-latency-mode of the player.
This setting must be
truewhen using Low-Latency CMAF with ABR.
Default: false
- Parameters:
lowLatency- Whether the source should be played in the low-latency-mode of the player.- Since:
v2.72.0
-
latencyConfiguration
final <Error class: unknown class> latencyConfiguration(LatencyConfiguration latencyConfiguration)
Sets the latency configuration for this source.
Ignored for VOD playback.
- Parameters:
latencyConfiguration- The source's latency configuration.
-
hls
final <Error class: unknown class> hls(HlsPlaybackConfiguration hlsPlaybackConfiguration)
Sets the configuration for controlling playback of an HLS stream.
- Parameters:
hlsPlaybackConfiguration- The HLS playback configuration.- Since:
v4.0.0
-
dash
final <Error class: unknown class> dash(DashPlaybackConfiguration dashPlaybackConfiguration)
Sets the configuration for controlling playback of an DASH stream.
- Parameters:
dashPlaybackConfiguration- The DASH playback configuration.- Since:
v5.2.0
-
cmcdTransmissionMode
final <Error class: unknown class> cmcdTransmissionMode(CMCDTransmissionMode cmcdTransmissionMode)
Sets the transmission mode to be used for Common Media Client Data (CTA-5004).
Default: CMCDTransmissionMode.DISABLED, i.e. transmitting Common Media Client Data (CMCD) is disabled.
- Parameters:
cmcdTransmissionMode- The transmission mode to be used for Common Media Client Data (CTA-5004).- Since:
v8.13.0
-
build
TypedSource build()
Builds the TypedSource.
-
-
-
-