MediaSourceTestRunner.MediaSourceListener

Artifact: androidx.media3:media3-test-utils

Kotlin |Java

public inner class MediaSourceTestRunner.MediaSourceListener implements MediaSource.MediaSourceCaller, MediaSourceEventListener

Summary

Public constructors
`MediaSourceListener()`

Public methods
`void`	`onDownstreamFormatChanged( int windowIndex, @Nullable MediaSource.MediaPeriodId mediaPeriodId, MediaLoadData mediaLoadData )` Called when a downstream format change occurs (i.e. when the format of the media being read from one or more `SampleStream`s provided by the source changes).
`void`	`onLoadCanceled( int windowIndex, @Nullable MediaSource.MediaPeriodId mediaPeriodId, LoadEventInfo loadEventInfo, MediaLoadData mediaLoadData )` Called when a load is canceled.
`void`	`onLoadCompleted( int windowIndex, @Nullable MediaSource.MediaPeriodId mediaPeriodId, LoadEventInfo loadEventInfo, MediaLoadData mediaLoadData )` Called when a load ends.
`void`	`onLoadError( int windowIndex, @Nullable MediaSource.MediaPeriodId mediaPeriodId, LoadEventInfo loadEventInfo, MediaLoadData mediaLoadData, IOException error, boolean wasCanceled )` Called when a load error occurs.
`void`	`onLoadStarted( int windowIndex, @Nullable MediaSource.MediaPeriodId mediaPeriodId, LoadEventInfo loadEventInfo, MediaLoadData mediaLoadData, int retryCount )` Called when a load begins.
`void`	`onSourceInfoRefreshed(MediaSource source, Timeline timeline)` Called when the `Timeline` has been refreshed.
`void`	`onUpstreamDiscarded( int windowIndex, @Nullable MediaSource.MediaPeriodId mediaPeriodId, MediaLoadData mediaLoadData )` Called when data is removed from the back of a media buffer, typically so that it can be re-buffered in a different format.

Public constructors

MediaSourceListener

public MediaSourceListener()

Public methods

onDownstreamFormatChanged

public void onDownstreamFormatChanged(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId,
    MediaLoadData mediaLoadData
)

Called when a downstream format change occurs (i.e. when the format of the media being read from one or more SampleStreams provided by the source changes).

Parameters
`int windowIndex`	The window index in the timeline of the media source this load belongs to.
`@Nullable MediaSource.MediaPeriodId mediaPeriodId`	The `MediaPeriodId` the media belongs to.
`MediaLoadData mediaLoadData`	The `MediaLoadData` defining the newly selected downstream data.

onLoadCanceled

public void onLoadCanceled(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId,
    LoadEventInfo loadEventInfo,
    MediaLoadData mediaLoadData
)

Called when a load is canceled.

Parameters
`int windowIndex`	The window index in the timeline of the media source this load belongs to.
`@Nullable MediaSource.MediaPeriodId mediaPeriodId`	The `MediaPeriodId` this load belongs to. Null if the load does not belong to a specific media period.
`LoadEventInfo loadEventInfo`	The `LoadEventInfo` corresponding to the event. The values of `elapsedRealtimeMs` and `bytesLoaded` are relative to the corresponding `onLoadStarted` event.
`MediaLoadData mediaLoadData`	The `MediaLoadData` defining the data being loaded.

onLoadCompleted

public void onLoadCompleted(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId,
    LoadEventInfo loadEventInfo,
    MediaLoadData mediaLoadData
)

Called when a load ends.

Parameters
`int windowIndex`	The window index in the timeline of the media source this load belongs to.
`@Nullable MediaSource.MediaPeriodId mediaPeriodId`	The `MediaPeriodId` this load belongs to. Null if the load does not belong to a specific media period.
`LoadEventInfo loadEventInfo`	The `LoadEventInfo` corresponding to the event. The values of `elapsedRealtimeMs` and `bytesLoaded` are relative to the corresponding `onLoadStarted` event.
`MediaLoadData mediaLoadData`	The `MediaLoadData` defining the data being loaded.

onLoadError

public void onLoadError(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId,
    LoadEventInfo loadEventInfo,
    MediaLoadData mediaLoadData,
    IOException error,
    boolean wasCanceled
)

Called when a load error occurs.

The error may or may not have resulted in the load being canceled, as indicated by the wasCanceled parameter. If the load was canceled, onLoadCanceled will not be called in addition to this method.

This method being called does not indicate that playback has failed, or that it will fail. The player may be able to recover from the error. Hence applications should not implement this method to display a user visible error or initiate an application level retry. onPlayerError is the appropriate place to implement such behavior. This method is called to provide the application with an opportunity to log the error if it wishes to do so.

Parameters
`int windowIndex`	The window index in the timeline of the media source this load belongs to.
`@Nullable MediaSource.MediaPeriodId mediaPeriodId`	The `MediaPeriodId` this load belongs to. Null if the load does not belong to a specific media period.
`LoadEventInfo loadEventInfo`	The `LoadEventInfo` corresponding to the event. The values of `elapsedRealtimeMs` and `bytesLoaded` are relative to the corresponding `onLoadStarted` event.
`MediaLoadData mediaLoadData`	The `MediaLoadData` defining the data being loaded.
`IOException error`	The load error.
`boolean wasCanceled`	Whether the load was canceled as a result of the error.

onLoadStarted

public void onLoadStarted(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId,
    LoadEventInfo loadEventInfo,
    MediaLoadData mediaLoadData,
    int retryCount
)

Called when a load begins.

Parameters
`int windowIndex`	The window index in the timeline of the media source this load belongs to.
`@Nullable MediaSource.MediaPeriodId mediaPeriodId`	The `MediaPeriodId` this load belongs to. Null if the load does not belong to a specific media period.
`LoadEventInfo loadEventInfo`	The `LoadEventInfo` corresponding to the event. The value of `uri` won't reflect potential redirection yet and `responseHeaders` will be empty.
`MediaLoadData mediaLoadData`	The `MediaLoadData` defining the data being loaded.
`int retryCount`	The number of failed attempts since this method was first called (this is zero for the first load attempt).

onSourceInfoRefreshed

public void onSourceInfoRefreshed(MediaSource source, Timeline timeline)

Called when the Timeline has been refreshed.

Called on the playback thread.

Parameters
`MediaSource source`	The `MediaSource` whose info has been refreshed.
`Timeline timeline`	The source's timeline.

onUpstreamDiscarded

public void onUpstreamDiscarded(
    int windowIndex,
    @Nullable MediaSource.MediaPeriodId mediaPeriodId,
    MediaLoadData mediaLoadData
)

Called when data is removed from the back of a media buffer, typically so that it can be re-buffered in a different format.

Parameters
`int windowIndex`	The window index in the timeline of the media source this load belongs to.
`@Nullable MediaSource.MediaPeriodId mediaPeriodId`	The `MediaPeriodId` the media belongs to.
`MediaLoadData mediaLoadData`	The `MediaLoadData` defining the media being discarded.