FilteringMediaSource

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
public class FilteringMediaSource extends WrappingMediaSource

java.lang.Object
↳	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 int trackType)` Creates a filtering `MediaSource` that only publishes tracks of one type.
`FilteringMediaSource( MediaSource mediaSource, Set<@C.TrackType Integer> trackTypes )` Creates a filtering `MediaSource` that only publishes tracks of the given types.

Public methods
`MediaPeriod`	`createPeriod( MediaSource.MediaPeriodId id, Allocator allocator, long startPositionUs )` Creates the requested `MediaPeriod`.
`void`	`releasePeriod(MediaPeriod mediaPeriod)` Releases a `MediaPeriod`.

Inherited fields

From androidx.media3.exoplayer.source.BaseMediaSource

@Nullable PlayerId

playerId

From androidx.media3.exoplayer.source.WrappingMediaSource

final MediaSource

mediaSource

The wrapped child MediaSource.

Inherited methods

From androidx.media3.exoplayer.source.BaseMediaSource

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

From androidx.media3.exoplayer.source.CompositeMediaSource

`final void`	`disableChildSource(@UnknownNull T id)` Disables a child source.
`void`	`@CallSuper disableInternal()` Disables the source, see `disable`.
`final void`	`enableChildSource(@UnknownNull T id)` Enables a child source.
`void`	`@CallSuper enableInternal()` Enables the source, see `enable`.
`@Nullable MediaSource.MediaPeriodId`	`getMediaPeriodIdForChildMediaPeriodId( @UnknownNull T childSourceId, MediaSource.MediaPeriodId mediaPeriodId )` Returns the `MediaPeriodId` in the composite source corresponding to the specified in a child source.
`long`	`getMediaTimeForChildMediaTime( @UnknownNull T childSourceId, long mediaTimeMs, @Nullable MediaSource.MediaPeriodId 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 T childSourceId, int windowIndex )` Returns the window index in the composite source corresponding to the specified window index in a child source.
`void`	`@CallSuper maybeThrowSourceInfoRefreshError()` Throws any pending error encountered while loading or refreshing source information.
`abstract void`	`onChildSourceInfoRefreshed( @UnknownNull T childSourceId, MediaSource mediaSource, Timeline newTimeline )` Called when the source info of a child source has been refreshed.
`final void`	`prepareChildSource(@UnknownNull T id, MediaSource mediaSource)` Prepares a child source.
`final void`	`releaseChildSource(@UnknownNull T id)` Releases a child source.
`void`	`@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.
`final void`	`disableChildSource()` Disables the child source.
`final void`	`enableChildSource()` Enables the child source.
`@Nullable 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.
`@Nullable MediaSource.MediaPeriodId`	`getMediaPeriodIdForChildMediaPeriodId( MediaSource.MediaPeriodId mediaPeriodId )` Returns the `MediaPeriodId` in the wrapping source corresponding to the specified in a child source.
`final @Nullable MediaSource.MediaPeriodId`	`getMediaPeriodIdForChildMediaPeriodId( Void childSourceId, MediaSource.MediaPeriodId mediaPeriodId )` Returns the `MediaPeriodId` in the composite source corresponding to the specified in a child source.
`long`	`getMediaTimeForChildMediaTime( long mediaTimeMs, @Nullable MediaSource.MediaPeriodId 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.
`final long`	`getMediaTimeForChildMediaTime( Void childSourceId, long mediaTimeMs, @Nullable MediaSource.MediaPeriodId 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(int windowIndex)` Returns the window index in the wrapping source corresponding to the specified window index in a child source.
`final int`	`getWindowIndexForChildWindowIndex(Void childSourceId, int windowIndex)` 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.
`void`	`onChildSourceInfoRefreshed(Timeline newTimeline)` Called when the child source info has been refreshed.
`final void`	`onChildSourceInfoRefreshed( Void childSourceId, MediaSource mediaSource, Timeline newTimeline )` Called when the source info of a child source has been refreshed.
`final void`	`prepareChildSource()` Prepares the wrapped child source.
`void`	`prepareSourceInternal()` Starts source preparation and enables the source, see `prepareSource`.
`final void`	`prepareSourceInternal(@Nullable TransferListener mediaTransferListener)` Starts source preparation and enables the source, see `prepareSource`.
`final void`	`releaseChildSource()` Releases the child source.
`void`	`updateMediaItem(MediaItem mediaItem)` Updates the for this source.

Public constructors

FilteringMediaSource

public FilteringMediaSource(MediaSource mediaSource, @C.TrackType int trackType)

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

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

FilteringMediaSource

public FilteringMediaSource(
    MediaSource mediaSource,
    Set<@C.TrackType Integer> trackTypes
)

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

Parameters
`MediaSource mediaSource`	The wrapped `MediaSource`.
`Set<@C.TrackType Integer> trackTypes`	The `track types` to provide from this source.

Public methods

createPeriod

public MediaPeriod createPeriod(
    MediaSource.MediaPeriodId id,
    Allocator allocator,
    long startPositionUs
)

Creates the requested MediaPeriod.

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

See also
`createPeriod`

releasePeriod

public void releasePeriod(MediaPeriod mediaPeriod)

Releases a MediaPeriod.

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

See also
`releasePeriod`