HlsMediaSource.Factory

Factory(dataSourceFactory: DataSource.Factory!)

Creates a new factory for HlsMediaSources.

The factory will use the following default components:

• DefaultDrmSessionManagerProvider
• DefaultHlsPlaylistParserFactory
• FACTORY
• DefaultHlsExtractorFactory
• DefaultLoadErrorHandlingPolicy
• DefaultCompositeSequenceableLoaderFactory

Factory(hlsDataSourceFactory: HlsDataSourceFactory!)

Creates a new factory for HlsMediaSources.

The factory will use the following default components:

• DefaultDrmSessionManagerProvider
• DefaultHlsPlaylistParserFactory
• FACTORY
• DefaultHlsExtractorFactory
• DefaultLoadErrorHandlingPolicy
• DefaultCompositeSequenceableLoaderFactory

fun createMediaSource(mediaItem: MediaItem!): HlsMediaSource!

Returns a new HlsMediaSource using the current parameters.

@CanIgnoreReturnValue
fun experimentalParseSubtitlesDuringExtraction(
    parseSubtitlesDuringExtraction: Boolean
): HlsMediaSource.Factory!

Sets whether subtitles should be parsed as part of extraction (before being added to the sample queue) or as part of rendering (when being taken from the sample queue). Defaults to true (i.e. subtitles will be parsed during extraction).

This method is experimental and will be renamed or removed in a future release.

@CanIgnoreReturnValue
fun experimentalSetCodecsToParseWithinGopSampleDependencies(
    @C.VideoCodecFlags codecsToParseWithinGopSampleDependencies: Int
): HlsMediaSource.Factory!

Sets the set of video codecs for which within GOP sample dependency information should be parsed as part of extraction. Defaults to 0 - empty set of codecs.

Having access to additional sample dependency information can speed up seeking. See FLAG_READ_WITHIN_GOP_SAMPLE_DEPENDENCIES.

This method is experimental and will be renamed or removed in a future release.

@C.ContentType
fun getSupportedTypes(): IntArray<Int>!

Returns the content types supported by media sources created by this factory.

@CanIgnoreReturnValue
fun setAllowChunklessPreparation(allowChunklessPreparation: Boolean): HlsMediaSource.Factory!

Sets whether chunkless preparation is allowed. If true, preparation without chunk downloads will be enabled for streams that provide sufficient information in their multivariant playlist.

@CanIgnoreReturnValue
fun setCmcdConfigurationFactory(
    cmcdConfigurationFactory: CmcdConfiguration.Factory!
): HlsMediaSource.Factory!

Sets the CmcdConfiguration.Factory used to obtain a CmcdConfiguration for a MediaItem.

@CanIgnoreReturnValue
fun setCompositeSequenceableLoaderFactory(
    compositeSequenceableLoaderFactory: CompositeSequenceableLoaderFactory!
): HlsMediaSource.Factory!

Sets the factory to create composite SequenceableLoaders for when this media source loads data from multiple streams (video, audio etc...).

@CanIgnoreReturnValue
fun setDownloadExecutor(downloadExecutor: Supplier<ReleasableExecutor!>!): HlsMediaSource.Factory!

Sets a supplier for an ReleasableExecutor that is used for loading the media.

@CanIgnoreReturnValue
fun setDrmSessionManagerProvider(
    drmSessionManagerProvider: DrmSessionManagerProvider!
): HlsMediaSource.Factory!

Sets the DrmSessionManagerProvider used to obtain a DrmSessionManager for a MediaItem.

@CanIgnoreReturnValue
fun setExtractorFactory(extractorFactory: HlsExtractorFactory?): HlsMediaSource.Factory!

Sets the factory for Extractors for the segments. The default value is DefaultHlsExtractorFactory.

Any values passed to setSubtitleParserFactory or experimentalParseSubtitlesDuringExtraction will be forwarded to the provided HlsExtractorFactory instance during createMediaSource.

@CanIgnoreReturnValue
fun setLoadErrorHandlingPolicy(
    loadErrorHandlingPolicy: LoadErrorHandlingPolicy!
): HlsMediaSource.Factory!

Sets an optional LoadErrorHandlingPolicy.

@CanIgnoreReturnValue
fun setMetadataType(@HlsMediaSource.MetadataType metadataType: Int): HlsMediaSource.Factory!

Sets the type of metadata to extract from the HLS source (defaults to METADATA_TYPE_ID3).

HLS supports in-band ID3 in both TS and fMP4 streams, but in the fMP4 case the data is wrapped in an EMSG box [spec].

If this is set to METADATA_TYPE_ID3 then raw ID3 metadata of will be extracted from TS sources. From fMP4 streams EMSGs containing metadata of this type (in the variant stream only) will be unwrapped to expose the inner data. All other in-band metadata will be dropped.

If this is set to METADATA_TYPE_EMSG then all EMSG data from the fMP4 variant stream will be extracted. No metadata will be extracted from TS streams, since they don't support EMSG.

@CanIgnoreReturnValue
fun setPlaylistParserFactory(
    playlistParserFactory: HlsPlaylistParserFactory!
): HlsMediaSource.Factory!

Sets the factory from which playlist parsers will be obtained.

@CanIgnoreReturnValue
fun setPlaylistTrackerFactory(
    playlistTrackerFactory: HlsPlaylistTracker.Factory!
): HlsMediaSource.Factory!

Sets the HlsPlaylistTracker factory.

@CanIgnoreReturnValue
fun setSubtitleParserFactory(subtitleParserFactory: SubtitleParser.Factory!): HlsMediaSource.Factory!

Sets the SubtitleParser.Factory to be used for parsing subtitles during extraction.

@CanIgnoreReturnValue
fun setTimestampAdjusterInitializationTimeoutMs(
    timestampAdjusterInitializationTimeoutMs: Long
): HlsMediaSource.Factory!

Sets the timeout for the loading thread to wait for the timestamp adjuster to initialize, in milliseconds.The default value is zero, which is interpreted as an infinite timeout.

@CanIgnoreReturnValue
fun setUseSessionKeys(useSessionKeys: Boolean): HlsMediaSource.Factory!

Sets whether to use #EXT-X-SESSION-KEY tags provided in the multivariant playlist. If enabled, it's assumed that any single session key declared in the multivariant playlist can be used to obtain all of the keys required for playback. For media where this is not true, this option should not be enabled.