Interface AdsLoader

    • Method Detail

      • setPlayer

        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()).

        Parameters:
        player - The player instance that will play the loaded ads. May be null to delete the reference to a previously set player.
      • release

        void release()
        Releases the loader. Must be called by the application on the main thread when the instance is no longer needed.
      • start

        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.
        Parameters:
        adsMediaSource - The ads media source requesting to start loading ads.
        adTagDataSpec - A data spec for the ad tag to load.
        adsId - An opaque identifier for the ad playback state across start/stop calls.
        adViewProvider - Provider of views for the ad UI.
        eventListener - Listener for ads loader events.
      • stop

        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.
        Parameters:
        adsMediaSource - The ads media source requesting to stop loading/playing ads.
        eventListener - The ads media source's listener for ads loader events.
      • handlePrepareComplete

        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.
        Parameters:
        adsMediaSource - The ads media source for which preparation of ad media completed.
        adGroupIndex - The index of the ad group.
        adIndexInAdGroup - The index of the ad in the ad group.
      • handlePrepareError

        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.
        Parameters:
        adsMediaSource - The ads media source for which preparation of ad media failed.
        adGroupIndex - The index of the ad group.
        adIndexInAdGroup - The index of the ad in the ad group.
        exception - The preparation error.