java.lang.Object
- com.google.android.exoplayer2.source.BaseMediaSource
- - com.google.android.exoplayer2.source.hls.HlsMediaSource

All Implemented Interfaces:: HlsPlaylistTracker.PrimaryPlaylistListener, MediaSource

public final class HlsMediaSource
extends BaseMediaSource
implements HlsPlaylistTracker.PrimaryPlaylistListener

An HLS MediaSource.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`HlsMediaSource.Factory`	Factory for `HlsMediaSource`s.
`static interface`	`HlsMediaSource.MetadataType`	The types of metadata that can be extracted from HLS streams.

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

Field Summary

Fields
Modifier and Type Field Description

static int METADATA_TYPE_EMSG
Type for ESMG metadata in HLS streams.

static int METADATA_TYPE_ID3
Type for ID3 metadata in HLS streams.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`MediaPeriod`	`createPeriod(MediaSource.MediaPeriodId id, Allocator allocator, long startPositionUs)`	Returns a new `MediaPeriod` identified by `periodId`.
`MediaItem`	`getMediaItem()`	Returns the `MediaItem` whose media is provided by the source.
`void`	`maybeThrowSourceInfoRefreshError()`	Throws any pending error encountered while loading or refreshing source information.
`void`	`onPrimaryPlaylistRefreshed(HlsMediaPlaylist mediaPlaylist)`	Called when the primary playlist changes.
`protected void`	`prepareSourceInternal(TransferListener mediaTransferListener)`	Starts source preparation and enables the source, see `BaseMediaSource.prepareSource(MediaSourceCaller, TransferListener)`.
`void`	`releasePeriod(MediaPeriod mediaPeriod)`	Releases the period.
`protected void`	`releaseSourceInternal()`	Releases the source, see `BaseMediaSource.releaseSource(MediaSourceCaller)`.

Methods inherited from class com.google.android.exoplayer2.source.BaseMediaSource
addDrmEventListener, addEventListener, createDrmEventDispatcher, createDrmEventDispatcher, createEventDispatcher, createEventDispatcher, createEventDispatcher, disable, disableInternal, enable, enableInternal, isEnabled, prepareSource, refreshSourceInfo, releaseSource, removeDrmEventListener, removeEventListener

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.MediaSource
getInitialTimeline, isSingleWindow

- Field Detail
  - METADATA_TYPE_ID3
```
public static final int METADATA_TYPE_ID3
```
    Type for ID3 metadata in HLS streams.
    
    See Also:
    
    Constant Field Values
  - METADATA_TYPE_EMSG
```
public static final int METADATA_TYPE_EMSG
```
    Type for ESMG metadata in HLS streams.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - getMediaItem
```
public MediaItem getMediaItem()
```
    Description copied from interface: MediaSource
    
    Returns the MediaItem whose media is provided by the source.
    
    Specified by:
    
    getMediaItem in interface MediaSource
  - prepareSourceInternal
```
protected void prepareSourceInternal(@Nullable
                                     TransferListener mediaTransferListener)
```
    Description copied from class: BaseMediaSource
    
    Starts source preparation and enables the source, see BaseMediaSource.prepareSource(MediaSourceCaller, TransferListener). This method is called at most once until the next call to BaseMediaSource.releaseSourceInternal().
    
    Specified by:
    
    prepareSourceInternal in class BaseMediaSource
    
    Parameters:
    
    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 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.
    Must only be called after MediaSource.prepareSource(MediaSourceCaller, TransferListener).
    
    Specified by:
    
    maybeThrowSourceInfoRefreshError in interface MediaSource
    
    Throws:
    
    IOException
  - createPeriod
```
public MediaPeriod createPeriod(MediaSource.MediaPeriodId id,
                                Allocator allocator,
                                long startPositionUs)
```
    Description copied from interface: MediaSource
    
    Returns a new MediaPeriod identified by periodId.
    Should not be called directly from application code.
    Must only be called if the source is enabled.
    
    Specified by:
    
    createPeriod in interface MediaSource
    
    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)
```
    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
```
protected void releaseSourceInternal()
```
    Description copied from class: BaseMediaSource
    
    Releases the source, see BaseMediaSource.releaseSource(MediaSourceCaller). This method is called exactly once after each call to BaseMediaSource.prepareSourceInternal(TransferListener).
    
    Specified by:
    
    releaseSourceInternal in class BaseMediaSource
  - onPrimaryPlaylistRefreshed
```
public void onPrimaryPlaylistRefreshed(HlsMediaPlaylist mediaPlaylist)
```
    Description copied from interface: HlsPlaylistTracker.PrimaryPlaylistListener
    
    Called when the primary playlist changes.
    
    Specified by:
    
    onPrimaryPlaylistRefreshed in interface HlsPlaylistTracker.PrimaryPlaylistListener
    
    Parameters:
    
    mediaPlaylist - The primary playlist new snapshot.

Modifier and Type	Field	Description
`static int`	`METADATA_TYPE_EMSG`	Type for ESMG metadata in HLS streams.
`static int`	`METADATA_TYPE_ID3`	Type for ID3 metadata in HLS streams.

Class HlsMediaSource

Nested Class Summary

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

Field Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.android.exoplayer2.source.MediaSource

Field Detail

METADATA_TYPE_ID3

METADATA_TYPE_EMSG

Method Detail

getMediaItem

prepareSourceInternal

maybeThrowSourceInfoRefreshError

createPeriod

releasePeriod

releaseSourceInternal

onPrimaryPlaylistRefreshed