Package com.google.android.exoplayer2.source

Class ClippingMediaPeriod

    • Field Detail

      • mediaPeriod

        public final MediaPeriod mediaPeriod
        Deprecated.
        The MediaPeriod wrapped by this clipping media period.

    • Constructor Detail

      • ClippingMediaPeriod

        public ClippingMediaPeriod​(MediaPeriod mediaPeriod,
                           boolean enableInitialDiscontinuity,
                           long startUs,
                           long endUs)
        Deprecated.
        Creates a new clipping media period that provides a clipped view of the specified MediaPeriod's sample streams.

        If the start point is guaranteed to be a key frame, pass false to enableInitialPositionDiscontinuity to suppress an initial discontinuity when the period is first read from.

        Parameters:
        mediaPeriod - The media period to clip.
        enableInitialDiscontinuity - Whether the initial discontinuity should be enabled.
        startUs - The clipping start time, in microseconds.
        endUs - The clipping end time, in microseconds, or C.TIME_END_OF_SOURCE to indicate the end of the period.

    • Method Detail

      • updateClipping

        public void updateClipping​(long startUs,
                           long endUs)
        Deprecated.
        Updates the clipping start/end times for this period, in microseconds.
        Parameters:
        startUs - The clipping start time, in microseconds.
        endUs - The clipping end time, in microseconds, or C.TIME_END_OF_SOURCE to indicate the end of the period.

      • setClippingError

        public void setClippingError​(ClippingMediaSource.IllegalClippingException clippingError)
        Deprecated.
        Sets a clipping error detected by the media source so that it can be thrown as a period error at the next opportunity.
        Parameters:
        clippingError - The clipping error.

      • maybeThrowPrepareError

        public void maybeThrowPrepareError()
                            throws IOException
        Deprecated.
        Description copied from interface: MediaPeriod
        Throws 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:
        maybeThrowPrepareError in interface MediaPeriod
        Throws:
        IOException - The underlying error.

      • selectTracks

        public long selectTracks​(@NullableType ExoTrackSelection[] selections,
                         boolean[] mayRetainStreamFlags,
                         @NullableType SampleStream[] streams,
                         boolean[] streamResetFlags,
                         long positionUs)
        Deprecated.
        Description copied from interface: MediaPeriod
        Performs a track selection.

        The call receives track selections for each renderer, mayRetainStreamFlags indicating whether the existing SampleStream can be retained for each selection, and the existing streams themselves. The call will update streams to 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 in streamResetFlags will be set to true. This flag will also be set if a new sample stream is created.

        Note that previously passed TrackSelections are 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:
        selectTracks in interface MediaPeriod
        Parameters:
        selections - The renderer track selections.
        mayRetainStreamFlags - Flags indicating whether the existing sample stream can be retained for each track selection. A true value 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: MediaPeriod
        Discards buffered media up to the specified position.

        This method is only called after the period has been prepared.

        Specified by:
        discardBuffer in interface MediaPeriod
        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.

      • reevaluateBuffer

        public void reevaluateBuffer​(long positionUs)
        Deprecated.
        Description copied from interface: MediaPeriod
        Re-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:
        reevaluateBuffer in interface MediaPeriod
        Specified by:
        reevaluateBuffer in interface SequenceableLoader
        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.

      • readDiscontinuity

        public long readDiscontinuity()
        Deprecated.
        Description copied from interface: MediaPeriod
        Attempts to read a discontinuity.

        A discontinuity implies that the provided SampleStreams will 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, all SampleStreams provided by the period are guaranteed to start from a key frame.

        This method is only called after the period has been prepared.

        Specified by:
        readDiscontinuity in interface MediaPeriod
        Returns:
        The playback position after the discontinuity, in microseconds, or C.TIME_UNSET if there is no discontinuity.

      • getBufferedPositionUs

        public long getBufferedPositionUs()
        Deprecated.
        Description copied from interface: MediaPeriod
        Returns 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:
        getBufferedPositionUs in interface MediaPeriod
        Specified by:
        getBufferedPositionUs in interface SequenceableLoader
        Returns:
        An estimate of the absolute position in microseconds up to which data is buffered, or C.TIME_END_OF_SOURCE if the track is fully buffered.

      • seekToUs

        public long seekToUs​(long positionUs)
        Deprecated.
        Description copied from interface: MediaPeriod
        Attempts 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:
        seekToUs in interface MediaPeriod
        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: MediaPeriod
        Returns the position to which a seek will be performed, given the specified seek position and SeekParameters.

        This method is only called after the period has been prepared.

        Specified by:
        getAdjustedSeekPositionUs in interface MediaPeriod
        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.