MediaSource.Factory

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

public interface MediaSource.Factory

Known direct subclasses

ExternallyLoadedMediaSource.Factory, HlsInterstitialsAdsLoader.AdsMediaSourceFactory, ImaServerSideAdInsertionMediaSource.Factory, MediaSourceFactory, PreloadMediaSource.Factory

`ExternallyLoadedMediaSource.Factory`	Factory for `ExternallyLoadedMediaSource`.
`HlsInterstitialsAdsLoader.AdsMediaSourceFactory`	A `MediaSource.Factory` to create a media source to play HLS streams with interstitials.
`ImaServerSideAdInsertionMediaSource.Factory`	Factory for creating `ImaServerSideAdInsertionMediaSources`.
`MediaSourceFactory`	This interface is deprecated. Use `MediaSource.Factory`.
`PreloadMediaSource.Factory`	Factory for `PreloadMediaSource`.

Known indirect subclasses

DashMediaSource.Factory, DefaultMediaSourceFactory, FakeMediaSourceFactory, HlsMediaSource.Factory, ProgressiveMediaSource.Factory, RtspMediaSource.Factory, SsMediaSource.Factory

`DashMediaSource.Factory`	Factory for `DashMediaSource`s.
`DefaultMediaSourceFactory`	The default `MediaSource.Factory` implementation.
`FakeMediaSourceFactory`	Fake `MediaSourceFactory` that creates a `FakeMediaSource`.
`HlsMediaSource.Factory`	Factory for `HlsMediaSource`s.
`ProgressiveMediaSource.Factory`	Factory for `ProgressiveMediaSource`s.
`RtspMediaSource.Factory`	Factory for `RtspMediaSource`
`SsMediaSource.Factory`	Factory for `SsMediaSource`.

Factory for creating MediaSources from MediaItems.

Summary

Constants
`default static final MediaSource.Factory`	`@UnstableApi UNSUPPORTED` An instance that throws `UnsupportedOperationException` from `createMediaSource` and `getSupportedTypes`.

Public methods
`abstract MediaSource`	`@UnstableApi createMediaSource(MediaItem mediaItem)` Creates a new `MediaSource` with the specified `MediaItem`.
`default MediaSource.Factory`	`@UnstableApi experimentalParseSubtitlesDuringExtraction( boolean parseSubtitlesDuringExtraction )` This method is deprecated. This method (and all support for 'legacy' subtitle decoding during rendering) will be removed in a future release.
`default MediaSource.Factory`	`@UnstableApi @CanIgnoreReturnValue experimentalSetCodecsToParseWithinGopSampleDependencies( @C.VideoCodecFlags int codecsToParseWithinGopSampleDependencies )` Sets the set of video codecs for which within GOP sample dependency information should be parsed as part of extraction.
`abstract int[]`	`@UnstableApi @C.ContentType getSupportedTypes()` Returns the `content types` supported by media sources created by this factory.
`default MediaSource.Factory`	`@UnstableApi setCmcdConfigurationFactory( CmcdConfiguration.Factory cmcdConfigurationFactory )` Sets the `CmcdConfiguration.Factory` used to obtain a `CmcdConfiguration` for a `MediaItem`.
`default MediaSource.Factory`	`@UnstableApi @CanIgnoreReturnValue setDownloadExecutor(Supplier<ReleasableExecutor> downloadExecutor)` Sets a supplier for an `ReleasableExecutor` that is used for loading the media.
`abstract MediaSource.Factory`	`@UnstableApi setDrmSessionManagerProvider( DrmSessionManagerProvider drmSessionManagerProvider )` Sets the `DrmSessionManagerProvider` used to obtain a `DrmSessionManager` for a `MediaItem`.
`abstract MediaSource.Factory`	`@UnstableApi setLoadErrorHandlingPolicy( LoadErrorHandlingPolicy loadErrorHandlingPolicy )` Sets an optional `LoadErrorHandlingPolicy`.
`default MediaSource.Factory`	`@UnstableApi setSubtitleParserFactory(SubtitleParser.Factory subtitleParserFactory)` Sets the `SubtitleParser.Factory` to be used for parsing subtitles during extraction.

Constants

UNSUPPORTED

@UnstableApi
default static final MediaSource.Factory UNSUPPORTED

An instance that throws UnsupportedOperationException from createMediaSource and getSupportedTypes.

Public methods

createMediaSource

@UnstableApi
abstract MediaSource createMediaSource(MediaItem mediaItem)

Creates a new MediaSource with the specified MediaItem.

Parameters
`MediaItem mediaItem`	The media item to play.

Returns
`MediaSource`	The new `media source`.

experimentalParseSubtitlesDuringExtraction

@UnstableApi
default MediaSource.Factory experimentalParseSubtitlesDuringExtraction(
    boolean parseSubtitlesDuringExtraction
)

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.

Parameters
`boolean parseSubtitlesDuringExtraction`	Whether to parse subtitles during extraction or rendering.

Returns
`MediaSource.Factory`	This factory, for convenience.

experimentalSetCodecsToParseWithinGopSampleDependencies

@UnstableApi
@CanIgnoreReturnValue
default MediaSource.Factory experimentalSetCodecsToParseWithinGopSampleDependencies(
    @C.VideoCodecFlags int codecsToParseWithinGopSampleDependencies
)

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.

Parameters
`@C.VideoCodecFlags int codecsToParseWithinGopSampleDependencies`	The set of codecs for which to parse within GOP sample dependency information.

Returns
`MediaSource.Factory`	This factory, for convenience.

getSupportedTypes

@UnstableApi
@C.ContentType
abstract int[] getSupportedTypes()

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

setCmcdConfigurationFactory

@UnstableApi
default MediaSource.Factory setCmcdConfigurationFactory(
    CmcdConfiguration.Factory cmcdConfigurationFactory
)

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

Returns
`MediaSource.Factory`	This factory, for convenience.

setDownloadExecutor

@UnstableApi
@CanIgnoreReturnValue
default MediaSource.Factory setDownloadExecutor(Supplier<ReleasableExecutor> downloadExecutor)

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

Parameters
`Supplier<ReleasableExecutor> downloadExecutor`	A `Supplier` that provides an externally managed `ReleasableExecutor` for downloading and extraction.

Returns
`MediaSource.Factory`	This factory, for convenience.

setDrmSessionManagerProvider

@UnstableApi
abstract MediaSource.Factory setDrmSessionManagerProvider(
    DrmSessionManagerProvider drmSessionManagerProvider
)

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

Returns
`MediaSource.Factory`	This factory, for convenience.

setLoadErrorHandlingPolicy

@UnstableApi
abstract MediaSource.Factory setLoadErrorHandlingPolicy(
    LoadErrorHandlingPolicy loadErrorHandlingPolicy
)

Sets an optional LoadErrorHandlingPolicy.

Returns
`MediaSource.Factory`	This factory, for convenience.

setSubtitleParserFactory

@UnstableApi
default MediaSource.Factory setSubtitleParserFactory(SubtitleParser.Factory subtitleParserFactory)

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

Parameters
`SubtitleParser.Factory subtitleParserFactory`	The `SubtitleParser.Factory` for parsing subtitles during extraction.

Returns
`MediaSource.Factory`	This factory, for convenience.