Class ConcatenatingMediaSource

  • All Implemented Interfaces:
    MediaSource

    @Deprecated
    public final class ConcatenatingMediaSource
    extends CompositeMediaSource<com.google.android.exoplayer2.source.ConcatenatingMediaSource.MediaSourceHolder>
    Deprecated.
    com.google.android.exoplayer2 is deprecated. Please migrate to androidx.media3 (which contains the same ExoPlayer code). See the migration guide for more details, including a script to help with the migration.
    Concatenates multiple MediaSources. The list of MediaSources can be modified during playback. It is valid for the same MediaSource instance to be present more than once in the concatenation. Access to this class is thread-safe.
    • Constructor Detail

      • ConcatenatingMediaSource

        public ConcatenatingMediaSource​(MediaSource... mediaSources)
        Deprecated.
        Parameters:
        mediaSources - The MediaSources to concatenate. It is valid for the same MediaSource instance to be present more than once in the array.
      • ConcatenatingMediaSource

        public ConcatenatingMediaSource​(boolean isAtomic,
                                        MediaSource... mediaSources)
        Deprecated.
        Parameters:
        isAtomic - Whether the concatenating media source will be treated as atomic, i.e., treated as a single item for repeating and shuffling.
        mediaSources - The MediaSources to concatenate. It is valid for the same MediaSource instance to be present more than once in the array.
      • ConcatenatingMediaSource

        public ConcatenatingMediaSource​(boolean isAtomic,
                                        ShuffleOrder shuffleOrder,
                                        MediaSource... mediaSources)
        Deprecated.
        Parameters:
        isAtomic - Whether the concatenating media source will be treated as atomic, i.e., treated as a single item for repeating and shuffling.
        shuffleOrder - The ShuffleOrder to use when shuffling the child media sources.
        mediaSources - The MediaSources to concatenate. It is valid for the same MediaSource instance to be present more than once in the array.
      • ConcatenatingMediaSource

        public ConcatenatingMediaSource​(boolean isAtomic,
                                        boolean useLazyPreparation,
                                        ShuffleOrder shuffleOrder,
                                        MediaSource... mediaSources)
        Deprecated.
        Parameters:
        isAtomic - Whether the concatenating media source will be treated as atomic, i.e., treated as a single item for repeating and shuffling.
        useLazyPreparation - Whether playlist items are prepared lazily. If false, all manifest loads and other initial preparation steps happen immediately. If true, these initial preparations are triggered only when the player starts buffering the media.
        shuffleOrder - The ShuffleOrder to use when shuffling the child media sources.
        mediaSources - The MediaSources to concatenate. It is valid for the same MediaSource instance to be present more than once in the array.
    • Method Detail

      • getInitialTimeline

        public Timeline getInitialTimeline()
        Deprecated.
        Description copied from interface: MediaSource
        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.

      • isSingleWindow

        public boolean isSingleWindow()
        Deprecated.
        Description copied from interface: MediaSource
        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.

        Returns:
        true if the source has exactly one window.
      • addMediaSource

        public void addMediaSource​(MediaSource mediaSource)
        Deprecated.
        Appends a MediaSource to the playlist.
        Parameters:
        mediaSource - The MediaSource to be added to the list.
      • addMediaSource

        public void addMediaSource​(MediaSource mediaSource,
                                   Handler handler,
                                   Runnable onCompletionAction)
        Deprecated.
        Appends a MediaSource to the playlist and executes a custom action on completion.
        Parameters:
        mediaSource - The MediaSource to be added to the list.
        handler - The Handler to run onCompletionAction.
        onCompletionAction - A Runnable which is executed immediately after the media source has been added to the playlist.
      • addMediaSource

        public void addMediaSource​(int index,
                                   MediaSource mediaSource)
        Deprecated.
        Adds a MediaSource to the playlist.
        Parameters:
        index - The index at which the new MediaSource will be inserted. This index must be in the range of 0 <= index <= getSize().
        mediaSource - The MediaSource to be added to the list.
      • addMediaSource

        public void addMediaSource​(int index,
                                   MediaSource mediaSource,
                                   Handler handler,
                                   Runnable onCompletionAction)
        Deprecated.
        Adds a MediaSource to the playlist and executes a custom action on completion.
        Parameters:
        index - The index at which the new MediaSource will be inserted. This index must be in the range of 0 <= index <= getSize().
        mediaSource - The MediaSource to be added to the list.
        handler - The Handler to run onCompletionAction.
        onCompletionAction - A Runnable which is executed immediately after the media source has been added to the playlist.
      • addMediaSources

        public void addMediaSources​(Collection<MediaSource> mediaSources)
        Deprecated.
        Appends multiple MediaSources to the playlist.
        Parameters:
        mediaSources - A collection of MediaSources to be added to the list. The media sources are added in the order in which they appear in this collection.
      • addMediaSources

        public void addMediaSources​(Collection<MediaSource> mediaSources,
                                    Handler handler,
                                    Runnable onCompletionAction)
        Deprecated.
        Appends multiple MediaSources to the playlist and executes a custom action on completion.
        Parameters:
        mediaSources - A collection of MediaSources to be added to the list. The media sources are added in the order in which they appear in this collection.
        handler - The Handler to run onCompletionAction.
        onCompletionAction - A Runnable which is executed immediately after the media sources have been added to the playlist.
      • addMediaSources

        public void addMediaSources​(int index,
                                    Collection<MediaSource> mediaSources)
        Deprecated.
        Adds multiple MediaSources to the playlist.
        Parameters:
        index - The index at which the new MediaSources will be inserted. This index must be in the range of 0 <= index <= getSize().
        mediaSources - A collection of MediaSources to be added to the list. The media sources are added in the order in which they appear in this collection.
      • addMediaSources

        public void addMediaSources​(int index,
                                    Collection<MediaSource> mediaSources,
                                    Handler handler,
                                    Runnable onCompletionAction)
        Deprecated.
        Adds multiple MediaSources to the playlist and executes a custom action on completion.
        Parameters:
        index - The index at which the new MediaSources will be inserted. This index must be in the range of 0 <= index <= getSize().
        mediaSources - A collection of MediaSources to be added to the list. The media sources are added in the order in which they appear in this collection.
        handler - The Handler to run onCompletionAction.
        onCompletionAction - A Runnable which is executed immediately after the media sources have been added to the playlist.
      • removeMediaSource

        public MediaSource removeMediaSource​(int index)
        Deprecated.
        Removes a MediaSource from the playlist.

        Note: If you want to move the instance, it's preferable to use moveMediaSource(int, int) instead.

        Note: If you want to remove a set of contiguous sources, it's preferable to use removeMediaSourceRange(int, int) instead.

        Parameters:
        index - The index at which the media source will be removed. This index must be in the range of 0 <= index < getSize().
        Returns:
        The removed MediaSource.
      • removeMediaSourceRange

        public void removeMediaSourceRange​(int fromIndex,
                                           int toIndex)
        Deprecated.
        Removes a range of MediaSources from the playlist, by specifying an initial index (included) and a final index (excluded).

        Note: when specified range is empty, no actual media source is removed and no exception is thrown.

        Parameters:
        fromIndex - The initial range index, pointing to the first media source that will be removed. This index must be in the range of 0 <= index <= getSize().
        toIndex - The final range index, pointing to the first media source that will be left untouched. This index must be in the range of 0 <= index <= getSize().
        Throws:
        IndexOutOfBoundsException - When the range is malformed, i.e. fromIndex < 0, toIndex > getSize(), fromIndex > toIndex
      • removeMediaSourceRange

        public void removeMediaSourceRange​(int fromIndex,
                                           int toIndex,
                                           Handler handler,
                                           Runnable onCompletionAction)
        Deprecated.
        Removes a range of MediaSources from the playlist, by specifying an initial index (included) and a final index (excluded), and executes a custom action on completion.

        Note: when specified range is empty, no actual media source is removed and no exception is thrown.

        Parameters:
        fromIndex - The initial range index, pointing to the first media source that will be removed. This index must be in the range of 0 <= index <= getSize().
        toIndex - The final range index, pointing to the first media source that will be left untouched. This index must be in the range of 0 <= index <= getSize().
        handler - The Handler to run onCompletionAction.
        onCompletionAction - A Runnable which is executed immediately after the media source range has been removed from the playlist.
        Throws:
        IllegalArgumentException - When the range is malformed, i.e. fromIndex < 0, toIndex > getSize(), fromIndex > toIndex
      • moveMediaSource

        public void moveMediaSource​(int currentIndex,
                                    int newIndex)
        Deprecated.
        Moves an existing MediaSource within the playlist.
        Parameters:
        currentIndex - The current index of the media source in the playlist. This index must be in the range of 0 <= index < getSize().
        newIndex - The target index of the media source in the playlist. This index must be in the range of 0 <= index < getSize().
      • moveMediaSource

        public void moveMediaSource​(int currentIndex,
                                    int newIndex,
                                    Handler handler,
                                    Runnable onCompletionAction)
        Deprecated.
        Moves an existing MediaSource within the playlist and executes a custom action on completion.
        Parameters:
        currentIndex - The current index of the media source in the playlist. This index must be in the range of 0 <= index < getSize().
        newIndex - The target index of the media source in the playlist. This index must be in the range of 0 <= index < getSize().
        handler - The Handler to run onCompletionAction.
        onCompletionAction - A Runnable which is executed immediately after the media source has been moved.
      • clear

        public void clear()
        Deprecated.
        Clears the playlist.
      • clear

        public void clear​(Handler handler,
                          Runnable onCompletionAction)
        Deprecated.
        Clears the playlist and executes a custom action on completion.
        Parameters:
        handler - The Handler to run onCompletionAction.
        onCompletionAction - A Runnable which is executed immediately after the playlist has been cleared.
      • getSize

        public int getSize()
        Deprecated.
        Returns the number of media sources in the playlist.
      • getMediaSource

        public MediaSource getMediaSource​(int index)
        Deprecated.
        Returns the MediaSource at a specified index.
        Parameters:
        index - An index in the range of 0 <= index <= getSize().
        Returns:
        The MediaSource at this index.
      • setShuffleOrder

        public void setShuffleOrder​(ShuffleOrder shuffleOrder)
        Deprecated.
        Sets a new shuffle order to use when shuffling the child media sources.
        Parameters:
        shuffleOrder - A ShuffleOrder.
      • setShuffleOrder

        public void setShuffleOrder​(ShuffleOrder shuffleOrder,
                                    Handler handler,
                                    Runnable onCompletionAction)
        Deprecated.
        Sets a new shuffle order to use when shuffling the child media sources.
        Parameters:
        shuffleOrder - A ShuffleOrder.
        handler - The Handler to run onCompletionAction.
        onCompletionAction - A Runnable which is executed immediately after the shuffle order has been changed.
      • getMediaItem

        public MediaItem getMediaItem()
        Deprecated.
        Description copied from interface: MediaSource
        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.

      • createPeriod

        public MediaPeriod createPeriod​(MediaSource.MediaPeriodId id,
                                        Allocator allocator,
                                        long startPositionUs)
        Deprecated.
        Description copied from interface: MediaSource
        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:
        id - The identifier of the period.
        allocator - An Allocator from which to obtain media buffer allocations.
        startPositionUs - The expected start position, in microseconds.
        Returns:
        A new MediaPeriod.
      • releasePeriod

        public void releasePeriod​(MediaPeriod mediaPeriod)
        Deprecated.
        Description copied from interface: MediaSource
        Releases the period.

        Should not be called directly from application code.

        This method must be called on the playback thread.

        Parameters:
        mediaPeriod - The period to release.
      • onChildSourceInfoRefreshed

        protected void onChildSourceInfoRefreshed​(com.google.android.exoplayer2.source.ConcatenatingMediaSource.MediaSourceHolder mediaSourceHolder,
                                                  MediaSource mediaSource,
                                                  Timeline timeline)
        Deprecated.
        Called when the source info of a child source has been refreshed.
        Specified by:
        onChildSourceInfoRefreshed in class CompositeMediaSource<com.google.android.exoplayer2.source.ConcatenatingMediaSource.MediaSourceHolder>
        Parameters:
        mediaSourceHolder - The unique id used to prepare the child source.
        mediaSource - The child source whose source info has been refreshed.
        timeline - The timeline of the child source.
      • getWindowIndexForChildWindowIndex

        protected int getWindowIndexForChildWindowIndex​(com.google.android.exoplayer2.source.ConcatenatingMediaSource.MediaSourceHolder mediaSourceHolder,
                                                        int windowIndex)
        Deprecated.
        Returns the window index in the composite source corresponding to the specified window index in a child source. The default implementation does not change the window index.
        Overrides:
        getWindowIndexForChildWindowIndex in class CompositeMediaSource<com.google.android.exoplayer2.source.ConcatenatingMediaSource.MediaSourceHolder>
        Parameters:
        mediaSourceHolder - The unique id used to prepare the child source.
        windowIndex - A window index of the child source.
        Returns:
        The corresponding window index in the composite source.