com.google.android.exoplayer2.source

Class ConcatenatingMediaSource

java.lang.Object

com.google.android.exoplayer2.source.BaseMediaSource

com.google.android.exoplayer2.source.CompositeMediaSource<com.google.android.exoplayer2.source.ConcatenatingMediaSource.MediaSourceHolder>

com.google.android.exoplayer2.source.ConcatenatingMediaSource

All Implemented Interfaces:

PlayerMessage.Target, MediaSource

Direct Known Subclasses:

DynamicConcatenatingMediaSource

public class ConcatenatingMediaSource
extends CompositeMediaSource<com.google.android.exoplayer2.source.ConcatenatingMediaSource.MediaSourceHolder>
implements PlayerMessage.Target

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.

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.android.exoplayer2.source.MediaSource

MediaSource.MediaPeriodId, MediaSource.SourceInfoRefreshListener

Constructor Summary

Constructors

Constructor and Description
ConcatenatingMediaSource(boolean isAtomic, boolean useLazyPreparation, ShuffleOrder shuffleOrder, MediaSource... mediaSources)
ConcatenatingMediaSource(boolean isAtomic, MediaSource... mediaSources)
ConcatenatingMediaSource(boolean isAtomic, ShuffleOrder shuffleOrder, MediaSource... mediaSources)
ConcatenatingMediaSource(MediaSource... mediaSources)

Method Summary

Modifier and Type	Method and Description
void	addMediaSource(int index, MediaSource mediaSource) Adds a MediaSource to the playlist.
void	addMediaSource(int index, MediaSource mediaSource, java.lang.Runnable actionOnCompletion) Adds a MediaSource to the playlist and executes a custom action on completion.
void	addMediaSource(MediaSource mediaSource) Appends a MediaSource to the playlist.
void	addMediaSource(MediaSource mediaSource, java.lang.Runnable actionOnCompletion) Appends a MediaSource to the playlist and executes a custom action on completion.
void	addMediaSources(java.util.Collection<MediaSource> mediaSources) Appends multiple MediaSources to the playlist.
void	addMediaSources(java.util.Collection<MediaSource> mediaSources, java.lang.Runnable actionOnCompletion) Appends multiple MediaSources to the playlist and executes a custom action on completion.
void	addMediaSources(int index, java.util.Collection<MediaSource> mediaSources) Adds multiple MediaSources to the playlist.
void	addMediaSources(int index, java.util.Collection<MediaSource> mediaSources, java.lang.Runnable actionOnCompletion) Adds multiple MediaSources to the playlist and executes a custom action on completion.
void	clear() Clears the playlist.
void	clear(java.lang.Runnable actionOnCompletion) Clears the playlist and executes a custom action on completion.
MediaPeriod	createPeriod(MediaSource.MediaPeriodId id, Allocator allocator) Returns a new MediaPeriod identified by periodId.
protected MediaSource.MediaPeriodId	getMediaPeriodIdForChildMediaPeriodId(com.google.android.exoplayer2.source.ConcatenatingMediaSource.MediaSourceHolder mediaSourceHolder, MediaSource.MediaPeriodId mediaPeriodId) Returns the MediaPeriodId in the composite source corresponding to the specified MediaPeriodId in a child source.
MediaSource	getMediaSource(int index) Returns the MediaSource at a specified index.
int	getSize() Returns the number of media sources in the playlist.
protected int	getWindowIndexForChildWindowIndex(com.google.android.exoplayer2.source.ConcatenatingMediaSource.MediaSourceHolder mediaSourceHolder, int windowIndex) Returns the window index in the composite source corresponding to the specified window index in a child source.
void	handleMessage(int messageType, java.lang.Object message) Handles a message delivered to the target.
void	maybeThrowSourceInfoRefreshError() Throws any pending error encountered while loading or refreshing source information.
void	moveMediaSource(int currentIndex, int newIndex) Moves an existing MediaSource within the playlist.
void	moveMediaSource(int currentIndex, int newIndex, java.lang.Runnable actionOnCompletion) Moves an existing MediaSource within the playlist and executes a custom action on completion.
protected void	onChildSourceInfoRefreshed(com.google.android.exoplayer2.source.ConcatenatingMediaSource.MediaSourceHolder mediaSourceHolder, MediaSource mediaSource, Timeline timeline, java.lang.Object manifest) Called when the source info of a child source has been refreshed.
void	prepareSourceInternal(ExoPlayer player, boolean isTopLevelSource, TransferListener mediaTransferListener) Starts source preparation.
void	releasePeriod(MediaPeriod mediaPeriod) Releases the period.
void	releaseSourceInternal() Releases the source.
void	removeMediaSource(int index) Removes a MediaSource from the playlist.
void	removeMediaSource(int index, java.lang.Runnable actionOnCompletion) Removes a MediaSource from the playlist and executes a custom action on completion.
void	removeMediaSourceRange(int fromIndex, int toIndex) Removes a range of MediaSources from the playlist, by specifying an initial index (included) and a final index (excluded).
void	removeMediaSourceRange(int fromIndex, int toIndex, java.lang.Runnable actionOnCompletion) 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.
void	setShuffleOrder(ShuffleOrder shuffleOrder) Sets a new shuffle order to use when shuffling the child media sources.
void	setShuffleOrder(ShuffleOrder shuffleOrder, java.lang.Runnable actionOnCompletion) Sets a new shuffle order to use when shuffling the child media sources.

Methods inherited from class com.google.android.exoplayer2.source.CompositeMediaSource

getMediaTimeForChildMediaTime, prepareChildSource, releaseChildSource

Methods inherited from class com.google.android.exoplayer2.source.BaseMediaSource

addEventListener, createEventDispatcher, createEventDispatcher, createEventDispatcher, prepareSource, prepareSource, refreshSourceInfo, releaseSource, removeEventListener

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConcatenatingMediaSource

public ConcatenatingMediaSource(MediaSource... mediaSources)

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)

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)

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)

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

addMediaSource

public final void addMediaSource(MediaSource mediaSource)

Appends a MediaSource to the playlist.

Parameters:

mediaSource - The MediaSource to be added to the list.

addMediaSource

public final void addMediaSource(MediaSource mediaSource,
                                 @Nullable
                                 java.lang.Runnable actionOnCompletion)

Appends a MediaSource to the playlist and executes a custom action on completion.

Parameters:

mediaSource - The MediaSource to be added to the list.

actionOnCompletion - A Runnable which is executed immediately after the media source has been added to the playlist.

addMediaSource

public final void addMediaSource(int index,
                                 MediaSource mediaSource)

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 final void addMediaSource(int index,
                                 MediaSource mediaSource,
                                 @Nullable
                                 java.lang.Runnable actionOnCompletion)

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.

actionOnCompletion - A Runnable which is executed immediately after the media source has been added to the playlist.

addMediaSources

public final void addMediaSources(java.util.Collection<MediaSource> mediaSources)

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 final void addMediaSources(java.util.Collection<MediaSource> mediaSources,
                                  @Nullable
                                  java.lang.Runnable actionOnCompletion)

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.

actionOnCompletion - A Runnable which is executed immediately after the media sources have been added to the playlist.

addMediaSources

public final void addMediaSources(int index,
                                  java.util.Collection<MediaSource> mediaSources)

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 final void addMediaSources(int index,
                                  java.util.Collection<MediaSource> mediaSources,
                                  @Nullable
                                  java.lang.Runnable actionOnCompletion)

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.

actionOnCompletion - A Runnable which is executed immediately after the media sources have been added to the playlist.

removeMediaSource

public final void removeMediaSource(int index)

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

removeMediaSource

public final void removeMediaSource(int index,
                                    @Nullable
                                    java.lang.Runnable actionOnCompletion)

Removes a MediaSource from the playlist and executes a custom action on completion.

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

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

Parameters:

index - The index at which the media source will be removed. This index must be in the range of 0 <= index < getSize().

actionOnCompletion - A Runnable which is executed immediately after the media source has been removed from the playlist.

removeMediaSourceRange

public final void removeMediaSourceRange(int fromIndex,
                                         int toIndex)

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:

java.lang.IndexOutOfBoundsException - When the range is malformed, i.e. fromIndex < 0, toIndex > getSize(), fromIndex > toIndex

removeMediaSourceRange

public final void removeMediaSourceRange(int fromIndex,
                                         int toIndex,
                                         @Nullable
                                         java.lang.Runnable actionOnCompletion)

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

actionOnCompletion - A Runnable which is executed immediately after the media source range has been removed from the playlist.

Throws:

java.lang.IllegalArgumentException - When the range is malformed, i.e. fromIndex < 0, toIndex > getSize(), fromIndex > toIndex

moveMediaSource

public final void moveMediaSource(int currentIndex,
                                  int newIndex)

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 final void moveMediaSource(int currentIndex,
                                  int newIndex,
                                  @Nullable
                                  java.lang.Runnable actionOnCompletion)

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

actionOnCompletion - A Runnable which is executed immediately after the media source has been moved.

clear

public final void clear()

Clears the playlist.

clear

public final void clear(@Nullable
                        java.lang.Runnable actionOnCompletion)

Clears the playlist and executes a custom action on completion.

Parameters:

actionOnCompletion - A Runnable which is executed immediately after the playlist has been cleared.

getSize

public final int getSize()

Returns the number of media sources in the playlist.

getMediaSource

public final MediaSource getMediaSource(int index)

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 final void setShuffleOrder(ShuffleOrder shuffleOrder)

Sets a new shuffle order to use when shuffling the child media sources.

Parameters:

shuffleOrder - A ShuffleOrder.

setShuffleOrder

public final void setShuffleOrder(ShuffleOrder shuffleOrder,
                                  @Nullable
                                  java.lang.Runnable actionOnCompletion)

Sets a new shuffle order to use when shuffling the child media sources.

Parameters:

shuffleOrder - A ShuffleOrder.

actionOnCompletion - A Runnable which is executed immediately after the shuffle order has been changed.

prepareSourceInternal

public final void prepareSourceInternal(ExoPlayer player,
                                        boolean isTopLevelSource,
                                        @Nullable
                                        TransferListener mediaTransferListener)

Description copied from class: BaseMediaSource

Starts source preparation. This method is called at most once until the next call to BaseMediaSource.releaseSourceInternal().

Overrides:

prepareSourceInternal in class CompositeMediaSource<com.google.android.exoplayer2.source.ConcatenatingMediaSource.MediaSourceHolder>

Parameters:

player - The player for which this source is being prepared.

isTopLevelSource - Whether this source has been passed directly to ExoPlayer.prepare(MediaSource) or ExoPlayer.prepare(MediaSource, boolean, boolean).

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.

maybeThrowSourceInfoRefreshError

public void maybeThrowSourceInfoRefreshError()
                                      throws java.io.IOException

Description copied from interface: MediaSource

Throws any pending error encountered while loading or refreshing source information.

Should not be called directly from application code.

Specified by:

maybeThrowSourceInfoRefreshError in interface MediaSource

Overrides:

maybeThrowSourceInfoRefreshError in class CompositeMediaSource<com.google.android.exoplayer2.source.ConcatenatingMediaSource.MediaSourceHolder>

Throws:

java.io.IOException

createPeriod

public final MediaPeriod createPeriod(MediaSource.MediaPeriodId id,
                                      Allocator allocator)

Description copied from interface: MediaSource

Returns a new MediaPeriod identified by periodId. This method may be called multiple times without an intervening call to MediaSource.releasePeriod(MediaPeriod).

Should not be called directly from application code.

Specified by:

createPeriod in interface MediaSource

Parameters:

id - The identifier of the period.

allocator - An Allocator from which to obtain media buffer allocations.

Returns:

A new MediaPeriod.

releasePeriod

public final void releasePeriod(MediaPeriod mediaPeriod)

Description copied from interface: MediaSource

Releases the period.

Should not be called directly from application code.

Specified by:

releasePeriod in interface MediaSource

Parameters:

mediaPeriod - The period to release.

releaseSourceInternal

public final void releaseSourceInternal()

Description copied from class: BaseMediaSource

Releases the source. This method is called exactly once after each call to BaseMediaSource.prepareSourceInternal(ExoPlayer, boolean, TransferListener).

Overrides:

releaseSourceInternal in class CompositeMediaSource<com.google.android.exoplayer2.source.ConcatenatingMediaSource.MediaSourceHolder>

onChildSourceInfoRefreshed

protected final void onChildSourceInfoRefreshed(com.google.android.exoplayer2.source.ConcatenatingMediaSource.MediaSourceHolder mediaSourceHolder,
                                                MediaSource mediaSource,
                                                Timeline timeline,
                                                @Nullable
                                                java.lang.Object manifest)

Description copied from class: CompositeMediaSource

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.

manifest - The manifest of the child source.

getMediaPeriodIdForChildMediaPeriodId

@Nullable
protected MediaSource.MediaPeriodId getMediaPeriodIdForChildMediaPeriodId(com.google.android.exoplayer2.source.ConcatenatingMediaSource.MediaSourceHolder mediaSourceHolder,
                                                                                    MediaSource.MediaPeriodId mediaPeriodId)

Description copied from class: CompositeMediaSource

Returns the MediaPeriodId in the composite source corresponding to the specified MediaPeriodId in a child source. The default implementation does not change the media period id.

Overrides:

getMediaPeriodIdForChildMediaPeriodId in class CompositeMediaSource<com.google.android.exoplayer2.source.ConcatenatingMediaSource.MediaSourceHolder>

Parameters:

mediaSourceHolder - The unique id used to prepare the child source.

mediaPeriodId - A MediaPeriodId of the child source.

Returns:

The corresponding MediaPeriodId in the composite source. Null if no corresponding media period id can be determined.

getWindowIndexForChildWindowIndex

protected int getWindowIndexForChildWindowIndex(com.google.android.exoplayer2.source.ConcatenatingMediaSource.MediaSourceHolder mediaSourceHolder,
                                                int windowIndex)

Description copied from class: CompositeMediaSource

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.

handleMessage

public final void handleMessage(int messageType,
                                @Nullable
                                java.lang.Object message)
                         throws ExoPlaybackException

Description copied from interface: PlayerMessage.Target

Handles a message delivered to the target.

Specified by:

handleMessage in interface PlayerMessage.Target

Parameters:

messageType - The message type.

message - The message payload.

Throws:

ExoPlaybackException - If an error occurred whilst handling the message. Should only be thrown by targets that handle messages on the playback thread.