FilteringMediaSource

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
class FilteringMediaSource : WrappingMediaSource

kotlin.Any
↳	androidx.media3.exoplayer.source.BaseMediaSource
	↳	androidx.media3.exoplayer.source.CompositeMediaSource
		↳	androidx.media3.exoplayer.source.WrappingMediaSource
			↳	androidx.media3.exoplayer.source.FilteringMediaSource

A MediaSource that filters the available track types.

Media sources loading muxed media, e.g. progressive streams with muxed video and audio, are still likely to parse all of these streams even if the tracks are not made available to the player.

Summary

Public constructors
`FilteringMediaSource(mediaSource: MediaSource!, @C.TrackType trackType: Int)` Creates a filtering `MediaSource` that only publishes tracks of one type.
`FilteringMediaSource( mediaSource: MediaSource!, trackTypes: (Mutable)Set<@C.TrackType Int!>! )` Creates a filtering `MediaSource` that only publishes tracks of the given types.

Public functions
`MediaPeriod!`	`createPeriod( id: MediaSource.MediaPeriodId!, allocator: Allocator!, startPositionUs: Long )` Creates the requested `MediaPeriod`.
`Unit`	`releasePeriod(mediaPeriod: MediaPeriod!)` Releases a `MediaPeriod`.

Inherited functions

From androidx.media3.exoplayer.source.BaseMediaSource

`Unit`	`addDrmEventListener( handler: Handler!, eventListener: DrmSessionEventListener! )` Adds a `DrmSessionEventListener` to the list of listeners which are notified of DRM events for this media source.
`Unit`	`addEventListener( handler: Handler!, eventListener: MediaSourceEventListener! )` Adds a `MediaSourceEventListener` to the list of listeners which are notified of media source events.
`DrmSessionEventListener.EventDispatcher!`	`createDrmEventDispatcher(mediaPeriodId: MediaSource.MediaPeriodId?)` Returns a `DrmSessionEventListener.EventDispatcher` which dispatches all events to the registered listeners with the specified `MediaPeriodId`
`DrmSessionEventListener.EventDispatcher!`	`createDrmEventDispatcher( windowIndex: Int, mediaPeriodId: MediaSource.MediaPeriodId? )` Returns a `DrmSessionEventListener.EventDispatcher` which dispatches all events to the registered listeners with the specified window index and `MediaPeriodId`.
`MediaSourceEventListener.EventDispatcher!`	`createEventDispatcher(mediaPeriodId: MediaSource.MediaPeriodId?)` Returns a `MediaSourceEventListener.EventDispatcher` which dispatches all events to the registered listeners with the specified `MediaPeriodId`.
`MediaSourceEventListener.EventDispatcher!`	`createEventDispatcher( mediaPeriodId: MediaSource.MediaPeriodId!, mediaTimeOffsetMs: Long )` This function is deprecated. Use `createEventDispatcher` instead.
`MediaSourceEventListener.EventDispatcher!`	`createEventDispatcher( windowIndex: Int, mediaPeriodId: MediaSource.MediaPeriodId? )` Returns a `MediaSourceEventListener.EventDispatcher` which dispatches all events to the registered listeners with the specified window index and `MediaPeriodId`.
`MediaSourceEventListener.EventDispatcher!`	`createEventDispatcher( windowIndex: Int, mediaPeriodId: MediaSource.MediaPeriodId?, mediaTimeOffsetMs: Long )` This function is deprecated. Use `createEventDispatcher` instead.
`Unit`	`disable(caller: MediaSource.MediaSourceCaller!)` Disables the source for the creation of `MediaPeriods`.
`Unit`	`enable(caller: MediaSource.MediaSourceCaller!)` Enables the source for the creation of `MediaPeriods`.
`Boolean`	`isEnabled()` Returns whether the source is enabled.
`Unit`	`prepareSource( caller: MediaSource.MediaSourceCaller!, mediaTransferListener: TransferListener? )` This function is deprecated. Implement `prepareSource` instead.
`Unit`	`prepareSource( caller: MediaSource.MediaSourceCaller!, mediaTransferListener: TransferListener?, playerId: PlayerId! )` Registers a `MediaSourceCaller`.
`Boolean`	`prepareSourceCalled()` Returns whether the source has `prepareSource` called.
`Unit`	`refreshSourceInfo(timeline: Timeline!)` Updates timeline and manifest and notifies all listeners of the update.
`Unit`	`releaseSource(caller: MediaSource.MediaSourceCaller!)` Unregisters a caller, and disables and releases the source if no longer required.
`Unit`	`removeDrmEventListener(eventListener: DrmSessionEventListener!)` Removes a `DrmSessionEventListener` from the list of listeners which are notified of DRM events for this media source.
`Unit`	`removeEventListener(eventListener: MediaSourceEventListener!)` Removes a `MediaSourceEventListener` from the list of listeners which are notified of media source events.

From androidx.media3.exoplayer.source.CompositeMediaSource

`Unit`	`disableChildSource(@UnknownNull id: T!)` Disables a child source.
`Unit`	`@CallSuper disableInternal()` Disables the source, see `disable`.
`Unit`	`enableChildSource(@UnknownNull id: T!)` Enables a child source.
`Unit`	`@CallSuper enableInternal()` Enables the source, see `enable`.
`MediaSource.MediaPeriodId?`	`getMediaPeriodIdForChildMediaPeriodId( @UnknownNull childSourceId: T!, mediaPeriodId: MediaSource.MediaPeriodId! )` Returns the `MediaPeriodId` in the composite source corresponding to the specified in a child source.
`Long`	`getMediaTimeForChildMediaTime( @UnknownNull childSourceId: T!, mediaTimeMs: Long, mediaPeriodId: MediaSource.MediaPeriodId? )` Returns the media time in the `MediaPeriod` of the composite source corresponding to the specified media time in the `MediaPeriod` of the child source.
`Int`	`getWindowIndexForChildWindowIndex( @UnknownNull childSourceId: T!, windowIndex: Int )` Returns the window index in the composite source corresponding to the specified window index in a child source.
`Unit`	`@CallSuper maybeThrowSourceInfoRefreshError()` Throws any pending error encountered while loading or refreshing source information.
`abstract Unit`	`onChildSourceInfoRefreshed( @UnknownNull childSourceId: T!, mediaSource: MediaSource!, newTimeline: Timeline! )` Called when the source info of a child source has been refreshed.
`Unit`	`prepareChildSource(@UnknownNull id: T!, mediaSource: MediaSource!)` Prepares a child source.
`Unit`	`releaseChildSource(@UnknownNull id: T!)` Releases a child source.
`Unit`	`@CallSuper releaseSourceInternal()` Releases the source, see `releaseSource`.

From androidx.media3.exoplayer.source.WrappingMediaSource

`Boolean`	`canUpdateMediaItem(mediaItem: MediaItem!)` Returns whether the for this source can be updated with the provided item.
`Unit`	`disableChildSource()` Disables the child source.
`Unit`	`enableChildSource()` Enables the child source.
`Timeline?`	`getInitialTimeline()` Returns the initial placeholder timeline that is returned immediately when the real timeline is not yet known, or null to let the player create an initial timeline.
`MediaItem!`	`getMediaItem()` Returns the whose media is provided by the source.
`MediaSource.MediaPeriodId?`	`getMediaPeriodIdForChildMediaPeriodId( mediaPeriodId: MediaSource.MediaPeriodId! )` Returns the `MediaPeriodId` in the wrapping source corresponding to the specified in a child source.
`MediaSource.MediaPeriodId?`	`getMediaPeriodIdForChildMediaPeriodId( childSourceId: Void!, mediaPeriodId: MediaSource.MediaPeriodId! )` Returns the `MediaPeriodId` in the composite source corresponding to the specified in a child source.
`Long`	`getMediaTimeForChildMediaTime( mediaTimeMs: Long, mediaPeriodId: MediaSource.MediaPeriodId? )` Returns the media time in the `MediaPeriod` of the wrapping source corresponding to the specified media time in the `MediaPeriod` of the child source.
`Long`	`getMediaTimeForChildMediaTime( childSourceId: Void!, mediaTimeMs: Long, mediaPeriodId: MediaSource.MediaPeriodId? )` Returns the media time in the `MediaPeriod` of the composite source corresponding to the specified media time in the `MediaPeriod` of the child source.
`Int`	`getWindowIndexForChildWindowIndex(windowIndex: Int)` Returns the window index in the wrapping source corresponding to the specified window index in a child source.
`Int`	`getWindowIndexForChildWindowIndex(childSourceId: Void!, windowIndex: Int)` Returns the window index in the composite source corresponding to the specified window index in a child source.
`Boolean`	`isSingleWindow()` Returns true if the media source is guaranteed to never have zero or more than one window.
`Unit`	`onChildSourceInfoRefreshed(newTimeline: Timeline!)` Called when the child source info has been refreshed.
`Unit`	`onChildSourceInfoRefreshed( childSourceId: Void!, mediaSource: MediaSource!, newTimeline: Timeline! )` Called when the source info of a child source has been refreshed.
`Unit`	`prepareChildSource()` Prepares the wrapped child source.
`Unit`	`prepareSourceInternal()` Starts source preparation and enables the source, see `prepareSource`.
`Unit`	`prepareSourceInternal(mediaTransferListener: TransferListener?)` Starts source preparation and enables the source, see `prepareSource`.
`Unit`	`releaseChildSource()` Releases the child source.
`Unit`	`updateMediaItem(mediaItem: MediaItem!)` Updates the for this source.

Inherited properties

From androidx.media3.exoplayer.source.BaseMediaSource

PlayerId?

playerId

From androidx.media3.exoplayer.source.WrappingMediaSource

MediaSource!

mediaSource

The wrapped child MediaSource.

Public constructors

FilteringMediaSource

FilteringMediaSource(mediaSource: MediaSource!, @C.TrackType trackType: Int)

Creates a filtering MediaSource that only publishes tracks of one type.

Parameters
`mediaSource: MediaSource!`	The wrapped `MediaSource`.
`@C.TrackType trackType: Int`	The only `C.TrackType` to provide from this source.

FilteringMediaSource

FilteringMediaSource(
    mediaSource: MediaSource!,
    trackTypes: (Mutable)Set<@C.TrackType Int!>!
)

Creates a filtering MediaSource that only publishes tracks of the given types.

Parameters
`mediaSource: MediaSource!`	The wrapped `MediaSource`.
`trackTypes: (Mutable)Set<@C.TrackType Int!>!`	The `track types` to provide from this source.

Public functions

createPeriod

fun createPeriod(
    id: MediaSource.MediaPeriodId!,
    allocator: Allocator!,
    startPositionUs: Long
): MediaPeriod!

Creates the requested MediaPeriod.

This method typically forwards to the wrapped media source and optionally wraps the returned MediaPeriod.

See also
`createPeriod`

releasePeriod

fun releasePeriod(mediaPeriod: MediaPeriod!): Unit

Releases a MediaPeriod.

This method typically forwards to the wrapped media source and optionally unwraps the provided MediaPeriod.

See also
`releasePeriod`