ImaServerSideAdInsertionMediaSource

Artifact: androidx.media3:media3-exoplayer-ima

Kotlin |Java

public final class ImaServerSideAdInsertionMediaSource extends CompositeMediaSource

java.lang.Object
↳	androidx.media3.exoplayer.source.BaseMediaSource
	↳	androidx.media3.exoplayer.source.CompositeMediaSource
		↳	androidx.media3.exoplayer.ima.ImaServerSideAdInsertionMediaSource

MediaSource for IMA server side inserted ad streams.

Summary

Nested types
`public final class ImaServerSideAdInsertionMediaSource.AdsLoader` An ads loader for IMA server side ad insertion streams.
`public final class ImaServerSideAdInsertionMediaSource.AdsLoader.Builder` Builder for building an `AdsLoader`.
`public class ImaServerSideAdInsertionMediaSource.AdsLoader.State` The state of the `AdsLoader` that can be used when resuming from the background.
`public final class ImaServerSideAdInsertionMediaSource.Factory implements MediaSource.Factory` Factory for creating `ImaServerSideAdInsertionMediaSources`.
`@UnstableApi public interface ImaServerSideAdInsertionMediaSource.StreamEventListener` A listener to be notified of stream events.

Public fields
`MediaItem`	`@GuardedBy(value = "this") mediaItem`

Public methods
`boolean`	`@UnstableApi canUpdateMediaItem(MediaItem mediaItem)` Returns whether the `MediaItem` for this source can be updated with the provided item.
`MediaPeriod`	`@UnstableApi createPeriod( MediaSource.MediaPeriodId id, Allocator allocator, long startPositionUs )` Returns a new `MediaPeriod` identified by `periodId`.
`synchronized MediaItem`	`@UnstableApi getMediaItem()` Returns the `MediaItem` whose media is provided by the source.
`void`	`@UnstableApi maybeThrowSourceInfoRefreshError()` Throws any pending error encountered while loading or refreshing source information.
`void`	`@UnstableApi prepareSourceInternal(@Nullable TransferListener mediaTransferListener)` Starts source preparation and enables the source, see `prepareSource`.
`void`	`@UnstableApi releasePeriod(MediaPeriod mediaPeriod)` Releases the period.
`synchronized void`	`@UnstableApi updateMediaItem(MediaItem mediaItem)` Updates the `MediaItem` for this source.

Protected methods
`void`	`@UnstableApi onChildSourceInfoRefreshed( Void childSourceId, MediaSource mediaSource, Timeline newTimeline )` Called when the source info of a child source has been refreshed.
`void`	`@UnstableApi releaseSourceInternal()` Releases the source, see `releaseSource`.

Inherited fields

From androidx.media3.exoplayer.source.BaseMediaSource

@Nullable PlayerId

playerId

Inherited methods

From androidx.media3.exoplayer.source.BaseMediaSource

`final void`	`@UnstableApi 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`	`@UnstableApi 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`	`@UnstableApi disable(MediaSource.MediaSourceCaller caller)` Disables the source for the creation of `MediaPeriods`.
`final void`	`@UnstableApi 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`	`@UnstableApi prepareSource( MediaSource.MediaSourceCaller caller, @Nullable TransferListener mediaTransferListener )` This method is deprecated. Implement `prepareSource` instead.
`final void`	`@UnstableApi 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`	`@UnstableApi releaseSource(MediaSource.MediaSourceCaller caller)` Unregisters a caller, and disables and releases the source if no longer required.
`final void`	`@UnstableApi removeDrmEventListener(DrmSessionEventListener eventListener)` Removes a `DrmSessionEventListener` from the list of listeners which are notified of DRM events for this media source.
`final void`	`@UnstableApi 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.
`final void`	`prepareChildSource(@UnknownNull T id, MediaSource mediaSource)` Prepares a child source.
`final void`	`releaseChildSource(@UnknownNull T id)` Releases a child source.

From androidx.media3.exoplayer.source.MediaSource

`@Nullable Timeline`	`@UnstableApi 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.
`boolean`	`@UnstableApi isSingleWindow()` Returns true if the media source is guaranteed to never have zero or more than one window.

Public fields

mediaItem

@GuardedBy(value = "this")
public MediaItem mediaItem

Public methods

canUpdateMediaItem

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

Parameters
`MediaItem mediaItem`	The new `MediaItem`.

Returns
`boolean`	Whether the source can be updated using this item.

createPeriod

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

Parameters
`MediaSource.MediaPeriodId id`	The identifier of the period.
`Allocator allocator`	An `Allocator` from which to obtain media buffer allocations.
`long startPositionUs`	The expected start position, in microseconds.

Returns
`MediaPeriod`	A new `MediaPeriod`.

getMediaItem

@UnstableApi
synchronized 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.

maybeThrowSourceInfoRefreshError

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

Throws
`java.io.IOException`

prepareSourceInternal

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

Parameters
`@Nullable TransferListener mediaTransferListener`	The transfer listener which should be informed of any media data transfers. May be null if no listener is available. Note that this listener should usually be only informed of transfers related to the media loads and not of auxiliary loads for manifests and other data.

releasePeriod

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

Parameters
`MediaPeriod mediaPeriod`	The period to release.

updateMediaItem

@UnstableApi
synchronized 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.

Parameters
`MediaItem mediaItem`	The new `MediaItem`.

Protected methods

onChildSourceInfoRefreshed

@UnstableApi
protected void onChildSourceInfoRefreshed(
    Void childSourceId,
    MediaSource mediaSource,
    Timeline newTimeline
)

Called when the source info of a child source has been refreshed.

Parameters
`Void childSourceId`	The unique id used to prepare the child source.
`MediaSource mediaSource`	The child source whose source info has been refreshed.
`Timeline newTimeline`	The timeline of the child source.

releaseSourceInternal

@UnstableApi
protected void releaseSourceInternal()

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

ImaServerSideAdInsertionMediaSource

Summary

Nested types

Public fields

Public methods

Protected methods

Inherited fields

Inherited methods

Public fields

mediaItem

Public methods

canUpdateMediaItem

createPeriod

getMediaItem

maybeThrowSourceInfoRefreshError

prepareSourceInternal

releasePeriod

updateMediaItem

Protected methods

onChildSourceInfoRefreshed

releaseSourceInternal