AdsLoader

@UnstableApi
default boolean handleContentTimelineChanged(
    AdsMediaSource adsMediaSource,
    Timeline timeline
)

Notifies the ads loader when the content source has changed its timeline. Called on the main thread by AdsMediaSource.

The default implementation returns false which makes the content timeline immediately being reported to the player.

When overriding this method for the purpose of reading ad data from the timeline to populate the AdPlaybackState with, false needs to be passed to the constructor of AdsMediaSource to indicate that the content source needs to be prepared upfront. This way an ads loader can defer calling onAdPlaybackState until the ad data from the timeline is available and populate the initial ad playback state with that data before publishing.

For live streams, this method is called additional times when the content source reports an advancing live window with new available media and/or new ad data in the manifest. If in such a case, the ads loader as a result calls onAdPlaybackState, true must be returned. This prevents the timeline being reported with stale ad data. Conversely, when the ad playback state is not passed into onAdPlaybackState, false must be returned to not drop a timeline update that needs to be published to the player.

Generally, if the timeline is not required to populate the ad playback state, start should be used to initiate loading ad data and publish the first ad playback state as early as possible. This method can still be overridden for informational or other purpose. In this case, false is returned here and the AdsMediaSource is used with lazy preparation enabled.

@UnstableApi
abstract void handlePrepareComplete(
    AdsMediaSource adsMediaSource,
    int adGroupIndex,
    int adIndexInAdGroup
)

Notifies the ads loader that preparation of an ad media period is complete. Called on the main thread by AdsMediaSource.

@UnstableApi
abstract void handlePrepareError(
    AdsMediaSource adsMediaSource,
    int adGroupIndex,
    int adIndexInAdGroup,
    IOException exception
)

Notifies the ads loader that the player was not able to prepare media for a given ad. Implementations should update the ad playback state as the specified ad has failed to load. Called on the main thread by AdsMediaSource.

abstract void release()

Releases the loader. Must be called by the application on the main thread when the instance is no longer needed.

abstract void setPlayer(@Nullable Player player)

Sets the player that will play the loaded ads.

This method must be called before the player is prepared with media using this ads loader.

This method must also be called on the main thread and only players which are accessed on the main thread are supported (player.getApplicationLooper() == Looper.getMainLooper()).

@UnstableApi
abstract void setSupportedContentTypes(@C.ContentType int[] contentTypes)

Sets the supported content types for ad media. Must be called before the first call to start. Subsequent calls may be ignored. Called on the main thread by AdsMediaSource.

@UnstableApi
abstract void start(
    AdsMediaSource adsMediaSource,
    DataSpec adTagDataSpec,
    Object adsId,
    AdViewProvider adViewProvider,
    AdsLoader.EventListener eventListener
)

Starts using the ads loader for playback. Called on the main thread by AdsMediaSource.

Requests the ads loader to start loading ad data from the provided adTagDataSpec. Publishing an initial AdPlaybackState to provided eventListener is required to start playback. In the case of a pre roll, this ensures that the player doesn't briefly start playing content before ad data is available.

@UnstableApi
abstract void stop(
    AdsMediaSource adsMediaSource,
    AdsLoader.EventListener eventListener
)

Stops using the ads loader for playback and deregisters the event listener. Called on the main thread by AdsMediaSource.