Media3
Latest Update | Stable Release | Release Candidate | Beta Release | Alpha Release |
---|---|---|---|---|
November 27, 2024 | 1.5.0 | - | - | - |
Declaring dependencies
To add a dependency on Media3, you must add the Google Maven repository to your project. Read Google's Maven repository for more information.
Add the dependencies for the artifacts you need in the build.gradle
file for
your app or module:
Groovy
dependencies { def media3_version = "1.5.0" // For media playback using ExoPlayer implementation "androidx.media3:media3-exoplayer:$media3_version" // For DASH playback support with ExoPlayer implementation "androidx.media3:media3-exoplayer-dash:$media3_version" // For HLS playback support with ExoPlayer implementation "androidx.media3:media3-exoplayer-hls:$media3_version" // For SmoothStreaming playback support with ExoPlayer implementation "androidx.media3:media3-exoplayer-smoothstreaming:$media3_version" // For RTSP playback support with ExoPlayer implementation "androidx.media3:media3-exoplayer-rtsp:$media3_version" // For MIDI playback support with ExoPlayer (see additional dependency requirements in // https://github.com/androidx/media/blob/release/libraries/decoder_midi/README.md) implementation "androidx.media3:media3-exoplayer-midi:$media3_version" // For ad insertion using the Interactive Media Ads SDK with ExoPlayer implementation "androidx.media3:media3-exoplayer-ima:$media3_version" // For loading data using the Cronet network stack implementation "androidx.media3:media3-datasource-cronet:$media3_version" // For loading data using the OkHttp network stack implementation "androidx.media3:media3-datasource-okhttp:$media3_version" // For loading data using librtmp implementation "androidx.media3:media3-datasource-rtmp:$media3_version" // For building media playback UIs implementation "androidx.media3:media3-ui:$media3_version" // For building media playback UIs for Android TV using the Jetpack Leanback library implementation "androidx.media3:media3-ui-leanback:$media3_version" // For exposing and controlling media sessions implementation "androidx.media3:media3-session:$media3_version" // For extracting data from media containers implementation "androidx.media3:media3-extractor:$media3_version" // For integrating with Cast implementation "androidx.media3:media3-cast:$media3_version" // For scheduling background operations using Jetpack Work's WorkManager with ExoPlayer implementation "androidx.media3:media3-exoplayer-workmanager:$media3_version" // For transforming media files implementation "androidx.media3:media3-transformer:$media3_version" // For applying effects on video frames implementation "androidx.media3:media3-effect:$media3_version" // For muxing media files implementation "androidx.media3:media3-muxer:$media3_version" // Utilities for testing media components (including ExoPlayer components) implementation "androidx.media3:media3-test-utils:$media3_version" // Utilities for testing media components (including ExoPlayer components) via Robolectric implementation "androidx.media3:media3-test-utils-robolectric:$media3_version" // Common functionality for reading and writing media containers implementation "androidx.media3:media3-container:$media3_version" // Common functionality for media database components implementation "androidx.media3:media3-database:$media3_version" // Common functionality for media decoders implementation "androidx.media3:media3-decoder:$media3_version" // Common functionality for loading data implementation "androidx.media3:media3-datasource:$media3_version" // Common functionality used across multiple media libraries implementation "androidx.media3:media3-common:$media3_version" // Common Kotlin-specific functionality implementation "androidx.media3:media3-common-ktx:$media3_version" }
Kotlin
dependencies { val media3_version = "1.5.0" // For media playback using ExoPlayer implementation("androidx.media3:media3-exoplayer:$media3_version") // For DASH playback support with ExoPlayer implementation("androidx.media3:media3-exoplayer-dash:$media3_version") // For HLS playback support with ExoPlayer implementation("androidx.media3:media3-exoplayer-hls:$media3_version") // For SmoothStreaming playback support with ExoPlayer implementation("androidx.media3:media3-exoplayer-smoothstreaming:$media3_version") // For RTSP playback support with ExoPlayer implementation("androidx.media3:media3-exoplayer-rtsp:$media3_version") // For MIDI playback support with ExoPlayer (see additional dependency requirements in // https://github.com/androidx/media/blob/release/libraries/decoder_midi/README.md) implementation("androidx.media3:media3-exoplayer-midi:$media3_version") // For ad insertion using the Interactive Media Ads SDK with ExoPlayer implementation("androidx.media3:media3-exoplayer-ima:$media3_version") // For loading data using the Cronet network stack implementation("androidx.media3:media3-datasource-cronet:$media3_version") // For loading data using the OkHttp network stack implementation("androidx.media3:media3-datasource-okhttp:$media3_version") // For loading data using librtmp implementation("androidx.media3:media3-datasource-rtmp:$media3_version") // For building media playback UIs implementation("androidx.media3:media3-ui:$media3_version") // For building media playback UIs for Android TV using the Jetpack Leanback library implementation("androidx.media3:media3-ui-leanback:$media3_version") // For exposing and controlling media sessions implementation("androidx.media3:media3-session:$media3_version") // For extracting data from media containers implementation("androidx.media3:media3-extractor:$media3_version") // For integrating with Cast implementation("androidx.media3:media3-cast:$media3_version") // For scheduling background operations using Jetpack Work's WorkManager with ExoPlayer implementation("androidx.media3:media3-exoplayer-workmanager:$media3_version") // For transforming media files implementation("androidx.media3:media3-transformer:$media3_version") // For applying effects on video frames implementation("androidx.media3:media3-effect:$media3_version") // For muxing media files implementation("androidx.media3:media3-muxer:$media3_version") // Utilities for testing media components (including ExoPlayer components) implementation("androidx.media3:media3-test-utils:$media3_version") // Utilities for testing media components (including ExoPlayer components) via Robolectric implementation("androidx.media3:media3-test-utils-robolectric:$media3_version") // Common functionality for reading and writing media containers implementation("androidx.media3:media3-container:$media3_version") // Common functionality for media database components implementation("androidx.media3:media3-database:$media3_version") // Common functionality for media decoders implementation("androidx.media3:media3-decoder:$media3_version") // Common functionality for loading data implementation("androidx.media3:media3-datasource:$media3_version") // Common functionality used across multiple media libraries implementation("androidx.media3:media3-common:$media3_version") // Common Kotlin-specific functionality implementation("androidx.media3:media3-common-ktx:$media3_version") }
For more information about dependencies, see Add Build Dependencies.
Feedback
Your feedback helps make Jetpack better. You can use the Media3 issue tracker to find answers to questions, known issues and feature requests, and to file new issues.
Version 1.5
Version 1.5.0
November 27, 2024
androidx.media3:media3-*:1.5.0
is released.
Version 1.5.0 contains these commits.
- Common Library:
- Add
ForwardingSimpleBasePlayer
that allows forwarding to another player with small adjustments while ensuring full consistency and listener handling (#1183). - Replace
SimpleBasePlayer.State.playlist
bygetPlaylist()
method. - Add override for
SimpleBasePlayer.State.Builder.setPlaylist()
to directly specify aTimeline
and currentTracks
andMetadata
instead of building a playlist structure. - Increase
minSdk
to 21 (Android Lollipop). This is aligned with all other AndroidX libraries. - Add
androidx.media3:media3-common-ktx
artifact which provides Kotlin-specific functionality built on top of the Common library - Add
Player.listen
suspending extension function to spin a coroutine to listen toPlayer.Events
to themedia3-common-ktx
library. - Remove
@DoNotInline
annotations from manually out-of-lined inner classes designed to avoid runtime class verification failures. Recent versions of R8 now automatically out-of-line calls like these to avoid the runtime failures (so the manual out-of-lining is no longer required). All Gradle users of the library must already be a using a version of the Android Gradle Plugin that uses a version of R8 which does this, due tocompileSdk = 35
. Users of the library with non-Gradle build systems will need to ensure their R8-equivalent shrinking/obfuscating step does a similar automatic out-of-lining process in order to avoid runtime class verification failures. This change has already been done in other AndroidX libraries.
- Add
- ExoPlayer:
MediaCodecRenderer.onProcessedStreamChange()
can now be called for every media item. Previously it was not called for the first one. UseMediaCodecRenderer.experimentalEnableProcessedStreamChangedAtStart()
to enable this.- Add
PreloadMediaSource.PreloadControl.onPreloadError
to allowPreloadMediaSource.PreloadControl
implementations to take actions when error occurs. - Add
BasePreloadManager.Listener
to propagate preload events to apps. - Allow changing SNTP client timeout and retry alternative addresses on timeout (#1540).
- Remove
MediaCodecAdapter.Configuration.flags
as the field was always zero. - Allow the user to select the built-in speaker for playback on Wear OS API 35+ (where the device advertises support for this).
- Defer the blocking call to
Context.getSystemService(Context.AUDIO_SERVICE)
until audio focus handling is enabled. This ensures the blocking call isn't done if audio focus handling is not enabled (#1616). - Allow playback regardless of buffered duration when loading fails (#1571).
- Add
AnalyticsListener.onRendererReadyChanged()
to signal when individual renderers allow playback to be ready. - Fix
MediaCodec.CryptoException
sometimes being reported as an "unexpected runtime error" whenMediaCodec
is operated in asynchronous mode (default behaviour on API 31+). - Pass
bufferedDurationUs
instead ofbufferedPositionUs
withPreloadMediaSource.PreloadControl.onContinueLoadingRequested()
. Also changesDefaultPreloadManager.Status.STAGE_LOADED_TO_POSITION_MS
toDefaultPreloadManager.Status.STAGE_LOADED_FOR_DURATION_MS
, apps then need to pass a value representing a specific duration from the default start position for which the corresponding media source has to be preloaded with this IntDef, instead of a position. - Add
ForwardingRenderer
implementation that forwards all method calls to another renderer (1703). - Add playlist preloading for the next item in the playlist. Apps can
enable preloading by calling
ExoPlayer.setPreloadConfiguration(PreloadConfiguration)
accordingly. By default preloading is disabled. When opted-in and to not interfere with playback,DefaultLoadControl
restricts preloading to start and continue only when the player is not loading for playback. Apps can change this behaviour by implementingLoadControl.shouldContinuePreloading()
accordingly (like when overriding this method inDefaultLoadControl
). The default implementation ofLoadControl
disables preloading in case an app is using a custom implementation ofLoadControl
. - Add method
MediaSourceEventListener.EventDispatcher.dispatchEvent()
to allow invoking events of subclass listeners (1736). - Add
DefaultPreloadManager.Builder
that builds theDefaultPreloadManager
andExoPlayer
instances with consistently shared configurations. - Remove
Renderer[]
parameter fromLoadControl.onTracksSelected()
asDefaultLoadControl
implementation can retrieve the stream types fromExoTrackSelection[]
. - Deprecated
DefaultLoadControl.calculateTargetBufferBytes(Renderer[], ExoTrackSelection[])
and marked method as final to prevent overrides. The newDefaultLoadControl.calculateTargetBufferBytes(ExoTrackSelection[])
should be used instead. - Report
MediaSourceEventListener
events from secondary sources inMergingMediaSource
. This will result in load start/error/cancelled/completed events being reported for sideloaded subtitles (those added withMediaItem.LocalConfiguration.subtitleConfigurations
), which may appear as duplicate load events emitted fromAnalyticsListener
. - Prevent subtitle & metadata errors from completely stopping playback.
Instead the problematic track is disabled and playback of the remaining
tracks continues
(#1722).
- In new subtitle handling (during extraction), associated parse (e.g.
invalid subtitle data) and load errors (e.g. HTTP 404) are emitted
via
onLoadError
callbacks. - In legacy subtitle handling (during rendering), only associated load
errors are emitted via
onLoadError
callbacks while parse errors are silently ignored (this is pre-existing behaviour).
- In new subtitle handling (during extraction), associated parse (e.g.
invalid subtitle data) and load errors (e.g. HTTP 404) are emitted
via
- Fix bug where playlist items or periods in multi-period DASH streams with durations that don't match the actual content could cause frame freezes at the end of the item (#1698).
- Add a setter to
SntpClient
to set the max elapsed time since the last update after which the client is re-initialized (#1794).
- Transformer:
- Add
SurfaceAssetLoader
, which supports queueing video data to Transformer via aSurface
. ImageAssetLoader
reports unsupported input viaAssetLoader.onError
instead of throwing anIllegalStateException
.- Make setting the image duration using
MediaItem.Builder.setImageDurationMs
mandatory for image export. - Add export support for gaps in sequences of audio EditedMediaItems.
- Add
- Track Selection:
DefaultTrackSelector
: Prefer object-based audio over channel-based audio when other factors are equal.
- Extractors:
- Allow
Mp4Extractor
andFragmentedMp4Extractor
to identify H264 samples that are not used as reference by subsequent samples. - Add option to enable index-based seeking in
AmrExtractor
. - Treat MP3 files with more than 128kB between valid frames as truncated
(instead of invalid). This means files with non-MP3 data at the end,
with no other metadata to indicate the length of the MP3 bytes, now stop
playback at the end of the MP3 data instead of failing with
ParserException: Searched too many bytes.{contentIsMalformed=true, dataType=1}
(#1563). - Fix preroll sample handling for non-keyframe media start positions when processing edit lists in MP4 files (#1659).
- Improved frame rate calculation by using media duration from the
mdhd
box inMp4Extractor
andFragmentedMp4Extractor
(#1531). - Fix incorrect scaling of
media_time
in MP4 edit lists. Whilesegment_duration
was already correctly scaled using the movie timescale,media_time
is now properly scaled using the track timescale, as specified by the MP4 format standard (#1792). - Handle out-of-order frames in
endIndices
calculation for MP4 with edit list (#1797). - Fix media duration parsing in
mdhd
box of MP4 files to handle-1
values (#1819). - Add support for identifying
h263
box in MP4 files for H.263 video (#1821). - Add AC-4 Level-4 ISO base media file format support (#1265).
- Allow
- DataSource:
- Update
HttpEngineDataSource
to allow use starting at version S extension 7 instead of API level 34 (#1262). DataSourceContractTest
: Assert thatDataSource.getUri()
returns the resolved URI (as documented). Where this is different to the requested URI, tests can indicate this using the newDataSourceContractTest.TestResource.Builder.setResolvedUri()
method.DataSourceContractTest
: Assert thatDataSource.getUri()
andgetResponseHeaders()
return their 'open' value after a failed call toopen()
(due to a 'not found' resource) and before a subsequentclose()
call.- Overriding
DataSourceContractTest.getNotFoundResources()
allows test sub-classes to provide multiple 'not found' resources, and to provide any expected headers too. This allows to distinguish between HTTP 404 (with headers) and "server not found" (no headers).
- Overriding
- Update
- Audio:
- Automatically configure CTA-2075 loudness metadata on the codec if present in the media.
- Ensure smooth volume ramp down when seeking.
- Fix pop sounds that may occur during seeks.
- Fix truncation error accumulation for Sonic's time-stretching/pitch-shifting algorithm.
- Fix bug in
SpeedChangingAudioProcessor
that causes dropped output frames.
- Video:
MediaCodecVideoRenderer
avoids decoding samples that are neither rendered nor used as reference by other samples.- On API 35 and above,
MediaCodecAdapter
may now receive anull
Surface
inconfigure
and calls to a new methoddetachOutputSurface
to remove a previously setSurface
if the codec supports this (MediaCodecInfo.detachedSurfaceSupported
). - Use
MediaCodecAdapter
supplied pixel aspect ratio values if provided when processingonOutputFormatChanged
(#1371). - Add workaround for a device issue on Galaxy Tab S7 FE that causes 60fps secure H264 streams to be marked as unsupported (#1619).
- Add workaround for codecs that get stuck after the last sample without returning an end-of-stream signal.
- Text:
- Add a custom
VoiceSpan
and populate it for WebVTT voice spans (#1632). - Ensure WebVTT in HLS with very large subtitle timestamps (which overflow
a 64-bit
long
when represented as microseconds and multiplied by the90,000
MPEG timebase) are displayed (#1763). - Support CEA-608 subtitles in Dolby Vision content (#1820).
- Fix playback hanging on DASH multi-period streams when CEA-608 subtitles are enabled (#1863).
- Add a custom
- Metadata:
- Assign the
C.TRACK_TYPE_METADATA
type to tracks containing icy or vnd.dvb.ait content.
- Assign the
- Image:
- Add
ExternallyLoadedImageDecoder
for simplified integration with external image loading libraries like Glide or Coil.
- Add
- DataSource:
- Add
FileDescriptorDataSource
, a newDataSource
that can be used to read from aFileDescriptor
(#3757).
- Add
- Effect:
- Add
DefaultVideoFrameProcessor
workaround for minorSurfaceTexture
scaling.SurfaceTexture
may include a small scaling that cuts off a 1-texel border around the edge of a cropped buffer. This is now handled such that output is closer to expected. - Speed up
DefaultVideoFrameProcessor.queueInputBitmap()
. As a result, exporting images to videos withTransformer
is faster.
- Add
- IMA extension:
- Fix bug where clearing the playlist may cause an
ArrayIndexOutOfBoundsException
inImaServerSideAdInsertionMediaSource
. - Fix bug where server-side inserted DAI streams without a preroll can
result in an
ArrayIndexOutOfBoundsException
when playing past the last midroll (#1741).
- Fix bug where clearing the playlist may cause an
- Session:
- Add
MediaButtonReceiver.shouldStartForegroundService(Intent)
to allow apps to suppress a play command coming in for playback resumption by overriding this method. By default, the service is always started and playback can't be suppressed without the system crashing the service with aForegroundServiceDidNotStartInTimeException
(#1528). - Fix bug that caused custom commands sent from a
MediaBrowser
being dispatched to theMediaSessionCompat.Callback
instead of theMediaBrowserServiceCompat
variant of the method when connected to a legacy service. This prevented theMediaBrowser
to receive the actual return value sent back by the legacy service (#1474). - Handle
IllegalArgumentException
thrown by devices of certain manufacturers when setting the broadcast receiver for media button intents (#1730). - Add command buttons for media items. This adds the Media3 API for what
was known as
Custom browse actions
with the legacy library withMediaBrowserCompat
. Note that with Media3 command buttons for media items are available for both,MediaBrowser
andMediaController
. See Custom Browse actions of AAOS. - Fix bug where a Media3 controller was sometimes unable to let a session
app start a foreground service after requesting
play()
. - Restrict
CommandButton.Builder.setIconUri
to only accept content Uris. - Pass connection hints of a Media3 browser to the initial
MediaBrowserCompat
when connecting to a legacyMediaBrowserCompat
. The service can receive the connection hints passed in as root hints with the first call toonGetRoot()
. - Fix bug where a
MediaBrowser
connected to a legacy browser service, didn't receive an error sent by the service after the browser has subscribed to aparentid
. - Improve interoperability behavior, so that a Media3 browser that is
connected to a legacy
MediaBrowserService
doesn't request the children of aparentId
twice when subscribing to a parent.
- Add
- UI:
- Make the stretched/cropped video in
PlayerView
-in-Compose-AndroidView
workaround opt-in, due to issues with XML-based shared transitions. Apps usingPlayerView
insideAndroidView
need to callPlayerView.setEnableComposeSurfaceSyncWorkaround
in order to opt-in (#1237, #1594). - Add
setFullscreenButtonState
toPlayerView
to allow updates of fullscreen button's icon on demand, i.e. out-of-band and not reactively to a click interaction (#1590, #184). - Fix bug where the "None" choice in the text selection is not working if there are app-defined text track selection preferences.
- Make the stretched/cropped video in
- DASH Extension:
- Add support for periods starting in the middle of a segment (#1440).
- Smooth Streaming Extension:
- Fix a
Bad magic number for Bundle
error when playing SmoothStreaming streams with text tracks (#1779).
- Fix a
- RTSP Extension:
- Decoder Extensions (FFmpeg, VP9, AV1, etc.):
- Add the IAMF decoder module, which provides support for playback of MP4
files containing IAMF tracks using the libiamf native library to
synthesize audio.
- Playback is enabled with a stereo layout as well as 5.1 with spatialization together with optional head tracking enabled, but binaural playback support is currently not available.
- Add 16 KB page support for decoder extensions on Android 15 (#1685).
- Add the IAMF decoder module, which provides support for playback of MP4
files containing IAMF tracks using the libiamf native library to
synthesize audio.
- Cast Extension:
- Stop cleaning the timeline after the CastSession disconnects, which enables the sender app to resume playback locally after a disconnection.
- Populate CastPlayer's
DeviceInfo
when aContext
is provided. This enables linking theMediaSession
to aRoutingSession
, which is necessary for integrating Output Switcher (#1056).
- Test Utilities:
DataSourceContractTest
now includes tests to verify:- Input stream
read position
is updated. - Output buffer
offset
is applied correctly.
- Input stream
- Demo app
- Resolve the memory leaks in demo short-form app (#1839).
- Remove deprecated symbols:
- Remove deprecated
Player.hasPrevious
,Player.hasPreviousWindow()
. UsePlayer.hasPreviousMediaItem()
instead. - Remove deprecated
Player.previous()
method. UsePlayer.seekToPreviousMediaItem()
instead. - Remove deprecated
DrmSessionEventListener.onDrmSessionAcquired
method. - Remove deprecated
DefaultEncoderFactory
constructors. UseDefaultEncoderFactory.Builder
instead.
- Remove deprecated
Version 1.5.0-rc02
November 19, 2024
Use the 1.5.0 stable version.
Version 1.5.0-rc01
November 13, 2024
Use the 1.5.0 stable version.
Version 1.5.0-beta01
October 30, 2024
Use the 1.5.0 stable version.
Version 1.5.0-alpha01
September 10, 2024
Use the 1.5.0 stable version.
Version 1.4.0
Version 1.4.1
August 27, 2024
androidx.media3:media3-*:1.4.1
is released.
Version 1.4.1 contains these commits.
- ExoPlayer:
- Extractors:
- MP3: Fix
Searched too many bytes
error by correctly ignoring trailing non-MP3 data based on the length field in anInfo
frame (#1480).
- MP3: Fix
- Text:
- TTML: Fix handling of percentage
tts:fontSize
values to ensure they are correctly inherited from parent nodes with percentagetts:fontSize
values. - Fix
IndexOutOfBoundsException
inLegacySubtitleUtil
due to incorrectly handling the case of the requested output start time being greater than or equal to the final event time in theSubtitle
(#1516).
- TTML: Fix handling of percentage
- DRM:
- Fix
android.media.MediaCodec$CryptoException: Operation not supported in this configuration: ERROR_DRM_CANNOT_HANDLE
error on API 31+ devices playing L1 Widevine content. This error is caused by an incomplete implementation of the frameworkMediaDrm.requiresSecureDecoder
method (#1603).
- Fix
- Effect:
- Add a
release()
method toGlObjectsProvider
.
- Add a
- Session:
- Transform a double-tap of
KEYCODE_HEADSETHOOK
into a 'seek to next' action, as documented (#1493). - Handle
KEYCODE_HEADSETHOOK
as a 'play' command inMediaButtonReceiver
when deciding whether to ignore it to avoid aForegroundServiceDidNotStartInTimeException
(#1581).
- Transform a double-tap of
- RTSP Extension:
- Skip invalid Media Descriptions in SDP parsing (#1087).
Version 1.4.0
July 25, 2024
androidx.media3:media3-*:1.4.0
is released.
Version 1.4.0 contains these commits.
- Common Library:
- Forward presumed no-op seek calls to the protected
BasePlayer.seekTo()
andSimpleBasePlayer.handleSeek()
methods instead of ignoring them. If you are implementing these methods in a custom player, you may need to handle these additional calls withmediaItemIndex == C.INDEX_UNSET
. - Remove compile dependency on enhanced Java 8 desugaring (#1312).
- Ensure the duration passed to
MediaItem.Builder.setImageDurationMs()
is ignored for a non-imageMediaItem
(as documented). - Add
Format.customData
to store app-provided custom information aboutFormat
instances.
- Forward presumed no-op seek calls to the protected
- ExoPlayer:
- Add
BasePreloadManager
which coordinates the preloading for multiple sources based on the priorities defined by theirrankingData
. Customization is possible by extending this class. AddDefaultPreloadManager
which usesPreloadMediaSource
to preload media samples of the sources into memory, and uses an integerrankingData
that indicates the index of an item on the UI. - Add
PlayerId
to most methods ofLoadControl
to enableLoadControl
implementations to support multiple players. - Remove
Buffer.isDecodeOnly()
andC.BUFFER_FLAG_DECODE_ONLY
. There is no need to set this flag as renderers and decoders will decide to skip buffers based on timestamp. CustomRenderer
implementations should check if the buffer time is at leastBaseRenderer.getLastResetPositionUs()
to decide whether a sample should be shown. CustomSimpleDecoder
implementations can checkisAtLeastOutputStartTimeUs()
if needed or mark other buffers withDecoderOutputBuffer.shouldBeSkipped
to skip them. - Allow a null value to be returned by
TargetPreloadStatusControl.getTargetPreloadStatus(T)
to indicate not to preload aMediaSource
with the givenrankingData
. - Add
remove(MediaSource)
toBasePreloadManager
. - Add
reset()
toBasePreloadManager
to release all the holding sources while keep the preload manager instance. - Add
ExoPlayer.setPriority()
(andBuilder.setPriority()
) to define the priority value used inPriorityTaskManager
and for MediaCodec importance from API 35. - Fix issue with updating the last rebuffer time which resulted in
incorrect
bs
(buffer starvation) key in CMCD (#1124). - Add
PreloadMediaSource.PreloadControl.onLoadedToTheEndOfSource(PreloadMediaSource)
to indicate that the source has loaded to the end. This allows theDefaultPreloadManager
and the customPreloadMediaSource.PreloadControl
implementations to preload the next source or take other actions. - Fix bug where silence skipping at the end of items can trigger a playback exception.
- Add
clear
toPreloadMediaSource
to discard the preloading period. - Add new error code
PlaybackException.ERROR_CODE_DECODING_RESOURCES_RECLAIMED
that is used when codec resources are reclaimed for higher priority tasks. - Let
AdsMediaSource
load preroll ads before initial content media preparation completes (#1358). - Fix bug where playback moved to
STATE_ENDED
when re-preparing a multi-period DASH live stream after the original period was already removed from the manifest. - Rename
onTimelineRefreshed()
toonSourcePrepared()
andonPrepared()
toonTracksSelected()
inPreloadMediaSource.PreloadControl
. Also rename the IntDefs inDefaultPreloadManager.Stage
accordingly. - Add experimental support for dynamic scheduling to better align work
with CPU wake-cycles and delay waking up to when renderers can progress.
You can enable this using
experimentalSetDynamicSchedulingEnabled()
when setting up your ExoPlayer instance. - Add
Renderer.getDurationToProgressUs()
. ARenderer
can implement this method to return to ExoPlayer the duration that playback must advance for the renderer to progress. IfExoPlayer
is set withexperimentalSetDynamicSchedulingEnabled()
thenExoPlayer
will call this method when calculating the time to schedule its work task. - Add
MediaCodecAdapter#OnBufferAvailableListener
to alert when input and output buffers are available for use byMediaCodecRenderer
.MediaCodecRenderer
will signalExoPlayer
when receiving these callbacks and ifExoPlayer
is set withexperimentalSetDynamicSchedulingEnabled()
, thenExoPlayer
will schedule its work loop as renderers can make progress. - Use data class for
LoadControl
methods instead of individual parameters. - Add
ExoPlayer.isReleased()
to check whetherExoplayer.release()
has been called. - Add
ExoPlayer.Builder.setMaxSeekToPreviousPositionMs()
to configure the maximum position for whichseekToPrevious()
seeks to the previous item (#1425). - Fix some audio focus inconsistencies, e.g. not reporting full or transient focus loss while the player is paused (#1436).
- Fix potential
IndexOutOfBoundsException
caused by extractors reporting additional tracks after the initial preparation step (#1476). Effects
inExoPlayer.setVideoEffect()
will receive the timestamps with the renderer offset removed (#1098).- Fix potential
IllegalArgumentException
when handling player error that happened while reading ahead into another playlist item (#1483).
- Add
- Transformer:
- Add
audioConversionProcess
andvideoConversionProcess
toExportResult
indicating how the respective track in the output file was made. - Relax trim optimization H.264 level checks.
- Add support for changing between SDR and HDR input media in a sequence.
- Add support for composition-level audio effects.
- Add support for transcoding Ultra HDR images into HDR videos.
- Fix issue where the
DefaultAudioMixer
does not output the correct amount of bytes after being reset and reused. - Work around a decoder bug where the number of audio channels was capped at stereo when handling PCM input.
- When selecting tracks in
ExoPlayerAssetLoader
, ignore audio channel count constraints as they only apply for playback. - Replace
androidx.media3.transformer.Muxer
interface withandroidx.media3.muxer.Muxer
and removeandroidx.media3.transformer.Muxer
. - Fix HEIC image loading from content URI schemes. (#1373).
- Adjust audio track duration in
AudioGraphInput
to improve AV sync. - Remove
ExportResult.processedInputs
field. If you use this field for codec details, then useDefaultDecoderFactory.listener
instead. In case of a codec exception, codec details will be available in theExportException.codecInfo
.
- Add
- Extractors:
- MPEG-TS: Roll forward the change ensuring the last frame is rendered by passing the last access unit of a stream to the sample queue (#7909). Incorporating fixes to resolve the issues that emerged in I-frame only HLS streams(#1150) and H.262 HLS streams (#1126).
- MP3: Prefer the data size from an
Info
frame over the size reported by the underlying stream (e.g. file size, or HTTPContent-Length
header). This helps to exclude non-playable trailer data (e.g. album artwork) from constant bitrate seeking calculations, making seeks more accurate (#1376). - MP3: Use the frame count and other data in an
Info
frame (if present) to compute an average bitrate for constant bitrate seeking, rather than extrapolating from the bitrate of the frame after theInfo
frame, which may be artificially small, e.g.PCUT
frame (#1376). - Fix PCM audio format extraction in AVI containers.
- Audio:
- Fix DTS:X Profile 2 encoding attributes for passthrough playback (#1299).
- For offloaded playback, reset the tracking field for stream completion
in
DefaultAudioSink
prior to callingAudioTrack.stop()
so thatAudioTrack.StreamEventCallback#onPresentationEnded
correctly identifies when all pending data has been played. - Fix bug in
SilenceSkippingAudioProcessor
where transitions between different audio formats (for example stereo to mono) can cause the processor to throw an exception (#1352). - Implement
MediaCodecAudioRenderer.getDurationToProgressUs()
so that ExoPlayer will dynamically schedule its main work loop to when the MediaCodecAudioRenderer can make progress.
- Video:
- Fix issue where
Listener.onRenderedFirstFrame()
arrives too early when switching surfaces mid-playback. - Fix decoder fallback logic for Dolby Vision to use a compatible AV1 decoder if needed (#1389).
- Fix codec exception that may be caused by enabling a video renderer mid-playback.
- Fix issue where
- Text:
- Fix issue where subtitles starting before a seek position are skipped. This issue was only introduced in Media3 1.4.0-alpha01.
- Change default subtitle parsing behavior so it happens during extraction
instead of during rendering (see
ExoPlayer's architecture diagram
for the difference between extraction and rendering).
- This change can be overridden by calling both
MediaSource.Factory.experimentalParseSubtitlesDuringExtraction(false)
andTextRenderer.experimentalSetLegacyDecodingEnabled(true)
. See the docs on customization for how to plumb these components into anExoPlayer
instance. These methods (and all support for legacy subtitle decoding) will be removed in a future release. - Apps with custom
SubtitleDecoder
implementations need to update them to implementSubtitleParser
instead (andSubtitleParser.Factory
instead ofSubtitleDecoderFactory
).
- This change can be overridden by calling both
- PGS: Fix run-length decoding to resolve
0
as a color index, instead of a literal color value (#1367). - CEA-708: Ignore
rowLock
value. The CEA-708-E S-2023 spec states thatrowLock
andcolumnLock
should both be assumed to be true, regardless of the values present in the stream (columnLock
support is not implemented, so it's effectively assumed to always be false).- This was originally included in the
1.3.0-alpha01
release notes, but the change was accidentally reverted before the1.3.0-rc01
release. This is now fixed, so the change is present again.
- This was originally included in the
- CEA-708: Avoid duplicate newlines being added by ExoPlayer's naive handling of the 'set pen location' command (#1315).
- Fix an
IllegalArgumentException
fromLegacySubtitleUtil
when a WebVTT subtitle sample contains no cues, e.g. as part of a DASH stream (#1516).
- Metadata:
- Fix mapping of MP4 to ID3 sort tags. Previously the 'album sort'
(
soal
), 'artist sort' (soar
) and 'album artist sort' (soaa
) MP4 tags were wrongly mapped to theTSO2
,TSOA
andTSOP
ID3 tags (#1302). - Fix reading of MP4 (/iTunes) numeric
gnre
(genre) andtmpo
(tempo) tags when the value is more than one byte long. - Propagate ID3
TCON
frame toMediaMetadata.genre
(#1305).
- Fix mapping of MP4 to ID3 sort tags. Previously the 'album sort'
(
- Image:
- Add support for non-square DASH thumbnail grids (#1300).
- Add support for AVIF for API 34+.
- Allow
null
as parameter forExoPlayer.setImageOutput()
to clear a previously setImageOutput
.
- DataSource:
- Implement support for
android.resource://package/id
raw resource URIs wherepackage
is different to the package of the current application. This wasn't previously documented to work, but is a more efficient way of accessing resources in another package than by name. - Eagerly check
url
is non-null in theDataSpec
constructors. This parameter was already annotated to be non-null. - Allow
ByteArrayDataSource
to resolve a URI to a byte array duringopen()
, instead of being hard-coded at construction (#1405).
- Implement support for
- DRM:
- Allow setting a
LoadErrorHandlingPolicy
onDefaultDrmSessionManagerProvider
(#1271).
- Allow setting a
- Effect:
- Support multiple speed changes within the same
EditedMediaItem
orComposition
inSpeedChangeEffect
. - Support for HLG and PQ output from ultra HDR bitmap input.
- Add support for EGL_GL_COLORSPACE_BT2020_HLG_EXT, which improves HLG surface output in ExoPlayer.setVideoEffect and Transformer's Debug SurfaceView.
- Update Overlay matrix implementation to make it consistent with the
documentation by flipping the x and y values applied in
setOverlayFrameAnchor()
. If usingOverlaySettings.Builder.setOverlayFrameAnchor()
, flip their x and y values by multiplying them by-1
. - Fix bug where
TimestampWrapper
crashes when used withExoPlayer#setVideoEffects
(#821). - Change default SDR color working space from linear colors to electrical BT 709 SDR video. Also provide third option to retain the original colorspace.
- Allow defining indeterminate z-order of EditedMediaItemSequences (#1055).
- Maintain a consistent luminance range across different pieces of HDR content (uses the HLG range).
- Add support for Ultra HDR (bitmap) overlays on HDR content.
- Allow
SeparableConvolution
effects to be used before API 26. - Remove unused
OverlaySettings.useHdr
since dynamic range of overlay and frame must match. - Add HDR support for
TextOverlay
. Luminance of the text overlay can be adjusted withOverlaySettings.Builder.setHdrLuminanceMultiplier()
.
- Support multiple speed changes within the same
- IMA extension:
- Promote API that is required for apps to play DAI ad streams to stable.
- Add
replaceAdTagParameters(Map <String, String>)
toImaServerSideAdInsertionMediaSource.AdLoader
that allows replacing ad tag parameters at runtime. - Fix bug where
VideoAdPlayer.VideoAdPlayerCallback.onError()
was not called when a player error happened during ad playback (#1334). - Bump IMA SDK version to 3.33.0 to fix a
NullPointerException
when usingdata://
ad tag URIs (#700).
- Session:
- Change default of
CommandButton.enabled
totrue
and ensure the value can stay false for controllers even if the associated command is available. - Add icon constants for
CommandButton
that should be used instead of custom icon resources. - Add
MediaSessionService.isPlaybackOngoing()
to let apps query whether the service needs to be stopped inonTaskRemoved()
(#1219). - Add
MediaSessionService.pauseAllPlayersAndStopSelf()
that conveniently allows to pause playback of all sessions and callstopSelf()
to terminate the lifecycle of theMediaSessionService
. - Override
MediaSessionService.onTaskRemoved(Intent)
to provide a safe default implementation that keeps the service running in the foreground if playback is ongoing or stops the service otherwise. - Hide seekbar in the media notification for live streams by not setting the duration into the platform session metadata (#1256).
- Align conversion of
MediaMetadata
toMediaDescriptionCompat
, to use the same preferred order and logic when selecting metadata properties as in media1. - Add
MediaSession.sendError()
that allows sending non-fatal errors to Media3 controller. When using the notification controller (seeMediaSession.getMediaNotificationControllerInfo()
), the custom error is used to update thePlaybackState
of the platform session to an error state with the given error information (#543). - Add
MediaSession.Callback.onPlayerInteractionFinished()
to inform sessions when a series of player interactions from a specific controller finished. - Add
SessionError
and use it inSessionResult
andLibraryResult
instead of the error code to provide more information about the error and how to resolve the error if possible. - Publish the code for the media3 controller test app that can be used to test interactions with apps publishing a media session.
- Propagate extras passed to media3's
MediaSession[Builder].setSessionExtras()
to a media1 controller'sPlaybackStateCompat.getExtras()
. - Map fatal and non-fatal errors to and from the platform session. A
PlaybackException
is mapped to a fatal error state of thePlaybackStateCompat
. ASessionError
sent to the media notification controller withMediaSession.sendError(ControllerInfo, SessionError)
is mapped to a non-fatal error inPlaybackStateCompat
which means that error code and message are set but the state of the platform session remains different toSTATE_ERROR
. - Allow the session activity to be set per controller to override the
global session activity. The session activity can be defined for a
controller at connection time by creating a
ConnectionResult
withAcceptedResultBuilder.setSessionActivivty(PendingIntent)
. Once connected, the session activity can be updated withMediaSession.setSessionActivity(ControllerInfo, PendingIntent)
. - Improve error replication of calls to
MediaLibrarySession.Callback
. Error replication can now be configured by usingMediaLibrarySession.Builder.setLibraryErrorReplicationMode()
for choosing the error type or opt-ing out of error replication which is on by default.
- Change default of
- UI:
- Add image display support to
PlayerView
when connected to anExoPlayer
(#1144). - Add customization of various icons in
PlayerControlView
through xml attributes to allow different drawables perPlayerView
instance, rather than global overrides (#1200). - Work around a platform bug causing stretched/cropped video when using
SurfaceView
inside a ComposeAndroidView
on API 34 (#1237).
- Add image display support to
- Downloads:
- Ensure that
DownloadHelper
does not leak unreleasedRenderer
instances, which can eventually result in an app crashing withIllegalStateException: Too many receivers, total of 1000, registered for pid
(#1224).
- Ensure that
- Cronet Extension:
- Fix
SocketTimeoutException
inCronetDataSource
. In some versions of Cronet, the request provided by the callback is not always the same. This leads to callback not completing and request timing out (https://issuetracker.google.com/328442628).
- Fix
- HLS Extension:
- Fix bug where pending EMSG samples waiting for a discontinuity were
delegated in
HlsSampleStreamWrapper
with an incorrect offset causing anIndexOutOfBoundsException
or anIllegalArgumentException
(#1002). - Fix bug where non-primary playlists keep reloading for LL-HLS streams (#1240).
- Fix bug where enabling CMCD for HLS with initialization segments
resulted in
Source Error
andIllegalArgumentException
. - Fix bug where non-primary playing playlists are not refreshed during live playback (#1240).
- Fix bug where enabling CMCD for HLS live streams causes
ArrayIndexOutOfBoundsException
(#1395).
- Fix bug where pending EMSG samples waiting for a discontinuity were
delegated in
- DASH Extension:
- Cast Extension:
- Fix bug that converted the album title of the
MediaQueueItem
to the artist in the Media3 media item (#1255).
- Fix bug that converted the album title of the
- Test Utilities:
- Implement
onInit()
andonRelease()
inFakeRenderer
. - Change
TestPlayerRunHelper.runUntil()/playUntil()
methods to fail on nonfatal errors (e.g. those reported toAnalyticsListener.onVideoCodecError()
). Use the newTestPlayerRunHelper.run(player).ignoringNonFatalErrors().untilXXX()
method chain to disable this behavior.
- Implement
- Demo app:
- Use
DefaultPreloadManager
in the short form demo app. - Allow setting repeat mode with
Intent
arguments from command line (#1266). - Use
HttpEngineDataSource
as theHttpDataSource
when supported by the device.
- Use
- Remove deprecated symbols:
- Remove
CronetDataSourceFactory
. UseCronetDataSource.Factory
instead. - Remove some
DataSpec
constructors. UseDataSpec.Builder
instead. - Remove
setContentTypePredicate(Predicate)
method fromDefaultHttpDataSource
,OkHttpDataSource
andCronetDataSource
. Use the equivalent method on eachXXXDataSource.Factory
instead. - Remove
OkHttpDataSource
constructors andOkHttpDataSourceFactory
. UseOkHttpDataSource.Factory
instead. - Remove
PlayerMessage.setHandler(Handler)
. UsesetLooper(Looper)
instead. - Remove
Timeline.Window.isLive
field. Use theisLive()
method instead. - Remove
DefaultHttpDataSource
constructors. UseDefaultHttpDataSource.Factory
instead. - Remove
DashMediaSource.DEFAULT_LIVE_PRESENTATION_DELAY_MS
. UseDashMediaSource.DEFAULT_FALLBACK_TARGET_LIVE_OFFSET_MS
instead. - Remove
MediaCodecInfo.isSeamlessAdaptationSupported(Format, Format, boolean)
. UseMediaCodecInfo.canReuseCodec(Format, Format)
instead. - Remove
DrmSessionManager.DUMMY
andgetDummyDrmSessionManager()
method. UseDrmSessionManager.DRM_UNSUPPORTED
instead. - Remove
AnalyticsListener.onAudioInputFormatChanged(EventTime, Format)
,AnalyticsListener.onVideoInputFormatChanged(EventTime, Format)
,AudioRendererEventListener.onAudioInputFormatChanged(Format)
,VideoRendererEventListener.onVideoInputFormatChanged(Format)
. Use the overloads that take aDecoderReuseEvaluation
instead. - Remove
RendererSupport.FormatSupport
IntDef andFORMAT_HANDLED
,FORMAT_EXCEEDS_CAPABILITIES
,FORMAT_UNSUPPORTED_DRM
,FORMAT_UNSUPPORTED_SUBTYPE
,FORMAT_UNSUPPORTED_TYPE
constants. Use the equivalent IntDef and constants inandroidx.media3.common.C
instead (e.g.C.FORMAT_HANDLED
). - Remove
Bundleable
interface. This includes removing allBundleable.Creator<Foo> CREATOR
constant fields. Callers should use theBundle toBundle()
andstatic Foo fromBundle(Bundle)
methods on each type instead.
- Remove
Version 1.4.0-rc01
July 10, 2024
Use the 1.4.0 stable version.
Version 1.4.0-beta01
June 26, 2024
Use the 1.4.0 stable version.
Version 1.4.0-alpha02
June 07, 2024
Use the 1.4.0 stable version.
Version 1.4.0-alpha01
April 17, 2024
Use the 1.4.0 stable version.
Version 1.3.0
Version 1.3.1
April 11, 2024
androidx.media3:media3-*:1.3.1
is released.
Version 1.3.1 contains these commits.
- Common Library:
- Add
Format.labels
to allow localized or other alternative labels.
- Add
- ExoPlayer:
- Fix issue where
PreloadMediaPeriod
cannot retain the streams when it is preloaded again. - Apply the correct corresponding
TrackSelectionResult
to the playing period in track reselection. - Start early-enabled renderers only after advancing the playing period when transitioning between media items (#1017).
- Add missing return type to proguard
-keepclasseswithmembers
rule forDefaultVideoFrameProcessor.Factory.Builder.build()
(#1187).
- Fix issue where
- Transformer:
- Add workaround for exception thrown due to
MediaMuxer
not supporting negative presentation timestamps before API 30.
- Add workaround for exception thrown due to
- Track Selection:
DefaultTrackSelector
: Prefer video tracks with a 'reasonable' frame rate (>=10fps) over those with a lower or unset frame rate. This ensures the player selects the 'real' video track in MP4s extracted from motion photos that can contain two HEVC tracks where one has a higher resolution but a very small number of frames (#1051).
- Extractors:
- Fix issue where padding was not skipped when reading odd-sized chunks from WAV files (#1117).
- MP3: Populate
Format.averageBitrate
from metadata frames such asXING
andVBRI
. - MPEG-TS: Revert a change that aimed to ensure the last frame is rendered by passing the last access unit of a stream to the sample queue (#7909). This is due to the change causing new problems with I-frame only HLS streams (#1150) and H.262 HLS streams (#1126).
- Audio:
- Allow renderer recovery by disabling offload if audio track fails to initialize in offload mode.
- Video:
- Add workaround for a device issue on Galaxy Tab S7 FE, Chromecast with Google TV, and Lenovo M10 FHD Plus that causes 60fps H265 streams to be marked as unsupported
- Add workaround that ensures the first frame is always rendered while tunneling even if the device does not do this automatically as required by the API (#1169). (#966).
- Fix issue where HDR color info handling causes codec misbehavior and prevents adaptive format switches for SDR video tracks (#1158).
- Text:
- WebVTT: Prevent directly consecutive cues from creating spurious
additional
CuesWithTiming
instances fromWebvttParser.parse
(#1177).
- WebVTT: Prevent directly consecutive cues from creating spurious
additional
- DRM:
- Work around a
NoSuchMethodError
which can be thrown by theMediaDrm
framework instead ofResourceBusyException
orNotProvisionedException
on some Android 14 devices (#1145).
- Work around a
- Effect:
- Improved PQ to SDR tone-mapping by converting color spaces.
- Session:
- UI:
- Fallback to include audio track language name if
Locale
cannot identify a display name (#988).
- Fallback to include audio track language name if
- DASH Extension:
- Populate all
Label
elements from the manifest intoFormat.labels
(#1054).
- Populate all
- RTSP Extension:
- Skip empty session information values (i-tags) in SDP parsing (#1087).
- Decoder Extensions (FFmpeg, VP9, AV1, MIDI, etc.):
- Disable the MIDI extension as a local dependency by default because it requires an additional Maven repository to be configured. Users who need this module from a local dependency can re-enable it.
Version 1.3.0
March 6, 2024
androidx.media3:media3-*:1.3.0
is released.
Version 1.3.0 contains these commits.
- Common Library:
- Implement support for
android.resource://package/[type/]name
raw resource URIs wherepackage
is different to the package of the current application. This has always been documented to work, but wasn't correctly implemented until now. - Normalize MIME types set by app code or read from media to be fully lower-case.
- Define ads with a full
MediaItem
instead of a singleUri
inAdPlaybackState
. - Increase
minSdk
to 19 (Android KitKat). This is aligned with all other AndroidX libraries, and is required for us to upgrade to the latest versions of our AndroidX dependencies. - Populate both
artworkUri
andartworkData
inMediaMetadata.Builder.populate(MediaMetadata)
when at least one of them is non-null (#964).
- Implement support for
- ExoPlayer:
- Add
PreloadMediaSource
andPreloadMediaPeriod
that allows apps to preload a content media source at a specific start position before playback.PreloadMediaSource
takes care of preparing the content media source to receive theTimeline
, preparing and caching the period at the given start position, selecting tracks and loading media data for the period. Apps control the preload progress by implementingPreloadMediaSource.PreloadControl
and set the preloaded source to the player for playback. - Add
ExoPlayer.setImageOutput
that allows apps to setImageRenderer.ImageOutput
. DefaultRenderersFactory
now provides anImageRenderer
to the player by default with nullImageOutput
andImageDecoder.Factory.DEFAULT
.- Emit
Player.Listener.onPositionDiscontinuity
event when silence is skipped (#765). - Add experimental support for parsing subtitles during extraction. You
can enable this using
MediaSource.Factory.experimentalParseSubtitlesDuringExtraction()
. - Support adaptive media sources with
PreloadMediaSource
. - Implement
HttpEngineDataSource
, anHttpDataSource
using the HttpEngine API. - Prevent subclassing
CompositeSequenceableLoader
. This component was previously made extensible but was never subclassed within the library. Customizations can be done by wrapping an instance using the decorator pattern and implementing a customCompositeSequenceableLoaderFactory
. - Fix issue where repeating the same time causes metadata from this item to be cleared (#1007).
- Rename
experimentalSetSubtitleParserFactory
methods onBundledChunkExtractor.Factory
andDefaultHlsExtractorFactory
tosetSubtitleParserFactory
and disallow passingnull
. Use the newexperimentalParseSubtitlesDuringExtraction(boolean)
methods to control parsing behaviour. - Add support for customising the
SubtitleParser.Factory
used during extraction. This can be achieved withMediaSource.Factory.setSubtitleParserFactory()
. - Add source prefix to all
Format.id
fields generated fromMergingMediaSource
. This helps to identify which source produced aFormat
(#883). - Fix the regex used for validating custom Common Media Client Data (CMCD) key names by modifying it to only check for hyphen (#1028).
- Stop double-encoding CMCD query parameters (#1075).
- Add
- Transformer:
- Add support for flattening H.265/HEVC SEF slow motion videos.
- Increase transmuxing speed, especially for 'remove video' edits.
- Add API to ensure that the output file starts on a video frame. This can make the output of trimming operations more compatible with player implementations that don't show the first video frame until its presentation timestamp (#829).
- Add support for optimizing single asset MP4 trim operations.
- Add support to ensure a video frame has the first timestamp in the output file. Fixes output files beginning with black frame on iOS based players (#829).
- Track Selection:
- Add
DefaultTrackSelector.selectImageTrack
to enable image track selection. - Add
TrackSelectionParameters.isPrioritizeImageOverVideoEnabled
to determine whether to select an image track if both an image track and a video track are available. The default value isfalse
which means selecting a video track is prioritized.
- Add
- Extractors:
- Add additional AV1C parsing to MP4 extractor to retrieve
ColorInfo.colorSpace
,ColorInfo.colorTransfer
, andColorInfo.colorRange
values (#692). - MP3: Use constant bitrate (CBR) seeking for files with an
Info
header (the CBR equivalent of theXing
header). Previously we used the seek table from theInfo
header, but this results in less precise seeking than if we ignore it and assume the file is CBR. - MPEG2-TS: Add DTS, DTS-LBR and DTS:X Profile2 support (#275).
- Extract audio types from TS descriptors and map them to role flags, allowing users to make better-informed audio track selections (#973).
- Add additional AV1C parsing to MP4 extractor to retrieve
- Audio:
- Video:
- Change the
MediaCodecVideoRenderer
constructor that takes aVideoFrameProcessor.Factory
argument and replace it with a constructor that takes aVideoSinkProvider
argument. Apps that want to inject a customVideoFrameProcessor.Factory
can instantiate aCompositingVideoSinkProvider
that uses the customVideoFrameProcessor.Factory
and pass the video sink provider toMediaCodecVideoRenderer
.
- Change the
- Text:
- Fix serialization of bitmap cues to resolve
Tried to marshall a Parcel that contained Binder objects
error when usingDefaultExtractorsFactory.setTextTrackTranscodingEnabled
(#836). - CEA-708: Ignore
rowLock
value. The CEA-708-E S-2023 spec states thatrowLock
andcolumnLock
should both be assumed to be true, regardless of the values present in the stream (columnLock
support is not implemented, so it's effectively assumed to always be false).
- Fix serialization of bitmap cues to resolve
- Image:
- Add support for DASH thumbnails. Grid images are cropped and individual
thumbnails are provided to
ImageOutput
close to their presentation times.
- Add support for DASH thumbnails. Grid images are cropped and individual
thumbnails are provided to
- DRM:
- Play 'clear lead' unencrypted samples in DRM content immediately by
default, even if the keys for the later encrypted samples aren't ready
yet. This may lead to mid-playback stalls if the keys still aren't ready
when the playback position reaches the encrypted samples (but previously
playback wouldn't have started at all by this point). This behavior can
be disabled with
MediaItem.DrmConfiguration.Builder.setPlayClearContentWithoutKey
orDefaultDrmSessionManager.Builder.setPlayClearSamplesWithoutKeys
.
- Play 'clear lead' unencrypted samples in DRM content immediately by
default, even if the keys for the later encrypted samples aren't ready
yet. This may lead to mid-playback stalls if the keys still aren't ready
when the playback position reaches the encrypted samples (but previously
playback wouldn't have started at all by this point). This behavior can
be disabled with
- IMA extension:
- Fix issue where DASH and HLS ads without the appropriate file extension can't be played.
- Session:
- Disable double-click detection for TV apps (#962).
- Fix issue where
MediaItem.RequestMetadata
with just non-null extras is not transmitted between media controllers and sessions. - Add constructor to
MediaLibrarySession.Builder
that only takes aContext
instead of aMediaLibraryService
.
- HLS Extension:
- Reduce
HlsMediaPeriod
to package-private visibility. This type shouldn't be directly depended on from outside the HLS package. - Resolve seeks to beginning of a segment more efficiently (#1031).
- Reduce
- Decoder Extensions (FFmpeg, VP9, AV1, MIDI, etc.):
- MIDI decoder: Ignore SysEx event messages (#710).
- Test Utilities:
- Don't pause playback in
TestPlayerRunHelper.playUntilPosition
. The test keeps the playback in a playing state, but suspends progress until the test is able to add assertions and further actions.
- Don't pause playback in
- Demo app:
- Add a shortform demo module to demo the usage of
PreloadMediaSource
with the short-form content use case.
- Add a shortform demo module to demo the usage of
Version 1.3.0-rc01
February 22, 2024
Use the 1.3.0 stable version.
Version 1.3.0-beta01
February 7, 2024
Use the 1.3.0 stable version.
Version 1.3.0-alpha01
January 15, 2024
Use the 1.3.0 stable version.
Version 1.2.0
Version 1.2.1
January 9, 2024
- ExoPlayer:
- Fix issue where manual seeks outside of the
LiveConfiguration.min/maxOffset
range keep adjusting the offset back tomin/maxOffset
. - Fix issue that OPUS and VORBIS channel layouts are wrong for 3, 5, 6, 7 and 8 channels (#8396).
- Fix issue where track selections after seek to zero in a live stream incorrectly let the stream start at its default position (#9347).
- Fix the issue where new instances of
CmcdData.Factory
were receiving negative values forbufferedDurationUs
from chunk sources, resulting in anIllegalArgumentException
(#888).
- Fix issue where manual seeks outside of the
- Transformer:
- Work around an issue where the encoder would throw at configuration time due to setting a high operating rate.
- Extractors:
- Mark secondary (unplayable) HEVC tracks in JPEG motion photos as
ROLE_FLAG_ALTERNATE
to prevent them being automatically selected for playback because of their higher resolution. - Fix wrong keyframe detection for TS H264 streams (#864).
- Fix duration estimation of TS streams that are longer than 47721 seconds (#855).
- Mark secondary (unplayable) HEVC tracks in JPEG motion photos as
- Audio:
- Fix handling of EOS for
SilenceSkippingAudioProcessor
when called multiple times (#712).
- Fix handling of EOS for
- Video:
- Add workaround for a device issue on Galaxy Tab S7 FE, Chromecast with Google TV, and Lenovo M10 FHD Plus that causes 60fps AVC streams to be marked as unsupported (#693).
- Metadata:
- Fix bug where
MediaMetadata
was only populated from Vorbis comments with upper-case keys (#876). - Catch
OutOfMemoryError
when parsing very large ID3 frames, meaning playback can continue without the tag info instead of playback failing completely.
- Fix bug where
- DRM:
- Extend workaround for spurious ClearKey
https://default.url
license URL to API 33+ (previously the workaround only applied on API 33 exactly) (#837). - Fix
ERROR_DRM_SESSION_NOT_OPENED
when switching from encrypted to clear content without a surface attached to the player. The error was due to incorrectly using a secure decoder to play the clear content.
- Extend workaround for spurious ClearKey
- Session:
- Put the custom keys and values in
MediaMetadataCompat
toMediaMetadata.extras
andMediaMetadata.extras
toMediaMetadataCompat
(#756, #802). - Fix broadcasting
notifyChildrenChanged
for legacy controllers (#644). - Fix a bug where setting a negative time for a disabled
setWhen
timer of the notification caused a crash on some devices (#903). - Fix
IllegalStateException
when the media notification controller hasn't completed connecting when the first notification update is requested (#917).
- Put the custom keys and values in
- UI:
- DASH Extension:
- Parse "f800" as channel count of 5 for Dolby in DASH manifest (#688).
- Decoder Extensions (FFmpeg, VP9, AV1, MIDI, etc.):
- Cast Extension:
- Sanitize creation of a
Timeline
to not crash the app when loading media fails on the cast device (#708).
- Sanitize creation of a
Version 1.2.0
November 15, 2023
- Common Library:
- Add a
@Nullable Throwable
parameter to the methods in theLog.Logger
interface. Themessage
parameter to these methods no longer contains any information about theThrowable
passed to theLog.{d,i,w,e}()
methods, so implementations will need to manually append this information if desired (possibly usingLogger.appendThrowableString(String, Throwable)
). - Fix Kotlin compatibility issue where nullable generic type parameters
and nullable array element types are not detected as nullable. Examples
are
TrackSelectorResult
andSimpleDecoder
method parameters (#6792). - Change default UI and notification behavior in
Util.shouldShowPlayButton
to show a "play" button while playback is temporarily suppressed (e.g. due to transient audio focus loss). The legacy behavior can be maintained by usingPlayerView.setShowPlayButtonIfPlaybackIsSuppressed(false)
orMediaSession.Builder.setShowPlayButtonIfPlaybackIsSuppressed(false)
(#11213). - Upgrade
androidx.annotation:annotation-experimental
to1.3.1
to fix https://issuetracker.google.com/251172715. - Move
ExoPlayer.setAudioAttributes
to thePlayer
interface.
- Add a
- ExoPlayer:
- Fix seeking issues in AC4 streams caused by not identifying decode-only samples correctly (#11000).
- Add suppression of playback on unsuitable audio output devices (e.g. the
built-in speaker on Wear OS devices) when this feature is enabled via
ExoPlayer.Builder.setSuppressPlaybackOnUnsuitableOutput
. The playback suppression reason will be updated asPlayer.PLAYBACK_SUPPRESSION_REASON_UNSUITABLE_AUDIO_OUTPUT
if playback is attempted when no suitable audio outputs are available, or if all suitable outputs are disconnected during playback. The suppression reason will be removed when a suitable output is connected. - Add
MediaSource.canUpdateMediaItem
andMediaSource.updateMediaItem
to acceptMediaItem
updates after creation viaPlayer.replaceMediaItem(s)
. - Allow
MediaItem
updates for allMediaSource
classes provided by the library viaPlayer.replaceMediaItem(s)
(#33, #9978). - Rename
MimeTypes.TEXT_EXOPLAYER_CUES
toMimeTypes.APPLICATION_MEDIA3_CUES
. - Add
PngExtractor
that sends and reads a whole PNG file into theTrackOutput
as one sample. - Enhance
SequenceableLoader.continueLoading(long)
method in theSequenceableLoader
interface toSequenceableLoader.continueLoading(LoadingInfo loadingInfo)
.LoadingInfo
contains additional parameters, includingplaybackSpeed
andlastRebufferRealtimeMs
in addition to the existingplaybackPositionUs
. - Enhance
ChunkSource.getNextChunk(long, long, List, ChunkHolder)
method in theChunkSource
interface toChunkSource.getNextChunk(LoadingInfo, long, List, ChunkHolder)
. - Add additional fields to Common Media Client Data (CMCD) logging: buffer
starvation (
bs
), deadline (dl
), playback rate (pr
) and startup (su
) (#8699). - Add luma and chroma bitdepth to
ColorInfo
(#491). - Add additional fields to Common Media Client Data (CMCD) logging: next
object request (
nor
) and next range request (nrr
) (#8699). - Add functionality to transmit Common Media Client Data (CMCD) data using query parameters (#553).
- Fix
ConcurrentModificationException
inExperimentalBandwidthMeter
(#612). - Add
MediaPeriodId
parameter toCompositeMediaSource.getMediaTimeForChildMediaTime
. - Support
ClippingMediaSource
(and other sources with period/window time offsets) inConcatenatingMediaSource2
(#11226). - Change
BaseRenderer.onStreamChanged()
to also receive aMediaPeriodId
argument.
- Transformer:
- Parse EXIF rotation data for image inputs.
- Remove
TransformationRequest.HdrMode
annotation type and its associated constants. UseComposition.HdrMode
and its associated constants instead. - Simplify the
OverlaySettings
to fix rotation issues. - Changed
frameRate
anddurationUs
parameters ofSampleConsumer.queueInputBitmap
toTimestampIterator
.
- Track Selection:
- Add
DefaultTrackSelector.Parameters.allowAudioNonSeamlessAdaptiveness
to explicitly allow or disallow non-seamless adaptation. The default stays at its current behavior oftrue
.
- Add
- Extractors:
- MPEG-TS: Ensure the last frame is rendered by passing the last access unit of a stream to the sample queue (#7909).
- Fix typo when determining
rotationDegrees
. ChangedprojectionPosePitch
toprojectionPoseRoll
(#461). - Remove the assumption that
Extractor
instances can be directly inspected withinstanceof
. If you want runtime access to the implementation details of anExtractor
you must first callExtractor.getUnderlyingInstance
. - Add
BmpExtractor
. - Add
WebpExtractor
. - Add
HeifExtractor
. - Add
QuickTime classic
support to
Mp4Extractor
.
- Audio:
- Add support for 24/32-bit big-endian PCM in MP4 and Matroska, and parse
PCM encoding for
lpcm
in MP4. - Add support for extracting Vorbis audio in MP4.
- Add
AudioSink.getFormatOffloadSupport(Format)
that retrieves level of offload support the sink can provide for the format through aDefaultAudioOffloadSupportProvider
. It returns the newAudioOffloadSupport
that containsisFormatSupported
,isGaplessSupported
, andisSpeedChangeSupported
. - Add
AudioSink.setOffloadMode()
through which the offload configuration on the audio sink is configured. Default isAudioSink.OFFLOAD_MODE_DISABLED
. - Offload can be enabled through
setAudioOffloadPreference
inTrackSelectionParameters
. If the set preference is to enable, the device supports offload for the format, and the track selection is a single audio track, then audio offload will be enabled. - If
audioOffloadModePreference
is set toAUDIO_OFFLOAD_MODE_PREFERENCE_REQUIRED
, then theDefaultTrackSelector
will only select an audio track and only if that track's format is supported in offload. If no audio track is supported in offload, then no track will be selected. - Disabling gapless support for offload when pre-API level 33 due to playback position issue after track transition.
- Remove parameter
enableOffload
fromDefaultRenderersFactory.buildAudioSink
method signature. - Remove method
DefaultAudioSink.Builder.setOffloadMode
. - Remove intdef value
DefaultAudioSink.OffloadMode.OFFLOAD_MODE_ENABLED_GAPLESS_DISABLED
. - Add support for Opus gapless metadata during offload playback.
- Allow renderer recovery by disabling offload if failed at first write (#627).
- Enable Offload Scheduling by default for audio-only offloaded playback.
- Delete
ExoPlayer.experimentalSetOffloadSchedulingEnabled
andAudioOffloadListener.onExperimentalOffloadSchedulingEnabledChanged
. - Renamed
onExperimentalSleepingForOffloadChanged
asonSleepingForOffloadChanged
andonExperimentalOffloadedPlayback
asonOffloadedPlayback
. - Move audio offload mode related
TrackSelectionParameters
interfaces and definitions to an innerAudioOffloadPreferences
class. - Add
onAudioTrackInitialized
andonAudioTrackReleased
callbacks toAnalyticsListener
,AudioRendererEventListener
andAudioSink.Listener
. - Fix DTS Express audio buffer underflow issue (#650).
- Fix bug where the capabilities check for E-AC3-JOC throws an
IllegalArgumentException
(#677).
- Add support for 24/32-bit big-endian PCM in MP4 and Matroska, and parse
PCM encoding for
- Video:
- Allow
MediaCodecVideoRenderer
to use a customVideoFrameProcessor.Factory
. - Fix bug where the first frame couldn't be rendered if the audio stream starts with negative timestamps (#291).
- Allow
- Text:
- Remove
ExoplayerCuesDecoder
. Text tracks withsampleMimeType = application/x-media3-cues
are now directly handled byTextRenderer
without needing aSubtitleDecoder
instance.
- Remove
- Metadata:
MetadataDecoder.decode
will no longer be called for "decode-only" samples as the implementation must return null anyway.
- Effect:
- Add
VideoFrameProcessor.queueInputBitmap(Bitmap, Iterator<Long>)
queuing bitmap input by timestamp. - Change
VideoFrameProcessor.registerInputStream()
to be non-blocking. Apps must implementVideoFrameProcessor.Listener#onInputStreamRegistered()
. - Changed
frameRate
anddurationUs
parameters ofVideoFrameProcessor.queueInputBitmap
toTimestampIterator
.
- Add
- IMA extension:
- Fix bug where a multi-period DASH live stream that is not the first item in a playlist can throw an exception (#571).
- Release StreamManager before calling
AdsLoader.destroy()
- Bump IMA SDK version to 3.31.0.
- Session:
- Set the notifications foreground service behavior to
FOREGROUND_SERVICE_IMMEDIATE
inDefaultMediaNotificationProvider
(#167). - Use only
android.media.session.MediaSession.setMediaButtonBroadcastReceiver()
above API 31 to avoid problems with deprecated API on Samsung devices (#167). - Use the media notification controller as proxy to set available commands and custom layout used to populate the notification and the platform session.
- Convert media button events that are received by
MediaSessionService.onStartCommand()
within Media3 instead of routing them to the platform session and back to Media3. With this, the caller controller is always the media notification controller and apps can easily recognize calls coming from the notification in the same way on all supported API levels. - Fix bug where
MediaController.getCurrentPosition()
is not advancing when connected to a legacyMediaSessionCompat
. - Add
MediaLibrarySession.getSubscribedControllers(mediaId)
for convenience. - Override
MediaLibrarySession.Callback.onSubscribe()
to assert the availability of the parent ID for which the controller subscribes. If successful, the subscription is accepted andnotifyChildrenChanged()
is called immediately to inform the browser (#561). - Add session demo module for Automotive OS and enable session demo for Android Auto.
- Do not set the queue of the framework session when
COMMAND_GET_TIMELINE
is not available for the media notification controller. With Android Auto as the client controller reading from the framework session, this has the effect that thequeue
button in the UI of Android Auto is not displayed (#339). - Use
DataSourceBitmapLoader
by default instead ofSimpleBitmapLoader
(#271, #327). - Add
MediaSession.Callback.onMediaButtonEvent(Intent)
that allows apps to override the default media button event handling.
- Set the notifications foreground service behavior to
- UI:
- Add a
Player.Listener
implementation for Wear OS devices that handles playback suppression due toPlayer.PLAYBACK_SUPPRESSION_REASON_UNSUITABLE_AUDIO_OUTPUT
by launching a system dialog to allow a user to connect a suitable audio output (e.g. bluetooth headphones). The listener will auto-resume playback if a suitable device is connected within a configurable timeout (default is 5 minutes).
- Add a
- Downloads:
- Declare "data sync" foreground service type for
DownloadService
for Android 14 compatibility. When using this service, the app also needs to adddataSync
asforegroundServiceType
in the manifest and add theFOREGROUND_SERVICE_DATA_SYNC
permission (#11239).
- Declare "data sync" foreground service type for
- HLS Extension:
- Refresh the HLS live playlist with an interval calculated from the last load start time rather than the last load completed time (#663).
- DASH Extension:
- Allow multiple of the same DASH identifier in segment template URL.
- Add experimental support for parsing subtitles during extraction. This
has better support for merging overlapping subtitles, including
resolving flickering when transitioning between subtitle segments. You
can enable this using
DashMediaSource.Factory.experimentalParseSubtitlesDuringExtraction()
(#288).
- RTSP Extension:
- Fix a race condition that could lead to
IndexOutOfBoundsException
when falling back to TCP, or playback hanging in some situations. - Check state in RTSP setup when returning loading state of
RtspMediaPeriod
(#577). - Ignore custom Rtsp request methods in Options response public header (#613).
- Use RTSP Setup Response timeout value in time interval of sending keep-alive RTSP Options requests (#662).
- Fix a race condition that could lead to
- Decoder Extensions (FFmpeg, VP9, AV1, MIDI, etc.):
- Release the MIDI decoder module, which provides support for playback of standard MIDI files using the Jsyn library to synthesize audio.
- Add
DecoderOutputBuffer.shouldBeSkipped
to directly mark output buffers that don't need to be presented. This is preferred overC.BUFFER_FLAG_DECODE_ONLY
that will be deprecated. - Add
Decoder.setOutputStartTimeUs
andSimpleDecoder.isAtLeastOutputStartTimeUs
to allow decoders to drop decode-only samples before the start time. This should be preferred toBuffer.isDecodeOnly
that will be deprecated. - Fix bug publishing MIDI decoder artifact to Maven repository. The
artifact is renamed to
media3-exoplayer-midi
(#734).
- Leanback extension:
- Fix bug where disabling a surface can cause an
ArithmeticException
in Leanback code (#617).
- Fix bug where disabling a surface can cause an
- Test Utilities:
- Make
TestExoPlayerBuilder
andFakeClock
compatible with Espresso UI tests and Compose UI tests. This fixes a bug where playback advances non-deterministically during Espresso or Compose view interactions.
- Make
- Remove deprecated symbols:
- Remove
TransformationRequest.Builder.setEnableRequestSdrToneMapping(boolean)
andTransformationRequest.Builder.experimental_setEnableHdrEditing(boolean)
. UseComposition.Builder.setHdrMode(int)
and pass theComposition
toTransformer.start(Composition, String)
instead. - Remove deprecated
DownloadNotificationHelper.buildProgressNotification
method, use a non deprecated method that takes anotMetRequirements
parameter instead.
- Remove
Version 1.2.0-rc01
November 1, 2023
Use the 1.2.0 stable version.
Version 1.2.0-beta01
October 19, 2023
Use the 1.2.0 stable version.
Version 1.2.0-alpha02
September 29, 2023
Use the 1.2.0 stable version.
Version 1.2.0-alpha01
August 17, 2023
Use the 1.2.0 stable version.
Version 1.1.0
Version 1.1.1
August 16, 2023
- Common Library:
- Remove accidentally added
multidex
dependency from all modules (#499).
- Remove accidentally added
- ExoPlayer:
- Fix issue in
PlaybackStatsListener
where spuriousPlaybackStats
are created after the playlist is cleared. - Add additional fields to Common Media Client Data (CMCD) logging: streaming format (sf), stream type (st), version (v), top birate (tb), object duration (d), measured throughput (mtp) and object type (ot) (#8699).
- Fix issue in
- Audio:
- Fix a bug where
Player.getState()
never transitioned toSTATE_ENDED
when playing very short files (#538).
- Fix a bug where
- Audio Offload:
- Prepend Ogg ID Header and Comment Header Pages to bitstream for offloaded Opus playback in accordance with RFC 7845.
- Video:
- H.265/HEVC: Fix parsing SPS short and long term reference picture info.
- Text:
- CEA-608: Change cue truncation logic to only consider visible text. Previously indent and tab offset were included when limiting the cue length to 32 characters (which was technically correct by the spec) (#11019).
- IMA extension:
- Bump IMA SDK version to 3.30.3.
- Session:
- Add custom layout to the state of the controller and provide a getter to
access it. When the custom layout changes,
MediaController.Listener.onCustomLayoutChanged
is called. Apps that want to send different custom layouts to different Media3 controller can do this inMediaSession.Callback.onConnect
by using anAcceptedResultBuilder
to make sure the custom layout is available to the controller when connection completes. - Fix cases where
MediaLibraryServiceLegacyStub
sent an error to aResult
that didn't support this which produced anUnsupportedOperationException
(#78). - Fix the way
PlayerWrapper
creates aVolumeProviderCompat
by determiningvolumeControlType
through both legacy commands (COMMAND_ADJUST_DEVICE_VOLUME
andCOMMAND_SET_DEVICE_VOLUME
) and new commands (COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS
andCOMMAND_SET_DEVICE_VOLUME_WITH_FLAGS
) (#554).
- Add custom layout to the state of the controller and provide a getter to
access it. When the custom layout changes,
Version 1.1.0
July 5, 2023
- Common Library:
- Add suppression reason for unsuitable audio route and play when ready change reason for suppressed too long. (#15).
- Add commands to Player:
COMMAND_GET_METADATA
COMMAND_SET_PLAYLIST_METADATA
COMMAND_SET_DEVICE_VOLUME_WITH_FLAGS
COMMAND_ADJUST_DEVICE_VOLUME_WITH_FLAGS
- Add overloaded methods to Player which allow users to specify volume
flags:
void setDeviceVolume(int, int)
void increaseDeviceVolume(int)
void decreaseDeviceVolume(int)
void setDeviceMuted(boolean, int)
- Add
Builder
forDeviceInfo
and deprecate existing constructor. - Add
DeviceInfo.routingControllerId
to specify the routing controller ID for remote playbacks. - Add
Player.replaceMediaItem(s)
as a shortcut to adding and removing items at the same position (#8046).
- ExoPlayer:
- Allow ExoPlayer to have control of device volume methods only if
explicitly opted in. Use
ExoPlayer.Builder.setDeviceVolumeControlEnabled
to have access to:getDeviceVolume()
isDeviceMuted()
setDeviceVolume(int)
andsetDeviceVolume(int, int)
increaseDeviceVolume(int)
andincreaseDeviceVolume(int, int)
decreaseDeviceVolume(int)
anddecreaseDeviceVolume(int, int)
- Add
FilteringMediaSource
that allows to filter available track types from aMediaSource
. - Add support for including Common Media Client Data (CMCD) in the
outgoing requests of adaptive streaming formats DASH, HLS, and
SmoothStreaming. The following fields,
br
,bl
,cid
,rtp
, andsid
, have been incorporated (#8699). API structure and API methods:- CMCD logging is disabled by default, use
MediaSource.Factory.setCmcdConfigurationFactory(CmcdConfiguration.Factory cmcdConfigurationFactory)
to enable it. - All keys are enabled by default, override
CmcdConfiguration.RequestConfig.isKeyAllowed(String key)
to filter out which keys are logged. - Override
CmcdConfiguration.RequestConfig.getCustomData()
to enable custom key logging.
- CMCD logging is disabled by default, use
- Add additional action to manifest of main demo to make it easier to
start the demo app with a custom
*.exolist.json
file (#439). - Add
ExoPlayer.setVideoEffects()
for usingEffect
during video playback. - Update
SampleQueue
to storesourceId
as along
rather than anint
. This changes the signatures of public methodsSampleQueue.sourceId
andSampleQueue.peekSourceId
. - Add parameters to
LoadControl
methodsshouldStartPlayback
andonTracksSelected
that allow associating these methods with the relevantMediaPeriod
. - Change signature of
ServerSideAdInsertionMediaSource.setAdPlaybackStates(Map<Object, AdPlaybackState>)
by adding a timeline parameter that contains the periods with the UIDs used as keys in the map. This is required to avoid concurrency issues with multi-period live streams. - Deprecate
EventDispatcher.withParameters(int windowIndex, @Nullable MediaPeriodId mediaPeriodId, long mediaTimeOffsetMs)
andBaseMediaSource.createEventDispatcher(..., long mediaTimeOffsetMs)
. The variant of the methods without themediaTimeOffsetUs
can be called instead. Note that even for the deprecated variants, the offset is not anymore added tostartTimeUs
andendTimeUs
of theMediaLoadData
objects that are dispatched by the dispatcher. - Rename
ExoTrackSelection.blacklist
toexcludeTrack
andisBlacklisted
toisTrackExcluded
. - Fix inconsistent behavior between
ExoPlayer.setMediaItem(s)
andaddMediaItem(s)
when called on an empty playlist.
- Allow ExoPlayer to have control of device volume methods only if
explicitly opted in. Use
- Transformer:
- Remove
Transformer.Builder.setMediaSourceFactory(MediaSource.Factory)
. UseExoPlayerAssetLoader.Factory(MediaSource.Factory)
andTransformer.Builder.setAssetLoaderFactory(AssetLoader.Factory)
instead. - Remove
Transformer.startTransformation(MediaItem, ParcelFileDescriptor)
. - Fix a bug where transformation could get stuck (leading to muxer timeout) if the end of the video stream was signaled at the moment when an input frame was pending processing.
- Query codecs via
MediaCodecList
instead of usingfindDecoder/EncoderForFormat
utilities, to expand support. - Remove B-frame configuration in
DefaultEncoderFactory
because it doesn't work on some devices.
- Remove
- Track selection:
- Add
DefaultTrackSelector.Parameters.allowInvalidateSelectionsForRendererCapabilitiesChange
which is disabled by default. When enabled, theDefaultTrackSelector
will trigger a new track selection when the renderer capabilities changed.
- Add
- Extractors:
- Audio:
- Fix bug where some playbacks fail when tunneling is enabled and
AudioProcessors
are active, e.g. for gapless trimming (#10847). - Encapsulate Opus frames in Ogg packets in direct playbacks (offload).
- Extrapolate current position during sleep with offload scheduling.
- Add
Renderer.release()
andAudioSink.release()
for releasing the resources at the end of player's lifecycle. - Listen to audio capabilities changes in
DefaultAudioSink
. Add a required parametercontext
in the constructor ofDefaultAudioSink
, with which theDefaultAudioSink
will register as the listener to theAudioCapabilitiesReceiver
and update itsaudioCapabilities
property when informed with a capabilities change. - Propagate audio capabilities changes via a new event
onAudioCapabilitiesChanged
inAudioSink.Listener
interface, and a new interfaceRendererCapabilities.Listener
which triggersonRendererCapabilitiesChanged
events. - Add
ChannelMixingAudioProcessor
for applying scaling/mixing to audio channels. - Add new int value
DISCARD_REASON_AUDIO_BYPASS_POSSIBLE
toDecoderDiscardReasons
to discard audio decoder when bypass mode is possible after audio capabilities change. - Add direct playback support for DTS Express and DTS:X (#335).
- Fix bug where some playbacks fail when tunneling is enabled and
- Video:
- Make
MediaCodecVideoRenderer
report aVideoSize
with a width and height of 0 when the renderer is disabled.Player.Listener.onVideoSizeChanged
is called accordingly whenPlayer.getVideoSize()
changes. With this change, ExoPlayer's video size withMediaCodecVideoRenderer
has a width and height of 0 whenPlayer.getCurrentTracks
does not support video, or the size of the supported video track is not yet determined.
- Make
- DRM:
- Reduce the visibility of several internal-only methods on
DefaultDrmSession
that aren't expected to be called from outside the DRM package:void onMediaDrmEvent(int)
void provision()
void onProvisionCompleted()
onProvisionError(Exception, boolean)
- Reduce the visibility of several internal-only methods on
- Muxer:
- Add a new muxer library which can be used to create an MP4 container file.
- IMA extension:
- Enable multi-period live DASH streams for DAI. Please note that the current implementation does not yet support seeking in live streams (#10912).
- Fix a bug where a new ad group is inserted in live streams because the calculated content position in consecutive timelines varies slightly.
- Session:
- Add helper method
MediaSession.getControllerForCurrentRequest
to obtain information about the controller that is currently calling aPlayer
method. - Add
androidx.media3.session.MediaButtonReceiver
to enable apps to implement playback resumption with media button events sent by, for example, a Bluetooth headset (#167). - Add default implementation to
MediaSession.Callback.onAddMediaItems
to allow requestedMediaItems
to be passed ontoPlayer
if they haveLocalConfiguration
(e.g. URI) (#282). - Add "seek to previous" and "seek to next" command buttons on compact media notification view by default for Android 12 and below (#410).
- Add default implementation to
MediaSession.Callback.onAddMediaItems
to allow requestedMediaItems
to be passed ontoPlayer
if they haveLocalConfiguration
(e.g. URI) (#282). - Add "seek to previous" and "seek to next" command buttons on compact media notification view by default for Android 12 and below (#410).
- Add helper method
- UI:
- Add Util methods
shouldShowPlayButton
andhandlePlayPauseButtonAction
to write custom UI elements with a play/pause button.
- Add Util methods
- RTSP Extension:
- DASH Extension:
- Remove the media time offset from
MediaLoadData.startTimeMs
andMediaLoadData.endTimeMs
for multi period DASH streams. - Fix a bug where re-preparing a multi-period live Dash media source
produced a
IndexOutOfBoundsException
(#10838).
- Remove the media time offset from
- HLS Extension:
- Add
HlsMediaSource.Factory.setTimestampAdjusterInitializationTimeoutMs(long)
to set a timeout for the loading thread to wait for theTimestampAdjuster
to initialize. If the initialization doesn't complete before the timeout, aPlaybackException
is thrown to avoid the playback endless stalling. The timeout is set to zero by default (#323).
- Add
- Test Utilities:
- Check for URI scheme case insensitivity in
DataSourceContractTest
.
- Check for URI scheme case insensitivity in
- Remove deprecated symbols:
- Remove
DefaultAudioSink
constructors, useDefaultAudioSink.Builder
instead. - Remove
HlsMasterPlaylist
, useHlsMultivariantPlaylist
instead. - Remove
Player.stop(boolean)
. UsePlayer.stop()
andPlayer.clearMediaItems()
(ifreset
istrue
) instead. - Remove two deprecated
SimpleCache
constructors, use a non-deprecated constructor that takes aDatabaseProvider
instead for better performance. - Remove
DefaultBandwidthMeter
constructor, useDefaultBandwidthMeter.Builder
instead. - Remove
DefaultDrmSessionManager
constructors, useDefaultDrmSessionManager.Builder
instead. - Remove two deprecated
HttpDataSource.InvalidResponseCodeException
constructors, use a non-deprecated constructor that accepts additional fields(cause
,responseBody
) to enhance error logging. - Remove
DownloadHelper.forProgressive
,DownloadHelper.forHls
,DownloadHelper.forDash
, andDownloadHelper.forSmoothStreaming
, useDownloadHelper.forMediaItem
instead. - Remove deprecated
DownloadService
constructor, use a non deprecated constructor that includes the option to provide achannelDescriptionResourceId
parameter. - Remove deprecated String constants for Charsets (
ASCII_NAME
,UTF8_NAME
,ISO88591_NAME
,UTF16_NAME
andUTF16LE_NAME
), use Kotlin Charsets from thekotlin.text
package, thejava.nio.charset.StandardCharsets
or thecom.google.common.base.Charsets
instead. - Remove deprecated
WorkManagerScheduler
constructor, use a non deprecated constructor that includes the option to provide aContext
parameter instead. - Remove the deprecated methods
createVideoSampleFormat
,createAudioSampleFormat
,createContainerFormat
, andcreateSampleFormat
, which were used to instantiate theFormat
class. Instead useFormat.Builder
for creating instances ofFormat
. - Remove the deprecated methods
copyWithMaxInputSize
,copyWithSubsampleOffsetUs
,copyWithLabel
,copyWithManifestFormatInfo
,copyWithGaplessInfo
,copyWithFrameRate
,copyWithDrmInitData
,copyWithMetadata
,copyWithBitrate
andcopyWithVideoSize
, useFormat.buildUpon()
and setter methods instead. - Remove deprecated
ExoPlayer.retry()
, useprepare()
instead. - Remove deprecated zero-arg
DefaultTrackSelector
constructor, useDefaultTrackSelector(Context)
instead. - Remove deprecated
OfflineLicenseHelper
constructor, useOfflineLicenseHelper(DefaultDrmSessionManager, DrmSessionEventListener.EventDispatcher)
instead. - Remove deprecated
DownloadManager
constructor, use the constructor that takes anExecutor
instead. - Remove deprecated
Cue
constructors, useCue.Builder
instead. - Remove deprecated
OfflineLicenseHelper
constructor, useOfflineLicenseHelper(DefaultDrmSessionManager, DrmSessionEventListener.EventDispatcher)
instead. - Remove four deprecated
AnalyticsListener
methods:onDecoderEnabled
, useonAudioEnabled
and/oronVideoEnabled
instead.onDecoderInitialized
, useonAudioDecoderInitialized
and/oronVideoDecoderInitialized
instead.onDecoderInputFormatChanged
, useonAudioInputFormatChanged
and/oronVideoInputFormatChanged
instead.onDecoderDisabled
, useonAudioDisabled
and/oronVideoDisabled
instead.
- Remove the deprecated
Player.Listener.onSeekProcessed
andAnalyticsListener.onSeekProcessed
, useonPositionDiscontinuity
withDISCONTINUITY_REASON_SEEK
instead. - Remove
ExoPlayer.setHandleWakeLock(boolean)
, usesetWakeMode(int)
instead. - Remove deprecated
DefaultLoadControl.Builder.createDefaultLoadControl()
, usebuild()
instead. - Remove deprecated
MediaItem.PlaybackProperties
, useMediaItem.LocalConfiguration
instead. Deprecated fieldMediaItem.playbackProperties
is now of typeMediaItem.LocalConfiguration
.
- Remove
Version 1.1.0-rc01
June 21, 2023
Use the 1.1.0 stable version.
Version 1.1.0-beta01
June 7, 2023
Use the 1.1.0 stable version.
Version 1.1.0-alpha01
May 10, 2023
Use the 1.1.0 stable version.
Version 1.0.0
Version 1.0.2
May 18, 2023
androidx.media3:media3-*:1.0.2
is released.
Version 1.0.2 contains these commits.
This release corresponds to the ExoPlayer 2.18.7 release.
This release contains the following changes since the 1.0.1 release:
- Core library:
- Add
Buffer.isLastSample()
that denotes ifBuffer
contains flagC.BUFFER_FLAG_LAST_SAMPLE
. - Fix issue where last frame may not be rendered if the last sample with frames is dequeued without reading the 'end of stream' sample. (#11079).
- Add
- Extractors:
- Fix parsing of H.265 SPS in MPEG-TS files by re-using the parsing logic already used by RTSP and MP4 extractors (#303).
- Text:
- SSA: Add support for UTF-16 files if they start with a byte order mark (#319).
- Session:
- Fix issue where
MediaController
doesn't update its available commands when connected to a legacyMediaSessionCompat
that updates its actions. - Fix bug that prevented the
MediaLibraryService
from returning null for a call from System UI toCallback.onGetLibraryRoot
withparams.isRecent == true
on API 30 (#355). - Fix memory leak of
MediaSessionService
orMediaLibraryService
(#346). - Fix bug where a combined
Timeline
and position update in aMediaSession
may cause aMediaController
to throw anIllegalStateException
.
- Fix issue where
Version 1.0.1
April 18, 2023
androidx.media3:media3-*:1.0.1
is released.
Version 1.0.1 contains these commits.
This release corresponds to the ExoPlayer 2.18.6 release.
- Core library:
- Reset target live stream override when seeking to default position (#11051).
- Fix bug where empty sample streams in the media could cause playback to be stuck.
- Session:
- Fix bug where multiple identical queue items published by a legacy
MediaSessionCompat
result in an exception inMediaController
(#290). - Add missing forwarding of
MediaSession.broadcastCustomCommand
to the legacyMediaControllerCompat.Callback.onSessionEvent
(#293). - Fix bug where calling
MediaSession.setPlayer
doesn't update the available commands. - Fix issue that
TrackSelectionOverride
instances sent from aMediaController
are ignored if they reference a group withFormat.metadata
(#296). - Fix issue where
Player.COMMAND_GET_CURRENT_MEDIA_ITEM
needs to be available to access metadata via the legacyMediaSessionCompat
. - Fix issue where
MediaSession
instances on a background thread cause crashes when used inMediaSessionService
(#318). - Fix issue where a media button receiver was declared by the library without the app having intended this (#314).
- Fix bug where multiple identical queue items published by a legacy
- DASH:
- Fix handling of empty segment timelines (#11014).
- RTSP:
- Retry with TCP if RTSP Setup with UDP fails with RTSP Error 461 UnsupportedTransport (#11069).
Version 1.0.0
March 22, 2023
androidx.media3:media3-*:1.0.0
is released.
Version 1.0.0 contains these commits.
This release corresponds to the ExoPlayer 2.18.5 release.
There are no changes since 1.0.0-rc02.
Version 1.0.0-rc02
March 2, 2023
androidx.media3:media3-*:1.0.0-rc02
is released.
Version 1.0.0-rc02 contains these commits.
This release corresponds to the ExoPlayer 2.18.4 release.
- Core library:
- Downloads:
- Make the maximum difference of the start time of two segments to be
merged configurable in
SegmentDownloader
and subclasses (#248).
- Make the maximum difference of the start time of two segments to be
merged configurable in
- Audio:
- Video:
- Map HEVC HDR10 format to
HEVCProfileMain10HDR10
instead ofHEVCProfileMain10
. - Add workaround for a device issue on Chromecast with Google TV and Lenovo M10 FHD Plus that causes 60fps AVC streams to be marked as unsupported (#10898).
- Fix frame release performance issues when playing media with a frame rate far higher than the screen refresh rate.
- Map HEVC HDR10 format to
- Cast:
- Fix transient
STATE_IDLE
when transitioning between media items (#245).
- Fix transient
- RTSP:
- Catch the IllegalArgumentException thrown in parsing of invalid RTSP Describe response messages (#10971).
- Session:
- Fix a bug where notification play/pause button doesn't update with player state (#192).
- IMA extension:
- Fix a bug which prevented DAI streams without any ads from starting
because the first (and in the case without ads the only)
LOADED
event wasn't received.
- Fix a bug which prevented DAI streams without any ads from starting
because the first (and in the case without ads the only)
Version 1.0.0-rc01
February 16, 2023
androidx.media3:media3-*:1.0.0-rc01
is released.
Version 1.0.0-rc01 contains these commits.
This release corresponds to the ExoPlayer 2.18.3 release.
- Core library:
- Tweak the renderer's decoder ordering logic to uphold the
MediaCodecSelector
's preferences, even if a decoder reports it may not be able to play the media performantly. For example with default selector, hardware decoder with only functional support will be preferred over software decoder that fully supports the format (#10604). - Add
ExoPlayer.Builder.setPlaybackLooper
that sets a pre-existing playback thread for a new ExoPlayer instance. - Allow download manager helpers to be cleared (#10776).
- Add parameter to
BasePlayer.seekTo
to also indicate the command used for seeking. - Use theme when loading drawables on API 21+ (#220).
- Add
ConcatenatingMediaSource2
that allows combining multiple media items into a single window (#247).
- Tweak the renderer's decoder ordering logic to uphold the
- Extractors:
- Throw a
ParserException
instead of aNullPointerException
if the sample table (stbl) is missing a required sample description (stsd) when parsing trak atoms. - Correctly skip samples when seeking directly to a sync frame in fMP4 (#10941).
- Throw a
- Audio:
- Use the compressed audio format bitrate to calculate the min buffer size
for
AudioTrack
in direct playbacks (passthrough).
- Use the compressed audio format bitrate to calculate the min buffer size
for
- Text:
- Fix
TextRenderer
passing an invalid (negative) index toSubtitle.getEventTime
if a subtitle file contains no cues. - SubRip: Add support for UTF-16 files if they start with a byte order mark.
- Fix
- Metadata:
- Parse multiple null-separated values from ID3 frames, as permitted by ID3 v2.4.
- Add
MediaMetadata.mediaType
to denote the type of content or the type of folder described by the metadata. - Add
MediaMetadata.isBrowsable
as a replacement forMediaMetadata.folderType
. The folder type will be deprecated in the next release.
- DASH:
- Add full parsing for image adaptation sets, including tile counts (#3752).
- UI:
- Session:
- Add abstract
SimpleBasePlayer
to help implement thePlayer
interface for custom players. - Add helper method to convert platform session token to Media3
SessionToken
(#171). - Use
onMediaMetadataChanged
to trigger updates of the platform media session (#219). - Add the media session as an argument of
getMediaButtons()
of theDefaultMediaNotificationProvider
and use immutable lists for clarity (#216). - Add
onSetMediaItems
callback listener to provide means to modify/setMediaItem
list, starting index and position by session before setting onto Player (#156). - Avoid double tap detection for non-Bluetooth media button events (#233).
- Make
QueueTimeline
more robust in case of a shady legacy session state (#241).
- Add abstract
- Metadata:
- Parse multiple null-separated values from ID3 frames, as permitted by ID3 v2.4.
- Add
MediaMetadata.mediaType
to denote the type of content or the type of folder described by the metadata. - Add
MediaMetadata.isBrowsable
as a replacement forMediaMetadata.folderType
. The folder type will be deprecated in the next release.
- Cast extension:
- Bump Cast SDK version to 21.2.0.
- IMA extension:
- Remove player listener of the
ImaServerSideAdInsertionMediaSource
on the application thread to avoid threading issues. - Add a property
focusSkipButtonWhenAvailable
to theImaServerSideAdInsertionMediaSource.AdsLoader.Builder
to request focusing the skip button on TV devices and set it to true by default. - Add a method
focusSkipButton()
to theImaServerSideAdInsertionMediaSource.AdsLoader
to programmatically request to focus the skip button. - Bump IMA SDK version to 3.29.0.
- Remove player listener of the
- Demo app:
- Request notification permission for download notifications at runtime (#10884).
Version 1.0.0-beta03
November 22, 2022
androidx.media3:media3-*:1.0.0-beta03
is released.
Version 1.0.0-beta03 contains these commits.
This release corresponds to the ExoPlayer 2.18.2 release.
- Core library:
- Add
ExoPlayer.isTunnelingEnabled
to check if tunneling is enabled for the currently selected tracks (#2518). - Add
WrappingMediaSource
to simplify wrapping a singleMediaSource
(#7279). - Discard back buffer before playback gets stuck due to insufficient available memory.
- Close the Tracing "doSomeWork" block when offload is enabled.
- Fix session tracking problem with fast seeks in
PlaybackStatsListener
(#180). - Send missing
onMediaItemTransition
callback when callingseekToNext
orseekToPrevious
in a single-item playlist (#10667). - Add
Player.getSurfaceSize
that returns the size of the surface on which the video is rendered. - Fix bug where removing listeners during the player release can cause an
IllegalStateException
(#10758).
- Add
- Build:
- Enforce minimum
compileSdkVersion
to avoid compilation errors (#10684). - Avoid publishing block when included in another gradle build.
- Enforce minimum
- Track selection:
- Prefer other tracks to Dolby Vision if display does not support it. (#8944).
- Downloads:
- Video:
- Try alternative decoder for Dolby Vision if display does not support it. (#9794).
- Audio:
- Use
SingleThreadExecutor
for releasingAudioTrack
instances to avoid OutOfMemory errors when releasing multiple players at the same time (#10057). - Adds
AudioOffloadListener.onExperimentalOffloadedPlayback
for the AudioTrack offload state. (#134). - Make
AudioTrackBufferSizeProvider
a public interface. - Add
ExoPlayer.setPreferredAudioDevice
to set the preferred audio output device (#135). - Rename
androidx.media3.exoplayer.audio.AudioProcessor
toandroidx.media3.common.audio.AudioProcessor
. - Map 8-channel and 12-channel audio to the 7.1 and 7.1.4 channel masks respectively on all Android versions (#10701).
- Use
- Metadata:
MetadataRenderer
can now be configured to render metadata as soon as they are available. Create an instance withMetadataRenderer(MetadataOutput, Looper, MetadataDecoderFactory, boolean)
to specify whether the renderer will output metadata early or in sync with the player position.
- DRM:
- Work around a bug in the Android 13 ClearKey implementation that returns a non-empty but invalid license URL.
- Fix
setMediaDrmSession failed: session not opened
error when switching between DRM schemes in a playlist (e.g. Widevine to ClearKey).
- Text:
- CEA-608: Ensure service switch commands on field 2 are handled correctly (#10666).
- DASH:
- Parse
EventStream.presentationTimeOffset
from manifests (#10460).
- Parse
- UI:
- Use current overrides of the player as preset in
TrackSelectionDialogBuilder
(#10429).
- Use current overrides of the player as preset in
- Session:
- Ensure commands are always executed in the correct order even if some require asynchronous resolution (#85).
- Add
DefaultMediaNotificationProvider.Builder
to buildDefaultMediaNotificationProvider
instances. The builder can configure the notification ID, the notification channel ID and the notification channel name used by the provider. Also, add methodDefaultMediaNotificationProvider.setSmallIcon(int)
to set the notifications small icon. (#104). - Ensure commands sent before
MediaController.release()
are not dropped (#99). SimpleBitmapLoader
can load bitmap fromfile://
URIs (#108).- Fix assertion that prevents
MediaController
to seek over an ad in a period (#122). - When playback ends, the
MediaSessionService
is stopped from the foreground and a notification is shown to restart playback of the last played media item (#112). - Don't start a foreground service with a pending intent for pause (#167).
- Manually hide the 'badge' associated with the notification created by
DefaultNotificationProvider
on API 26 and API 27 (the badge is automatically hidden on API 28+) (#131). - Fix bug where a second binder connection from a legacy MediaSession to a Media3 MediaController causes IllegalStateExceptions (#49).
- RTSP:
- IMA:
- Add timeout for loading ad information to handle cases where the IMA SDK gets stuck loading an ad (#10510).
- Prevent skipping mid-roll ads when seeking to the end of the content (#10685).
- Correctly calculate window duration for live streams with server-side inserted ads, for example IMA DAI (#10764).
- FFmpeg extension:
- Add newly required flags to link FFmpeg libraries with NDK 23.1.7779620 and above (#9933).
- AV1 extension:
- Update CMake version to avoid incompatibilities with the latest Android Studio releases (#9933).
- Cast extension:
- Implement
getDeviceInfo()
to be able to identifyCastPlayer
when controlling playback with aMediaController
(#142).
- Implement
- Transformer:
- Add muxer watchdog timer to detect when generating an output sample is too slow.
- Remove deprecated symbols:
- Remove
Transformer.Builder.setOutputMimeType(String)
. This feature has been removed. The MIME type will always be MP4 when the default muxer is used.
- Remove
Version 1.0.0-beta02
July 21, 2022
androidx.media3:media3-*:1.0.0-beta02
is released.
Version 1.0.0-beta02 contains these commits.
This release corresponds to the ExoPlayer 2.18.1 release.
- Core library:
- Ensure that changing the
ShuffleOrder
withExoPlayer.setShuffleOrder
results in a call toPlayer.Listener#onTimelineChanged
withreason=Player.TIMELINE_CHANGE_REASON_PLAYLIST_CHANGED
(#9889). - For progressive media, only include selected tracks in buffered position (#10361).
- Allow custom logger for all ExoPlayer log output (#9752).
- Fix implementation of
setDataSourceFactory
inDefaultMediaSourceFactory
, which was non-functional in some cases (#116).
- Ensure that changing the
- Extractors:
- DASH:
- Parse ClearKey license URL from manifests (#10246).
- UI:
- Ensure TalkBack announces the currently active speed option in the playback controls menu (#10298).
- RTSP:
- Add VP8 fragmented packet handling (#110).
- Leanback extension:
- Listen to
playWhenReady
changes inLeanbackAdapter
(10420).
- Listen to
- Cast:
Version 1.0.0-beta01
June 16, 2022
androidx.media3:media3-*:1.0.0-beta01
is released.
Version 1.0.0-beta01 contains these commits.
This corresponds to the ExoPlayer 2.18.0 release.
- Core library:
- Enable support for Android platform diagnostics via
MediaMetricsManager
. ExoPlayer will forward playback events and performance data to the platform, which helps to provide system performance and debugging information on the device. This data may also be collected by Google if sharing usage and diagnostics data is enabled by the user of the device. Apps can opt-out of contributing to platform diagnostics for ExoPlayer withExoPlayer.Builder.setUsePlatformDiagnostics(false)
. - Fix bug that tracks are reset too often when using
MergingMediaSource
, for example when side-loading subtitles and changing the selected subtitle mid-playback (#10248). - Stop detecting 5G-NSA network type on API 29 and 30. These playbacks will assume a 4G network.
- Disallow passing
null
toMediaSource.Factory.setDrmSessionManagerProvider
andMediaSource.Factory.setLoadErrorHandlingPolicy
. Instances ofDefaultDrmSessionManagerProvider
andDefaultLoadErrorHandlingPolicy
can be passed explicitly if required. - Add
MediaItem.RequestMetadata
to represent metadata needed to play media when the exactLocalConfiguration
is not known. Also removeMediaMetadata.mediaUrl
as this is now included inRequestMetadata
. - Add
Player.Command.COMMAND_SET_MEDIA_ITEM
to enable players to allow setting a single item.
- Enable support for Android platform diagnostics via
- Track selection:
- Flatten
TrackSelectionOverrides
class intoTrackSelectionParameters
, and promoteTrackSelectionOverride
to a top level class. - Rename
TracksInfo
toTracks
andTracksInfo.TrackGroupInfo
toTracks.Group
.Player.getCurrentTracksInfo
andPlayer.Listener.onTracksInfoChanged
have also been renamed toPlayer.getCurrentTracks
andPlayer.Listener.onTracksChanged
. This includes 'un-deprecating' thePlayer.Listener.onTracksChanged
method name, but with different parameter types. - Change
DefaultTrackSelector.buildUponParameters
andDefaultTrackSelector.Parameters.buildUpon
to returnDefaultTrackSelector.Parameters.Builder
instead of the deprecatedDefaultTrackSelector.ParametersBuilder
. - Add
DefaultTrackSelector.Parameters.constrainAudioChannelCountToDeviceCapabilities
which is enabled by default. When enabled, theDefaultTrackSelector
will prefer audio tracks whose channel count does not exceed the device output capabilities. On handheld devices, theDefaultTrackSelector
will prefer stereo/mono over multichannel audio formats, unless the multichannel format can be Spatialized (Android 12L+) or is a Dolby surround sound format. In addition, on devices that support audio spatialization, theDefaultTrackSelector
will monitor for changes in the Spatializer properties and trigger a new track selection upon these. Devices with atelevision
UI mode are excluded from these constraints and the format with the highest channel count will be preferred. To enable this feature, theDefaultTrackSelector
instance must be constructed with aContext
.
- Flatten
- Video:
- Rename
DummySurface
toPlaceholderSurface
. - Add AV1 support to the
MediaCodecVideoRenderer.getCodecMaxInputSize
.
- Rename
- Audio:
- Use LG AC3 audio decoder advertising non-standard MIME type.
- Change the return type of
AudioAttributes.getAudioAttributesV21()
fromandroid.media.AudioAttributes
to a newAudioAttributesV21
wrapper class, to prevent slow ART verification on API < 21. - Query the platform (API 29+) or assume the audio encoding channel count for audio passthrough when the format audio channel count is unset, which occurs with HLS chunkless preparation (10204).
- Configure
AudioTrack
with channel maskAudioFormat.CHANNEL_OUT_7POINT1POINT4
if the decoder outputs 12 channel PCM audio (#10322.
- DRM
- Ensure the DRM session is always correctly updated when seeking immediately after a format change (10274).
- Text:
- Change
Player.getCurrentCues()
to returnCueGroup
instead ofList<Cue>
. - SSA: Support
OutlineColour
style setting whenBorderStyle == 3
(i.e.OutlineColour
sets the background of the cue) (#8435). - CEA-708: Parse data into multiple service blocks and ignore blocks not associated with the currently selected service number.
- Remove
RawCcExtractor
, which was only used to handle a Google-internal subtitle format.
- Change
- Extractors:
- UI:
- Fix delivery of events to
OnClickListener
s set onPlayerView
in the case thatuseController=false
(#9605). Also fix delivery of events toOnLongClickListener
for all view configurations. - Fix incorrectly treating a sequence of touch events that exit the bounds
of
PlayerView
beforeACTION_UP
as a click (#9861). - Fix
PlayerView
accessibility issue where tapping might toggle playback rather than hiding the controls (#8627). - Rewrite
TrackSelectionView
andTrackSelectionDialogBuilder
to work with thePlayer
interface rather thanExoPlayer
. This allows the views to be used with otherPlayer
implementations, and removes the dependency from the UI module to the ExoPlayer module. This is a breaking change. - Don't show forced text tracks in the
PlayerView
track selector, and keep a suitable forced text track selected if "None" is selected (#9432).
- Fix delivery of events to
- DASH:
- Parse channel count from DTS
AudioChannelConfiguration
elements. This re-enables audio passthrough for DTS streams (#10159). - Disallow passing
null
toDashMediaSource.Factory.setCompositeSequenceableLoaderFactory
. Instances ofDefaultCompositeSequenceableLoaderFactory
can be passed explicitly if required.
- Parse channel count from DTS
- HLS:
- Fallback to chunkful preparation if the playlist CODECS attribute does not contain the audio codec (#10065).
- Disallow passing
null
toHlsMediaSource.Factory.setCompositeSequenceableLoaderFactory
,HlsMediaSource.Factory.setPlaylistParserFactory
, andHlsMediaSource.Factory.setPlaylistTrackerFactory
. Instances ofDefaultCompositeSequenceableLoaderFactory
,DefaultHlsPlaylistParserFactory
, or a reference toDefaultHlsPlaylistTracker.FACTORY
can be passed explicitly if required.
- Smooth Streaming:
- Disallow passing
null
toSsMediaSource.Factory.setCompositeSequenceableLoaderFactory
. Instances ofDefaultCompositeSequenceableLoaderFactory
can be passed explicitly if required.
- Disallow passing
- RTSP:
- Add RTP reader for H263 (#63).
- Add RTP reader for MPEG4 (#35).
- Add RTP reader for HEVC (#36).
- Add RTP reader for AMR. Currently only mono-channel, non-interleaved AMR streams are supported. Compound AMR RTP payload is not supported. (#46)
- Add RTP reader for VP8 (#47).
- Add RTP reader for WAV (#56).
- Fix RTSP basic authorization header. (#9544).
- Stop checking mandatory SDP fields as ExoPlayer doesn't need them (#10049).
- Throw checked exception when parsing RTSP timing (#10165).
- Add RTP reader for VP9 (#47).
- Add RTP reader for OPUS (#53).
- Data sources:
- Rename
DummyDataSource
toPlaceholderDataSource
. - Workaround OkHttp interrupt handling.
- Rename
- Session:
- Replace
MediaSession.MediaItemFiller
withMediaSession.Callback.onAddMediaItems
to allow asynchronous resolution of requests. - Support
setMediaItems(s)
methods whenMediaController
connects to a legacy media session. - Remove
MediaController.setMediaUri
andMediaSession.Callback.onSetMediaUri
. The same functionality can be achieved by usingMediaController.setMediaItem
andMediaSession.Callback.onAddMediaItems
. - Forward legacy
MediaController
calls to play media toMediaSession.Callback.onAddMediaItems
instead ofonSetMediaUri
. - Add
MediaNotification.Provider
andDefaultMediaNotificationProvider
to provide customization of the notification. - Add
BitmapLoader
andSimpleBitmapLoader
for downloading artwork images. - Add
MediaSession.setCustomLayout()
to provide backwards compatibility with the legacy session. - Add
MediaSession.setSessionExtras()
to provide feature parity with legacy session. - Rename
MediaSession.MediaSessionCallback
toMediaSession.Callback
,MediaLibrarySession.MediaLibrarySessionCallback
toMediaLibrarySession.Callback
andMediaSession.Builder.setSessionCallback
tosetCallback
. - Fix NPE in
MediaControllerImplLegacy
(#59). - Update session position info on timeline change(#51).
- Fix NPE in
MediaControllerImplBase
after releasing controller (#74).
- Replace
- Ad playback / IMA:
- Decrease ad polling rate from every 100ms to every 200ms, to line up with Media Rating Council (MRC) recommendations.
- FFmpeg extension:
- Update CMake version to
3.21.0+
to avoid a CMake bug causing AndroidStudio's gradle sync to fail (#9933).
- Update CMake version to
- Remove deprecated symbols:
- Remove
Player.Listener.onTracksChanged(TrackGroupArray, TrackSelectionArray)
. UsePlayer.Listener.onTracksChanged(Tracks)
instead. - Remove
Player.getCurrentTrackGroups
andPlayer.getCurrentTrackSelections
. UsePlayer.getCurrentTracks
instead. You can also continue to useExoPlayer.getCurrentTrackGroups
andExoPlayer.getCurrentTrackSelections
, although these methods remain deprecated. - Remove
DownloadHelper
DEFAULT_TRACK_SELECTOR_PARAMETERS_WITHOUT_VIEWPORT
andDEFAULT_TRACK_SELECTOR_PARAMETERS
constants. UsegetDefaultTrackSelectorParameters(Context)
instead when possible, andDEFAULT_TRACK_SELECTOR_PARAMETERS_WITHOUT_CONTEXT
otherwise. - Remove constructor
DefaultTrackSelector(ExoTrackSelection.Factory)
. UseDefaultTrackSelector(Context, ExoTrackSelection.Factory)
instead. - Remove
Transformer.Builder.setContext
. TheContext
should be passed to theTransformer.Builder
constructor instead.
- Remove
Version 1.0.0-alpha03
March 14, 2022
androidx.media3:media3-*:1.0.0-alpha03
is released.
Version 1.0.0-alpha03 contains these commits.
This corresponds to the ExoPlayer 2.17.1 release.
- Audio:
- Fix error checking audio capabilities for Dolby Atmos (E-AC3-JOC) in HLS.
- Extractors:
- FMP4: Fix issue where emsg sample metadata could be output in the wrong order for streams containing both v0 and v1 emsg atoms (#9996).
- Text:
- Fix the interaction of
SingleSampleMediaSource.Factory.setTrackId
andMediaItem.SubtitleConfiguration.Builder.setId
to prioritise theSubtitleConfiguration
field and fall back to theFactory
value if it's not set (#10016).
- Fix the interaction of
- Ad playback:
- Fix audio underruns between ad periods in live HLS SSAI streams.
Version 1.0.0-alpha02
March 2, 2022
androidx.media3:media3-*:1.0.0-alpha02
is released.
Version 1.0.0-alpha02 contains these commits.
This corresponds to the ExoPlayer 2.17.0 release.
- Core Library:
- Add protected method
DefaultRenderersFactory.getCodecAdapterFactory()
so that subclasses ofDefaultRenderersFactory
that overridebuildVideoRenderers()
orbuildAudioRenderers()
can access the codec adapter factory and pass it toMediaCodecRenderer
instances they create. - Propagate ICY header fields
name
andgenre
toMediaMetadata.station
andMediaMetadata.genre
respectively so that they reach the app viaPlayer.Listener.onMediaMetadataChanged()
(#9677). - Remove null keys from
DefaultHttpDataSource#getResponseHeaders
. - Sleep and retry when creating a
MediaCodec
instance fails. This works around an issue that occurs on some devices when switching a surface from a secure codec to another codec (#8696). - Add
MediaCodecAdapter.getMetrics()
to allow users obtain metrics data fromMediaCodec
. (#9766). - Fix Maven dependency resolution (#8353).
- Disable automatic speed adjustment for live streams that neither have low-latency features nor a user request setting the speed (#9329).
- Rename
DecoderCounters#inputBufferCount
toqueuedInputBufferCount
. - Make
SimpleExoPlayer.renderers
private. Renderers can be accessed viaExoPlayer.getRenderer
. - Updated some
AnalyticsListener.EventFlags
constant values to match values inPlayer.EventFlags
. - Split
AnalyticsCollector
into an interface and default implementation to allow it to be stripped by R8 if an app doesn't need it.
- Add protected method
- Track selection:
- Support preferred video role flags in track selection (#9402).
- Update video track selection logic to take preferred MIME types and role flags into account when selecting multiple video tracks for adaptation (#9519).
- Update video and audio track selection logic to only choose formats for adaptive selections that have the same level of decoder and hardware support (#9565).
- Update video track selection logic to prefer more efficient codecs if multiple codecs are supported by primary, hardware-accelerated decoders (#4835).
- Prefer audio content preferences (for example, the "default" audio track or a track matching the system locale language) over technical track selection constraints (for example, preferred MIME type, or maximum channel count).
- Fix track selection issue where overriding one track group did not disable other track groups of the same type (#9675).
- Fix track selection issue where a mixture of non-empty and empty track overrides is not applied correctly (#9649).
- Prohibit duplicate
TrackGroup
s in aTrackGroupArray
.TrackGroup
s can always be made distinguishable by setting anid
in theTrackGroup
constructor. This fixes a crash when resuming playback after backgrounding the app with an active track override (#9718). - Amend logic in
AdaptiveTrackSelection
to allow a quality increase under sufficient network bandwidth even if playback is very close to the live edge (#9784).
- Video:
- Fix decoder fallback logic for Dolby Vision to use a compatible H264/H265 decoder if needed.
- Audio:
- Fix decoder fallback logic for Dolby Atmos (E-AC3-JOC) to use a compatible E-AC3 decoder if needed.
- Change
AudioCapabilities
APIs to require passing explicitlyAudioCapabilities.DEFAULT_AUDIO_CAPABILITIES
instead ofnull
. - Allow customization of the
AudioTrack
buffer size calculation by injecting anAudioTrackBufferSizeProvider
toDefaultAudioSink
. (#8891). - Retry
AudioTrack
creation if the requested buffer size was > 1MB. (#9712).
- Extractors:
- Text:
- Add a
MediaItem.SubtitleConfiguration.id
field which is propagated to theFormat.id
field of the subtitle track created from the configuration (#9673). - Add basic support for WebVTT subtitles in Matroska containers (#9886).
- Prevent
Cea708Decoder
from reading more than the declared size of a service block.
- Add a
- DRM:
- Remove
playbackLooper
fromDrmSessionManager.(pre)acquireSession
. When aDrmSessionManager
is used by an app in a customMediaSource
, theplaybackLooper
needs to be passed toDrmSessionManager.setPlayer
instead.
- Remove
- Ad playback / IMA:
- Add support for IMA Dynamic Ad Insertion (DAI) (#8213).
- Add a method to
AdPlaybackState
to allow resetting an ad group so that it can be played again (#9615). - Enforce playback speed of 1.0 during ad playback (#9018).
- Fix issue where an ad group that failed to load caused an immediate playback reset (#9929).
- UI:
- DASH:
- Add parsed essential and supplemental properties to the
Representation
(#9579). - Support the
forced-subtitle
track role (#9727). - Stop interpreting the
main
track role asC.SELECTION_FLAG_DEFAULT
. - Fix base URL exclusion logic for manifests that do not declare the DVB namespace (#9856).
- Support relative
MPD.Location
URLs (#9939).
- Add parsed essential and supplemental properties to the
- HLS:
- Correctly populate
Format.label
for audio only HLS streams (#9608). - Use chunkless preparation by default to improve start up time. If your
renditions contain muxed closed-caption tracks that are not declared
in the master playlist, you should add them to the master playlist to be
available for playback, or turn off chunkless preparation with
HlsMediaSource.Factory.setAllowChunklessPreparation(false)
. - Support key-frame accurate seeking in HLS (#2882).
- Correctly populate
- RTSP:
- Transformer:
- Increase required min API version to 21.
TransformationException
is now used to describe errors that occur during a transformation.- Add
TransformationRequest
for specifying the transformation options. - Allow multiple listeners to be registered.
- Fix Transformer being stuck when the codec output is partially read.
- Fix potential NPE in
Transformer.getProgress
when releasing the muxer throws. - Add a demo app for applying transformations.
- MediaSession extension:
- By default,
MediaSessionConnector
now clears the playlist on stop. Apps that want the playlist to be retained can callsetClearMediaItemsOnStop(false)
on the connector.
- By default,
- Cast extension:
- FFmpeg extension:
- Make
build_ffmpeg.sh
depend on LLVM's bin utils instead of GNU's (#9933).
- Make
- Android 12 compatibility:
- Upgrade the Cast extension to depend on
com.google.android.gms:play-services-cast-framework:20.1.0
. Earlier versions ofplay-services-cast-framework
are not compatible with apps targeting Android 12, and will crash with anIllegalArgumentException
when creatingPendingIntent
s (#9528).
- Upgrade the Cast extension to depend on
- Remove deprecated symbols:
- Remove
Player.EventListener
. UsePlayer.Listener
instead. - Remove
MediaSourceFactory#setDrmSessionManager
,MediaSourceFactory#setDrmHttpDataSourceFactory
, andMediaSourceFactory#setDrmUserAgent
. UseMediaSourceFactory#setDrmSessionManagerProvider
instead. - Remove
MediaSourceFactory#setStreamKeys
. UseMediaItem.Builder#setStreamKeys
instead. - Remove
MediaSourceFactory#createMediaSource(Uri)
. UseMediaSourceFactory#createMediaSource(MediaItem)
instead. - Remove
setTag
fromDashMediaSource
,HlsMediaSource
andSsMediaSource
. UseMediaItem.Builder#setTag
instead. - Remove
DashMediaSource#setLivePresentationDelayMs(long, boolean)
. UseMediaItem.Builder#setLiveConfiguration
andMediaItem.LiveConfiguration.Builder#setTargetOffsetMs
to override the manifest, orDashMediaSource#setFallbackTargetLiveOffsetMs
to provide a fallback value. - Remove
(Simple)ExoPlayer.setThrowsWhenUsingWrongThread
. Opting out of the thread enforcement is no longer possible. - Remove
ActionFile
andActionFileUpgradeUtil
. Use ExoPlayer 2.16.1 or before to useActionFileUpgradeUtil
to merge legacy action files intoDefaultDownloadIndex
. - Remove
ProgressiveMediaSource#setExtractorsFactory
. UseProgressiveMediaSource.Factory(DataSource.Factory, ExtractorsFactory)
constructor instead. - Remove
ProgressiveMediaSource.Factory#setTag
and, andProgressiveMediaSource.Factory#setCustomCacheKey
. UseMediaItem.Builder#setTag
andMediaItem.Builder#setCustomCacheKey
instead. - Remove
DefaultRenderersFactory(Context, @ExtensionRendererMode int)
andDefaultRenderersFactory(Context, @ExtensionRendererMode int, long)
constructors. Use theDefaultRenderersFactory(Context)
constructor,DefaultRenderersFactory#setExtensionRendererMode
, andDefaultRenderersFactory#setAllowedVideoJoiningTimeMs
instead. - Remove all public
CronetDataSource
constructors. UseCronetDataSource.Factory
instead.
- Remove
- Change the following
IntDefs
to@Target(TYPE_USE)
only. This may break the compilation of usages in Kotlin, which can be fixed by moving the annotation to annotate the type (Int
).@AacAudioObjectType
@Ac3Util.SyncFrameInfo.StreamType
@AdLoadException.Type
@AdtsExtractor.Flags
@AmrExtractor.Flags
@AspectRatioFrameLayout.ResizeMode
@AudioFocusManager.PlayerCommand
@AudioSink.SinkFormatSupport
@BinarySearchSeeker.TimestampSearchResult.Type
@BufferReplacementMode
@C.BufferFlags
@C.ColorRange
@C.ColorSpace
@C.ColorTransfer
@C.CryptoMode
@C.Encoding
@C.PcmEncoding
@C.Projection
@C.SelectionReason
@C.StereoMode
@C.VideoOutputMode
@CacheDataSource.Flags
@CaptionStyleCompat.EdgeType
@DataSpec.Flags
@DataSpec.HttpMethods
@DecoderDiscardReasons
@DecoderReuseResult
@DefaultAudioSink.OutputMode
@DefaultDrmSessionManager.Mode
@DefaultTrackSelector.SelectionEligibility
@DefaultTsPayloadReaderFactory.Flags
@EGLSurfaceTexture.SecureMode
@EbmlProcessor.ElementType
@ExoMediaDrm.KeyRequest.RequestType
@ExtensionRendererMode
@Extractor.ReadResult
@FileTypes.Type
@FlacExtractor.Flags
(incom.google.android.exoplayer2.ext.flac
package)@FlacExtractor.Flags
(incom.google.android.exoplayer2.extractor.flac
package)@FragmentedMp4Extractor.Flags
@HlsMediaPlaylist.PlaylistType
@HttpDataSourceException.Type
@IllegalClippingException.Reason
@IllegalMergeException.Reason
@LoadErrorHandlingPolicy.FallbackType
@MatroskaExtractor.Flags
@Mp3Extractor.Flags
@Mp4Extractor.Flags
@NotificationUtil.Importance
@PlaybackException.FieldNumber
@PlayerNotificationManager.Priority
@PlayerNotificationManager.Visibility
@PlayerView.ShowBuffering
@Renderer.State
@RendererCapabilities.AdaptiveSupport
@RendererCapabilities.Capabilities
@RendererCapabilities.DecoderSupport
@RendererCapabilities.FormatSupport
@RendererCapabilities.HardwareAccelerationSupport
@RendererCapabilities.TunnelingSupport
@SampleStream.ReadDataResult
@SampleStream.ReadFlags
@StyledPlayerView.ShowBuffering
@SubtitleView.ViewType
@TextAnnotation.Position
@TextEmphasisSpan.MarkFill
@TextEmphasisSpan.MarkShape
@Track.Transformation
@TrackOutput.SampleDataPart
@Transformer.ProgressState
@TsExtractor.Mode
@TsPayloadReader.Flags
@WebvttCssStyle.FontSizeUnit
Version 1.0.0-alpha01
October 27, 2021
androidx.media3:media3-*:1.0.0-alpha01
is released.
Version 1.0.0-alpha01 contains these commits.
New features
Media3 is the new home for media support libraries, including ExoPlayer. The first alpha contains early, functional implementations of libraries for implementing media use cases, including:
- ExoPlayer, an application-level media player for Android that is easy to customize and extend.
- Media session functionality, for exposing and controlling playbacks. This new
session module uses the same
Player
interface as ExoPlayer. - UI components for building media playback user interfaces.
- Modules wrapping functionality in other libraries for use with ExoPlayer, for example, ad insertion via the IMA SDK.
For more information, see the Media3 GitHub project.
ExoPlayer was previously hosted in a separate
ExoPlayer GitHub project. In Media3 its
package name is androidx.media3.exoplayer
. We plan to continue to maintain and
release the ExoPlayer GitHub project for a while to give apps time to migrate to
Media3. Media3 has replacements for all the ExoPlayer modules, except for the
legacy media2 and mediasession extensions, which are replaced by the new
media3-session
module. This provides direct integration between players and
media sessions without needing to use an adapter/connector class.