FakeMediaSource

const val FAKE_MEDIA_ITEM: MediaItem!

The media item used by the fake media source.

FakeMediaSource()

Creates a FakeMediaSource with a default FakeTimeline.

Use Builder to create a more configured instance.

FakeMediaSource(timeline: Timeline?, formats: Array<Format!>!)

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(
    timeline: Timeline?,
    drmSessionManager: DrmSessionManager!,
    trackDataFactory: FakeMediaPeriod.TrackDataFactory?,
    syncSampleTimesUs: LongArray?,
    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.

fun assertMediaPeriodCreated(mediaPeriodId: MediaSource.MediaPeriodId!): Unit

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

fun assertReleased(): Unit

Assert that the source and all periods have been released.

fun canUpdateMediaItem(mediaItem: MediaItem!): Boolean

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.

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

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.

java-static fun createWithWindowId(windowId: Any!): FakeMediaSource!

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

fun getCreatedMediaPeriods(): (Mutable)List<MediaSource.MediaPeriodId!>!

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

fun getInitialTimeline(): Timeline?

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.

fun getLastCreatedActiveMediaPeriod(): MediaPeriod!

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.

fun getMediaItem(): MediaItem!

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.

fun isPrepared(): Boolean

Returns whether the source is currently prepared.

fun isSingleWindow(): Boolean

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.

fun maybeThrowSourceInfoRefreshError(): Unit

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 fun prepareSourceInternal(mediaTransferListener: TransferListener?): Unit

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.

fun releasePeriod(mediaPeriod: MediaPeriod!): Unit

Releases the period.

Should not be called directly from application code.

This method must be called on the playback thread.

synchronized fun setAllowPreparation(allowPreparation: Boolean): Unit

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.

fun setCanUpdateMediaItems(canUpdateMediaItems: Boolean): Unit

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

fun setNewSourceInfo(newTimeline: Timeline!): Unit

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

synchronized fun setNewSourceInfo(newTimeline: Timeline!, sendManifestLoadEvents: Boolean): Unit

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.

fun setPeriodDefersOnPreparedCallback(
    periodDefersOnPreparedCallback: Boolean
): Unit

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.

fun updateMediaItem(mediaItem: MediaItem!): Unit

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 fun createMediaPeriod(
    id: MediaSource.MediaPeriodId!,
    trackGroupArray: TrackGroupArray!,
    allocator: Allocator!,
    mediaSourceEventDispatcher: MediaSourceEventListener.EventDispatcher!,
    drmSessionManager: DrmSessionManager!,
    drmEventDispatcher: DrmSessionEventListener.EventDispatcher!,
    transferListener: TransferListener?
): MediaPeriod!

Creates a MediaPeriod for this media source.

protected fun releaseMediaPeriod(mediaPeriod: MediaPeriod!): Unit

Releases a media period created by createMediaPeriod.

protected fun releaseSourceInternal(): Unit

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

This method is called on the playback thread.