Class MaskingMediaPeriod
- java.lang.Object
-
- com.google.android.exoplayer2.source.MaskingMediaPeriod
-
- All Implemented Interfaces:
MediaPeriod,MediaPeriod.Callback,SequenceableLoader,SequenceableLoader.Callback<MediaPeriod>
@Deprecated public final class MaskingMediaPeriod extends Object implements MediaPeriod, MediaPeriod.Callback
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.Media period that defers callingMediaSource.createPeriod(MediaPeriodId, Allocator, long)on a given source untilcreatePeriod(MediaPeriodId)has been called. This is useful if you need to return a media period immediately but the media source that should create it is not yet available or prepared.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceMaskingMediaPeriod.PrepareListenerDeprecated.Listener for preparation events.-
Nested classes/interfaces inherited from interface com.google.android.exoplayer2.source.MediaPeriod
MediaPeriod.Callback
-
-
Field Summary
Fields Modifier and Type Field Description MediaSource.MediaPeriodIdidDeprecated.TheMediaSource.MediaPeriodIdused to create the masking media period.
-
Constructor Summary
Constructors Constructor Description MaskingMediaPeriod(MediaSource.MediaPeriodId id, Allocator allocator, long preparePositionUs)Deprecated.Creates a new masking media period.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description booleancontinueLoading(long positionUs)Deprecated.Attempts to continue loading.voidcreatePeriod(MediaSource.MediaPeriodId id)Deprecated.CallsMediaSource.createPeriod(MediaPeriodId, Allocator, long)on the wrapped source then prepares it ifprepare(Callback, long)has been called.voiddiscardBuffer(long positionUs, boolean toKeyframe)Deprecated.Discards buffered media up to the specified position.longgetAdjustedSeekPositionUs(long positionUs, SeekParameters seekParameters)Deprecated.Returns the position to which a seek will be performed, given the specified seek position andSeekParameters.longgetBufferedPositionUs()Deprecated.Returns an estimate of the position up to which data is buffered for the enabled tracks.longgetNextLoadPositionUs()Deprecated.Returns the next load time, orC.TIME_END_OF_SOURCEif loading has finished.longgetPreparePositionOverrideUs()Deprecated.Returns the prepare position override set byoverridePreparePositionUs(long).longgetPreparePositionUs()Deprecated.Returns the position at which the masking media period was prepared, in microseconds.TrackGroupArraygetTrackGroups()Deprecated.Returns theTrackGroups exposed by the period.booleanisLoading()Deprecated.Returns whether the media period is currently loading.voidmaybeThrowPrepareError()Deprecated.Throws an error that's preventing the period from becoming prepared.voidonContinueLoadingRequested(MediaPeriod source)Deprecated.Called by the loader to indicate that it wishes for itsSequenceableLoader.continueLoading(long)method to be called when it can continue to load data.voidonPrepared(MediaPeriod mediaPeriod)Deprecated.Called when preparation completes.voidoverridePreparePositionUs(long preparePositionUs)Deprecated.Overrides the default prepare position at which to prepare the media period.voidprepare(MediaPeriod.Callback callback, long positionUs)Deprecated.Prepares this media period asynchronously.longreadDiscontinuity()Deprecated.Attempts to read a discontinuity.voidreevaluateBuffer(long positionUs)Deprecated.Re-evaluates the buffer given the playback position.voidreleasePeriod()Deprecated.Releases the period.longseekToUs(long positionUs)Deprecated.Attempts to seek to the specified position in microseconds.longselectTracks(@NullableType ExoTrackSelection[] selections, boolean[] mayRetainStreamFlags, @NullableType SampleStream[] streams, boolean[] streamResetFlags, long positionUs)Deprecated.Performs a track selection.voidsetMediaSource(MediaSource mediaSource)Deprecated.Sets theMediaSourcethat will create the underlying media period.voidsetPrepareListener(MaskingMediaPeriod.PrepareListener listener)Deprecated.Sets a listener for preparation events.-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface com.google.android.exoplayer2.source.MediaPeriod
getStreamKeys
-
-
-
-
Field Detail
-
id
public final MediaSource.MediaPeriodId id
Deprecated.TheMediaSource.MediaPeriodIdused to create the masking media period.
-
-
Constructor Detail
-
MaskingMediaPeriod
public MaskingMediaPeriod(MediaSource.MediaPeriodId id, Allocator allocator, long preparePositionUs)
Deprecated.Creates a new masking media period. The media source must be set viasetMediaSource(MediaSource)before preparation can start.- Parameters:
id- The identifier used to create the masking media period.allocator- The allocator used to create the media period.preparePositionUs- The expected start position, in microseconds.
-
-
Method Detail
-
setPrepareListener
public void setPrepareListener(MaskingMediaPeriod.PrepareListener listener)
Deprecated.Sets a listener for preparation events.- Parameters:
listener- An listener to be notified of media period preparation events. If a listener is set,maybeThrowPrepareError()will not throw but will instead pass the first preparation error (if any) to the listener.
-
getPreparePositionUs
public long getPreparePositionUs()
Deprecated.Returns the position at which the masking media period was prepared, in microseconds.
-
overridePreparePositionUs
public void overridePreparePositionUs(long preparePositionUs)
Deprecated.Overrides the default prepare position at which to prepare the media period. This method must be called beforecreatePeriod(MediaPeriodId).- Parameters:
preparePositionUs- The default prepare position to use, in microseconds.
-
getPreparePositionOverrideUs
public long getPreparePositionOverrideUs()
Deprecated.Returns the prepare position override set byoverridePreparePositionUs(long).
-
setMediaSource
public void setMediaSource(MediaSource mediaSource)
Deprecated.Sets theMediaSourcethat will create the underlying media period.
-
createPeriod
public void createPeriod(MediaSource.MediaPeriodId id)
Deprecated.CallsMediaSource.createPeriod(MediaPeriodId, Allocator, long)on the wrapped source then prepares it ifprepare(Callback, long)has been called. CallreleasePeriod()to release the period.- Parameters:
id- The identifier that should be used to create the media period from the media source.
-
releasePeriod
public void releasePeriod()
Deprecated.Releases the period.
-
prepare
public void prepare(MediaPeriod.Callback callback, long positionUs)
Deprecated.Description copied from interface:MediaPeriodPrepares this media period asynchronously.callback.onPreparedis called when preparation completes. If preparation fails,MediaPeriod.maybeThrowPrepareError()will throw anIOException.If preparation succeeds and results in a source timeline change (e.g. the period duration becoming known),
MediaSource.MediaSourceCaller.onSourceInfoRefreshed(MediaSource, Timeline)will be called beforecallback.onPrepared.- Specified by:
preparein interfaceMediaPeriod- Parameters:
callback- Callback to receive updates from this period, including being notified when preparation completes.positionUs- The expected starting position, in microseconds.
-
maybeThrowPrepareError
public void maybeThrowPrepareError() throws IOExceptionDeprecated.Description copied from interface:MediaPeriodThrows an error that's preventing the period from becoming prepared. Does nothing if no such error exists.This method is only called before the period has completed preparation.
- Specified by:
maybeThrowPrepareErrorin interfaceMediaPeriod- Throws:
IOException- The underlying error.
-
getTrackGroups
public TrackGroupArray getTrackGroups()
Deprecated.Description copied from interface:MediaPeriodReturns theTrackGroups exposed by the period.This method is only called after the period has been prepared.
- Specified by:
getTrackGroupsin interfaceMediaPeriod- Returns:
- The
TrackGroups.
-
selectTracks
public long selectTracks(@NullableType ExoTrackSelection[] selections, boolean[] mayRetainStreamFlags, @NullableType SampleStream[] streams, boolean[] streamResetFlags, long positionUs)
Deprecated.Description copied from interface:MediaPeriodPerforms a track selection.The call receives track
selectionsfor each renderer,mayRetainStreamFlagsindicating whether the existingSampleStreamcan be retained for each selection, and the existingstreams themselves. The call will updatestreamsto reflect the provided selections, clearing, setting and replacing entries as required. If an existing sample stream is retained but with the requirement that the consuming renderer be reset, then the corresponding flag instreamResetFlagswill be set to true. This flag will also be set if a new sample stream is created.Note that previously passed
TrackSelectionsare no longer valid, and any references to them must be updated to point to the new selections.This method is only called after the period has been prepared.
- Specified by:
selectTracksin interfaceMediaPeriod- Parameters:
selections- The renderer track selections.mayRetainStreamFlags- Flags indicating whether the existing sample stream can be retained for each track selection. Atruevalue indicates that the selection is equivalent to the one that was previously passed, and that the caller does not require that the sample stream be recreated. If a retained sample stream holds any references to the track selection then they must be updated to point to the new selection.streams- The existing sample streams, which will be updated to reflect the provided selections.streamResetFlags- Will be updated to indicate new sample streams, and sample streams that have been retained but with the requirement that the consuming renderer be reset.positionUs- The current playback position in microseconds. If playback of this period has not yet started, the value will be the starting position.- Returns:
- The actual position at which the tracks were enabled, in microseconds.
-
discardBuffer
public void discardBuffer(long positionUs, boolean toKeyframe)Deprecated.Description copied from interface:MediaPeriodDiscards buffered media up to the specified position.This method is only called after the period has been prepared.
- Specified by:
discardBufferin interfaceMediaPeriod- Parameters:
positionUs- The position in microseconds.toKeyframe- If true then for each track discards samples up to the keyframe before or at the specified position, rather than any sample before or at that position.
-
readDiscontinuity
public long readDiscontinuity()
Deprecated.Description copied from interface:MediaPeriodAttempts to read a discontinuity.A discontinuity implies that the provided
SampleStreamswill start from a new playback position and any output pipelines need to be reset. This happens for example if the streams provide decode-only samples before the intended playback start position that need to be dropped.After this method has returned a value other than
C.TIME_UNSET, allSampleStreamsprovided by the period are guaranteed to start from a key frame.This method is only called after the period has been prepared.
- Specified by:
readDiscontinuityin interfaceMediaPeriod- Returns:
- The playback position after the discontinuity, in microseconds, or
C.TIME_UNSETif there is no discontinuity.
-
getBufferedPositionUs
public long getBufferedPositionUs()
Deprecated.Description copied from interface:MediaPeriodReturns an estimate of the position up to which data is buffered for the enabled tracks.This method is only called when at least one track is selected.
- Specified by:
getBufferedPositionUsin interfaceMediaPeriod- Specified by:
getBufferedPositionUsin interfaceSequenceableLoader- Returns:
- An estimate of the absolute position in microseconds up to which data is buffered, or
C.TIME_END_OF_SOURCEif the track is fully buffered.
-
seekToUs
public long seekToUs(long positionUs)
Deprecated.Description copied from interface:MediaPeriodAttempts to seek to the specified position in microseconds.After this method has been called, all
SampleStreams provided by the period are guaranteed to start from a key frame.This method is only called when at least one track is selected.
- Specified by:
seekToUsin interfaceMediaPeriod- Parameters:
positionUs- The seek position in microseconds.- Returns:
- The actual position to which the period was seeked, in microseconds.
-
getAdjustedSeekPositionUs
public long getAdjustedSeekPositionUs(long positionUs, SeekParameters seekParameters)Deprecated.Description copied from interface:MediaPeriodReturns the position to which a seek will be performed, given the specified seek position andSeekParameters.This method is only called after the period has been prepared.
- Specified by:
getAdjustedSeekPositionUsin interfaceMediaPeriod- Parameters:
positionUs- The seek position in microseconds.seekParameters- Parameters that control how the seek is performed. Implementations may apply seek parameters on a best effort basis.- Returns:
- The actual position to which a seek will be performed, in microseconds.
-
getNextLoadPositionUs
public long getNextLoadPositionUs()
Deprecated.Description copied from interface:MediaPeriodReturns the next load time, orC.TIME_END_OF_SOURCEif loading has finished.This method is only called after the period has been prepared. It may be called when no tracks are selected.
- Specified by:
getNextLoadPositionUsin interfaceMediaPeriod- Specified by:
getNextLoadPositionUsin interfaceSequenceableLoader
-
reevaluateBuffer
public void reevaluateBuffer(long positionUs)
Deprecated.Description copied from interface:MediaPeriodRe-evaluates the buffer given the playback position.This method is only called after the period has been prepared.
A period may choose to discard buffered media or cancel ongoing loads so that media can be re-buffered in a different quality.
- Specified by:
reevaluateBufferin interfaceMediaPeriod- Specified by:
reevaluateBufferin interfaceSequenceableLoader- Parameters:
positionUs- The current playback position in microseconds. If playback of this period has not yet started, the value will be the starting position in this period minus the duration of any media in previous periods still to be played.
-
continueLoading
public boolean continueLoading(long positionUs)
Deprecated.Description copied from interface:MediaPeriodAttempts to continue loading.This method may be called both during and after the period has been prepared.
A period may call
SequenceableLoader.Callback.onContinueLoadingRequested(SequenceableLoader)on theMediaPeriod.Callbackpassed toMediaPeriod.prepare(Callback, long)to request that this method be called when the period is permitted to continue loading data. A period may do this both during and after preparation.- Specified by:
continueLoadingin interfaceMediaPeriod- Specified by:
continueLoadingin interfaceSequenceableLoader- Parameters:
positionUs- The current playback position in microseconds. If playback of this period has not yet started, the value will be the starting position in this period minus the duration of any media in previous periods still to be played.- Returns:
- True if progress was made, meaning that
MediaPeriod.getNextLoadPositionUs()will return a different value than prior to the call. False otherwise.
-
isLoading
public boolean isLoading()
Deprecated.Description copied from interface:MediaPeriodReturns whether the media period is currently loading.- Specified by:
isLoadingin interfaceMediaPeriod- Specified by:
isLoadingin interfaceSequenceableLoader
-
onContinueLoadingRequested
public void onContinueLoadingRequested(MediaPeriod source)
Deprecated.Description copied from interface:SequenceableLoader.CallbackCalled by the loader to indicate that it wishes for itsSequenceableLoader.continueLoading(long)method to be called when it can continue to load data. Called on the playback thread.- Specified by:
onContinueLoadingRequestedin interfaceSequenceableLoader.Callback<MediaPeriod>
-
onPrepared
public void onPrepared(MediaPeriod mediaPeriod)
Deprecated.Description copied from interface:MediaPeriod.CallbackCalled when preparation completes.Called on the playback thread. After invoking this method, the
MediaPeriodcan expect forMediaPeriod.selectTracks(ExoTrackSelection[], boolean[], SampleStream[], boolean[], long)to be called with the initial track selection.- Specified by:
onPreparedin interfaceMediaPeriod.Callback- Parameters:
mediaPeriod- The preparedMediaPeriod.
-
-