FakeMediaSource

public static final MediaItem FAKE_MEDIA_ITEM

The media item used by the fake media source.

public FakeMediaSource()

Creates a FakeMediaSource with a default FakeTimeline.

Use Builder to create a more configured instance.

public FakeMediaSource(@Nullable Timeline timeline, Format[] formats)

Creates a FakeMediaSource. This media source creates FakeMediaPeriods with a TrackGroupArray using the given Formats. The provided Timeline may be null to prevent an immediate source info refresh message when preparing the media source. It can be manually set later using setNewSourceInfo.

Use Builder to create a more configured instance.

protected FakeMediaSource(
    @Nullable Timeline timeline,
    DrmSessionManager drmSessionManager,
    @Nullable FakeMediaPeriod.TrackDataFactory trackDataFactory,
    @Nullable long[] syncSampleTimesUs,
    TrackGroupArray trackGroupArray
)

Creates a FakeMediaSource. This media source creates FakeMediaPeriods with the provided TrackGroupArray, DrmSessionManager, FakeMediaPeriod.TrackDataFactory, and syncSampleTimesUs. The provided Timeline may be null to prevent an immediate source info refresh message when preparing the media source. It can be manually set later using setNewSourceInfo.

public void assertMediaPeriodCreated(MediaSource.MediaPeriodId mediaPeriodId)

Assert that a media period for the given id has been created.

public void assertReleased()

Assert that the source and all periods have been released.

public boolean canUpdateMediaItem(MediaItem mediaItem)

Returns whether the MediaItem for this source can be updated with the provided item.

Should not be called directly from application code.

This method must be called on the application thread.

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

Returns a new MediaPeriod identified by periodId.

Should not be called directly from application code.

This method must be called on the playback thread and only if the source is enabled.

public static FakeMediaSource createWithWindowId(Object windowId)

Convenience method to create a FakeMediaSource with the given window id.

public List<MediaSource.MediaPeriodId> getCreatedMediaPeriods()

Returns a list of MediaPeriodIds, with one element for each created media period.

public @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.

Should not be called directly from application code.

The initial timeline must use the same uids for windows and periods that the real timeline will use. It also must provide windows which are marked as dynamic to indicate that the window is expected to change when the real timeline arrives.

Any media source which has multiple windows should typically provide such an initial timeline to make sure the player reports the correct number of windows immediately.

This method must be called on the application thread.

public MediaPeriod getLastCreatedActiveMediaPeriod()

Returns the last created active MediaPeriod.

Must only be called if the source has created at least one period and it hasn't been released.

public MediaItem getMediaItem()

Returns the MediaItem whose media is provided by the source.

Should not be called directly from application code.

This method must be called on the application thread.

public boolean isPrepared()

Returns whether the source is currently prepared.

public boolean isSingleWindow()

Returns true if the media source is guaranteed to never have zero or more than one window.

Should not be called directly from application code.

The default implementation returns true.

This method must be called on the application thread.

public void maybeThrowSourceInfoRefreshError()

Throws any pending error encountered while loading or refreshing source information.

Should not be called directly from application code.

This method must be called on the playback thread and only after prepareSource.

synchronized public void prepareSourceInternal(@Nullable TransferListener mediaTransferListener)

Starts source preparation and enables the source, see prepareSource. This method is called at most once until the next call to releaseSourceInternal.

This method is called on the playback thread.

public void releasePeriod(MediaPeriod mediaPeriod)

Releases the period.

Should not be called directly from application code.

This method must be called on the playback thread.

synchronized public void setAllowPreparation(boolean allowPreparation)

Sets whether the next call to prepareSource is allowed to finish. If not allowed, a later call to this method with allowPreparation set to true will finish the preparation.

public void setCanUpdateMediaItems(boolean canUpdateMediaItems)

Sets whether the source allows to update its MediaItem via updateMediaItem.

public void setNewSourceInfo(Timeline newTimeline)

Sets a new timeline. If the source is already prepared, this triggers a source info refresh message being sent to the listener.

synchronized public void setNewSourceInfo(Timeline newTimeline, boolean sendManifestLoadEvents)

Sets a new timeline. If the source is already prepared, this triggers a source info refresh message being sent to the listener.

Must only be called if preparation is allowed.

public void setPeriodDefersOnPreparedCallback(
    boolean periodDefersOnPreparedCallback
)

Sets whether the created period should defer to call onPrepared. If set to true, onPrepared should be called only after setPreparationComplete has been called, otherwise the preparation completes immediately.

public void updateMediaItem(MediaItem mediaItem)

Updates the MediaItem for this source.

Should not be called directly from application code.

This method must be called on the playback thread and only if canUpdateMediaItem returns true for the new MediaItem.

@RequiresNonNull(value = "this.timeline")
protected MediaPeriod createMediaPeriod(
    MediaSource.MediaPeriodId id,
    TrackGroupArray trackGroupArray,
    Allocator allocator,
    MediaSourceEventListener.EventDispatcher mediaSourceEventDispatcher,
    DrmSessionManager drmSessionManager,
    DrmSessionEventListener.EventDispatcher drmEventDispatcher,
    @Nullable TransferListener transferListener
)

Creates a MediaPeriod for this media source.

protected void releaseMediaPeriod(MediaPeriod mediaPeriod)

Releases a media period created by createMediaPeriod.

protected void releaseSourceInternal()

Releases the source, see releaseSource. This method is called exactly once after each call to prepareSourceInternal.

This method is called on the playback thread.