Release notes for the v2 version of the iOS SDK can be found [here](https://developer.bitmovin.com/playback/page/ios-sdk-v2-release-notes). --- ## 3.129.0 Released: 2026-10-23 **Fixed** - Playback pausing when leaving full screen with the System UI - Client-side ads failing to play while the System UI is in full screen - IMA VMAP pre-roll ad break not playing when joining live streams with a long DVR window **Changed** - The System UI now hides its playback controls while an ad plays in full screen. The exit-fullscreen control is unavailable until the ad ends. --- ## 3.128.0 Released: 2026-10-16 **Added** - [`AudioTrack.codec`]() and [`AudioTrack.channelCount`]() expose audio format metadata for HLS sources **Fixed** - Missing [`OfflineErrorEvent`]() when the download of an `OfflineSourceConfig` fails to start, for example because of an unreachable or invalid URL - Subtitle cues of the main content remaining visible during client-side ad breaks in UIs that render subtitles from cue events, including the Bitmovin Web UI's `buildSubtitleUI` **Changed** - Active subtitle cues of the main content now emit a [`CueExitEvent`]() when a client-side ad break starts, and a [`CueEnterEvent`]() again when it finishes, if they are still active. Integrations observing [`PlayerListener.onCueEnter(_:player:)`]() and [`PlayerListener.onCueExit(_:player:)`]() can therefore see a cue exit temporarily and enter more than once. - Updated Bitmovin Player Web UI to `4.23.0`. --- ## 3.127.0 Released: 2026-10-09 **Added** - [`LatencyMode`](), [`LatencyModeChangedEvent`](), and [`LatencyApi.currentMode`]() to report catch-up, fallback, idle, and suspended latency modes for live sources. **Fixed** - Setting [`Player.timeShift`]() to `0` during AirPlay not moving playback to the live edge --- ## 3.126.0 Released: 2026-10-02 **Added** - Subtitle cue enter and exit events are now emitted during BAM ad playback - Type-safe Swift ad triggering APIs, for example `AdItem(adSources: sources, trigger: .percentage(25))`: - [`AdItemTrigger`]() for pre-roll, post-roll, percentage-based, and time-based eligibility, plus experimental pause-triggered eligibility - [`AdItem.trigger`]() and [`AdItem.init(adSources:trigger:)`]() for configuring when an ad item becomes eligible - Experimental pause ads using static PNG or JPEG VAST non-linear creatives with [`AdSourceType.bitmovin`]() ad sources: - Schedule pause ads with [`AdItem(adSources: sources, trigger: .pause)`]() through [`AdvertisingApi.schedule(adItem:)`]() or [`AdvertisingConfig.schedule`](); in Objective-C use [`BMPAdItem`]()'s `pauseAdWithAdSources:` factory - Swift access requires `@_spi(ExperimentalApi) import BitmovinPlayerCore` - Eligible 1 second after confirmed content playback enters a paused state and displayed in the [`PlayerView`]() ad container or a custom container registered through [`AdvertisingApi.register(adContainer:)`]() - Dismissible through the UI or [`AdvertisingApi.skip()`](); seeking or time shifting dismisses a visible pause ad - Tapping a creative opens its VAST clickthrough URL on iOS; creative clickthrough is not supported on tvOS - Automatically suppressed during Cast, AirPlay, and Picture-in-Picture managed by [`PlayerView`](); app-managed Picture-in-Picture requires the app to prevent pause-ad presentation - Not shown during the System Player UI's AVKit fullscreen on iOS - VAST tracking for impressions, creative views, clicks, dismissal, view duration, unused creatives, wrappers, and errors - Pause ads are not supported on visionOS - Non-linear ad APIs: - [`NonLinearAd`]() as the shared base type for non-linear ads - `NonLinearAdStartedEvent`, `NonLinearAdFinishedEvent`, and `NonLinearAdSkippedEvent` to observe presentation lifecycle, sharing the `NonLinearAdEvent` base class - Swift access to the lifecycle events and listener callbacks requires `@_spi(ExperimentalApi) import BitmovinPlayerCore` **Fixed** - [`CustomMessageHandler.sendMessage(_:withData:)`]() corrupting or dropping messages containing quotes, backslashes, or control characters. Integrations that double-escape these values must remove that workaround. **Changed** - [`OverlayAd`]() now inherits from [`NonLinearAd`]() - Updated Bitmovin Player Web UI to `4.22.0`. **Deprecated** - [`AdItem.position`]() in Swift in favor of [`AdItem.trigger`]() --- ## 3.125.0 Released: 2026-09-25 **Added** - Allow custom Bitmovin Player Web UIs to read and update the native runtime bitrate limit via `getMaxSelectableBitrate()` and `setMaxSelectableBitrate(bitrate)`. - [`ThumbnailConfig`]() and [`PlayerConfig.thumbnailConfig`]() for configuring thumbnail rendering. - [`ThumbnailsApi.renderingMode`]() and [`ThumbnailConfig.renderingMode`]() to configure the thumbnail rendering mode. - [`ThumbnailRenderingMode.automatic`]() (default) renders using available media. - [`ThumbnailRenderingMode.trickPlay`]() requires trick-play support, such as HLS I-frame playlists. --- ## 3.124.0 Released: 2026-09-18 **Added** - [`DeficiencyData.logEntries`]() with [`DeficiencyLogEntry`]() details for each failed request, to identify which resource caused a playback failure. **Fixed** - HLS Interstitial resumption offsets were ignored when updated from zero, and updates to finished ad breaks could override newer breaks' resume targets. **Removed** - CocoaPods publishing for new Player releases. Use Swift Package Manager for new versions. See the [CocoaPods deprecation announcement](https://community.bitmovin.com/t/cocoapods-deprecation-notice/3864) for more details. --- ## 3.123.0 Released: 2026-09-12 **Added** - Serialization of `from` and `to` source configurations in `PlaylistTransition` events sent to the Bitmovin Web UI. - [`UserInterfaceApi.isFullscreenAvailable`]() to query fullscreen availability. **Fixed** - Incorrect ad counters in the Bitmovin Web UI, previously documented as a known issue in `3.122.0`. - Fullscreen toggle button in the Bitmovin Web UI overriding CSS display styles. **Changed** - Updated Bitmovin Player Web UI to `4.21.0`. **Removed** - Support for iOS 14 and tvOS 14. The minimum supported versions are now iOS 15.0 and tvOS 15.0 --- ## 3.122.0 Released: 2026-09-07 **Added** - [`TweaksConfig.includeMachineGeneratedSubtitles`]() to include machine-generated subtitles in the Player API on iOS 27, tvOS 27, and visionOS 27. - [`AdvertisingApi.activeAdBreak`]() to access the currently active ad break. - Support for ad counters and ad-break remaining time when using the Bitmovin Web UI. **Fixed** - Endless [`SubtitleChangedEvent`]()s on iOS 27, tvOS 27 or visionOS 27 after selecting a subtitle track. - Queued ad breaks disappearing from [`AdvertisingApi.schedule`]() before their playback starts. **Known Issues** - Ad counters in the Bitmovin Web UI can be incorrect for consecutive ad breaks scheduled at the same playback position when one break contains multiple ads or gains additional ads during playback. **Changed** - Updated Bitmovin Player Web UI to `4.20.1`. **Deprecated** - [`TweaksConfig.delayInitialSubtitleSelection`]() because initial subtitle selection is now coordinated automatically. --- ## 3.121.0 Released: 2026-08-28 **Added** - Support to enter Picture-in-Picture during ad playback using Bitmovin Advertising Module (BAM). **Fixed** - HLS variant playlist reload requests in a live stream could be misclassified as type `master` when playlist URL parameters change between requests. - A crash when rendering styled subtitles containing multi-code-unit Unicode characters, such as Arabic diacritics or emoji. **Changed** - `Xcode 26.6` and `Swift 5.10` or newer is required to integrate the SDK --- ## 3.120.0 Released: 2026-08-13 **Added** - Support for selecting ad subtitle tracks through the regular Player subtitle APIs in case Bitmovin Advertising Module (BAM) is used. --- ## 3.119.0 Released: 2026-08-04 **Added** - Experimental `Player.ssai` API, enabling integrations to register ad breaks stitched into SSAI streams and use the Player’s advertising API and events. --- ## 3.118.1 Released: 2026-07-31 **Fixed** - The Bitmovin Player Web UI could fail to render when [`BitmovinUserInterfaceConfig`]() values encoded in `uiConfig` contained URL-safe Base64 characters. - Configured [`playbackSpeed`]() not being applied when resuming playback in Picture-in-Picture. --- ## 3.118.0 Released: 2026-07-24 **Added** - [`VideoColorInfo`]() with [`DynamicRange`]() and [`VideoRange`]() to the [`VideoQuality`]() to identify HDR/SDR video qualities. **Changed** - Video quality related APIs ([`player.availableVideoQualities`](), [`player.videoPlaybackQuality`]() and [`player.videoDownloadQuality`]()) are now properly populated on iOS 15, tvOS 15 and visionOS 1 independently of [`TweaksConfig.isCustomHlsLoadingEnabled`](). - Player APIs related to loading or adding [`Source`]()s will result in a crash when called from a background thread. This is the first step towards the migration to full conformance with Swift 6 actor isolation. --- ## 3.117.0 Released: 2026-07-13 **Added** - Support for overriding our default VAST media file selection via [`BitmovinAdvertisingConfig.onSelectAdQuality`]() when using the Bitmovin Advertising Module (BAM). **Changed** - HLS Interstitial `ASSET-LIST` responses with HTTP 204 or an empty `ASSETS` array are now treated as valid and no longer trigger an [`AdErrorEvent`](). - XML CDATA content is now trimmed before being exposed by the XML parser. **Fixed** - VAST ad media file selection could skip HLS playlist MIME types and choose unsupported video MIME types when using the Bitmovin Advertising Module (BAM). --- ## 3.116.1 Released: 2026-07-03 **Fixed** - Potential crash when reparenting [`PlayerView`]() while IMA ad playback is scheduled. - Post-roll not playing with IMA when main content finishes before the ad manifest has loaded. --- ## 3.116.0 Released: 2026-06-29 **Added** - [`VideoPlayerView`]() view modifiers to dynamically control Picture-in-Picture mode in SwiftUI: - [`VideoPlayerView.isPictureInPictureEnabled`]() to enable/disable Picture-in-Picture mode - [`VideoPlayerView.isPictureInPictureAvailable`]() to reflect whether Picture-in-Picture mode is available - [`VideoPlayerView.isPictureInPictureActive`]() to enter/exit Picture-in-Picture mode - [`VideoPlayerView.showSkipControlsInPictureInPicture`]() to show/hide the skip controls in Picture-in-Picture mode - Support for accessing VAST `Extension` nodes via [`Ad.extensions`]() when using the Bitmovin Advertising Module (BAM). --- ## 3.115.0 Released: 2026-06-19 **Added** - Support for accessing the currently active ad via [`AdvertisingApi.activeAd`](). - [`VideoPlayerView.scalingMode`]() view modifier to dynamically update the scaling mode in SwiftUI. - Support for VAST fullscreen/exitFullscreen and playerExpand/playerCollapse tracking via [`Ad.expanded`]() and [`Ad.collapsed`]() when using the Bitmovin Advertising Module (BAM). - [`Player.nowPlaying`]() namespace of type [`NowPlayingApi`]() to access media controls related APIs. - [`NowPlayingApi.isEnabled`]() to dynamically enable or disable Bitmovin Player's Now Playing integration at runtime. - Support to play Ads in Picture-in-Picture on iOS/tvOS 15 and above, when using Bitmovin Advertising Module (BAM). - Support for preloading of ad manifests (VAST/VMAP) with IMA while another ad is already playing. **Removed** - `TweaksConfig.updatesNowPlayingInfoCenter`. Use [`PlayerConfig.nowPlayingConfig.isNowPlayingInfoEnabled`]() to enable Bitmovin Player's Now Playing integration. **Fixed** - Fixed typo in Now Playing metadata during ad playback: `Advertisment` is now correctly spelled `Advertisement`. - Seeking or time-shifting over HLS Interstitial with `X-RESUME-OFFSET` could resume main content before the user’s target position. - Multiple IMA ad scheduled at the same time, could interfere with each other and prevent later ad breaks from playing. **Known Issues** - Ads will play in the background instead of the Picture-in-Picture window when using Bitmovin Advertising Module (BAM) in combination with the System UI. --- ## 3.114.1 Released: 2026-05-28 **Fixed** - Main content could resume at the wrong position after HLS Interstitial ad breaks with `X-PLAYOUT-LIMIT`. --- ## 3.114.0 Released: 2026-05-19 **Added** - Warning logs when public [`Player`]() or [`Source`]() APIs are called from a background thread. - Publish API documentation as Markdown to make it easier for AI agents and other tools to access and process the SDK API reference. **Fixed** - Missing expected `SubtitleEnable`, `SubtitleDisable` and `SubtitleDisabled` events in the Bitmovin Player Web UI when changing subtitle tracks. - Incorrect `ViewModeChangedEvent.from` and `ViewModeChangedEvent.to` values when entering or exiting fullscreen in the Bitmovin Player Web UI. --- ## 3.113.1 Released: 2026-05-11 **Fixed** - `AdFinishedEvent.ad` contains data from the next ad instead of the ad that finished if there are back-to-back ads. - HLS Interstitials not being scheduled when AirPlay was started before loading the stream. - Rare app crashes that could occur shortly after starting live stream playback. Note: The Bitmovin [`Player`]() and [`Source`]() APIs should be called from the main thread to avoid unexpected behavior. --- ## 3.113.0 Released: 2026-05-06 **Changed** - Updated Bitmovin Player Web UI to `4.12.0` **Fixed** - Potential crash when playing post-roll ads with IMA - Fixed an issue where HLS Interstitial mid-rolls could play instead of pre-rolls when playback started with a start offset after a mid-roll position. - HLS Interstitial playback can get stuck after an ad with `X-PLAYOUT-LIMIT` when another Interstitial is already scheduled. --- ## 3.112.0 Released: 2026-04-30 **Added** - [`PlayerViewConfig.hideFirstFrame`]() to configure first-frame hiding before playback starts e.g. before pre-roll ads **Deprecated** - [`BitmovinUserInterfaceConfig.hideFirstFrame`]() and [`SystemUserInterfaceConfig.hideFirstFrame`]() in favor of [`PlayerViewConfig.hideFirstFrame`]() **Fixed** - Potential crash when emitting [`AdBreakStartedEvent`]()s when using IMA - Pre-roll and mid-roll interstitials were played back when a start-offset was configured - `Player.ads.schedule` being empty in `SourceLoaded` event for pre-roll and mid-roll ad schedules. Note: post-roll and HLS interstitial ad breaks may still be empty at `SourceLoaded` time. Subscribe to [`AdScheduleChangedEvent`]() for reliable schedule-change notifications in all cases. --- ## 3.111.1 Released: 2026-04-17 **Fixed** - Main-content and Interstitials with CUE=PRE playing at the same time - Unexpected [`PlayingEvent`]() emitted between [`AdBreakStartedEvent`]() and [`AdStartedEvent`]() for pre-roll ads - Main content frame flashing before Interstitial with CUE=PRE despite setting `hideFirstFrame` to `true` --- ## 3.111.0 Released: 2026-04-03 **Added** - [`DaterangeMetadata.plannedDuration`]() to expose the `PLANNED-DURATION` attribute of `EXT-X-DATERANGE` tags - [`InterstitialAdBreak`]() to expose HLS interstitial specific information about ad breaks - [`InterstitialAdBreak.plannedDuration`]() to expose the planned duration of HLS interstitial ad breaks Access the interstitial related information by casting the [`AdBreak`]() of the [`AdBreakStartedEvent`]() as follows: ```swift player.events .on(AdBreakStartedEvent.self) .sink { event in guard let interstitialAdBreak = event.adBreak as? InterstitialAdBreak else { // Not an interstitial ad break return } let plannedDuration = interstitialAdBreak.plannedDuration } .store(in: ...) ``` **Changed** - [`AdBreak.identifier`]() now populates the value of the `ID` attribute of the `EXT-X-DATERANGE` tag for HLS Interstitials --- ## 3.110.0 Released: 2026-03-27 **Added** - `programChange(newSourceMetadata:)` to the Analytics API to start a new analytics playback session. This can be usefull to indicate a new program started within the same live stream. - The minimum `BitmovinPlayerCollector` version to `3.23.0`. - Support for scheduling ad tags from `data:` and local `file:` URLs via the Advertising API. - Note: HTTP-specific [`NetworkConfig`]() hooks ([`preprocessHttpRequest`](), [`preprocessHttpResponse`](), [`retryHttpRequest`]()) are only applied to `http`/`https` traffic and are skipped for non-HTTP schemes - Improved transition from main content to interstitial content (including Ads) by preloading them when using Bitmovin Advertising Module (BAM). - This also covers transitions between Ads/HLS Interstitials which are scheduled at the same position **Changed** - Updated Bitmovin Player Web UI to `4.10.2` **Fixed** - [`player.isLive`]() now properly returns `false` during ads --- ## 3.109.0 Released: 2026-03-19 **Added** - Viewability tracking support for HLS Interstitials - `viewable` is emitted once an Interstitial has accumulated at least 2 seconds of playback while at least 50% of its view is visible - Viewability tracking can also report `notViewable` and `undetermined` outcomes - Configure via the new [`InterstitialTrackingEventTrigger`]() cases: - `.viewable` - `.notViewable` - `.viewUndetermined` **Changed** - When using BAM, VAST viewability tracking now emits `viewable` once an ad has accumulated at least 2 seconds of playback while at least 50% of its view is visible - In addition to `viewable`, VAST viewability tracking can now also report `notViewable` and `undetermined` outcomes **Fixed** - Calling tracking URLs twice when using Bitmovin Advertising Module (BAM) or for HLS Interstitials through `X-AD-CREATIVE-SIGNALING`. - [`AudioChangedEvent`]() not being triggered on audio track switches when the HLS playlist specifies `CLOSED-CAPTIONS=NONE` without a `SUBTITLES` attribute - Report correct error code (`100`) via [`AdErrorEvent`]() for empty VAST XML tags **Deprecated** - CocoaPods publishing: new releases will be marked as deprecated in favor of our SPM-published releases. Checkout our [blog post](https://community.bitmovin.com/t/cocoapods-deprecation-notice/3864) for full details --- ## 3.108.1 Released: 2026-02-26 **Fixed** - Main content audio keeps playing when using BAM and playback of an [`AdItem`]() is triggered by seeking over it --- ## 3.108.0 Released: 2026-02-23 **Changed** - Updated Bitmovin Player Web UI to `4.8.1`. - More accurate detection of video quality switches: - on iOS 18, tvOS 18, visionOS 2 and above - on streams having audio-only variants **Fixed** - [`Player.duration`]() during HLS Interstitial playback now correctly clamps to the remaining `X-PLAYOUT-LIMIT` time for the active `ASSET` within an `ASSET-LIST`. --- ## 3.107.0 Released: 2026-02-09 **Changed** - Migrate the Bitmovin Player Web UI integration to v4 (checkout [What's new in UI v4](https://developer.bitmovin.com/playback/docs/whats-new-in-ui-v4) for details) - If you have no UI customizations, there is no further action required. The new UI is used automatically. - If you ship a custom UI v3 (even when it still uses the default factory name `bitmovin.playerui.UIFactory.buildDefaultSmallScreenUI`) - Configure the legacy factory explicitly via [`BitmovinUserInterfaceConfig.uiManagerFactoryFunction`]() - Or upgrade your custom UI v4 following our [Migration Guide](https://developer.bitmovin.com/playback/reference/migration-guide-v3-to-v4) - Improve video start time for streams without a configured start offset ([`SourceOptions.startOffset`]()) or target latency ([`SourceLiveConfig.targetLatency`]()). - Improve logging system: - event logs now include meaningful details in a user-friendly way, and less duplication - time entries in human-readable format --- ## 3.106.0 Released: 2026-01-16 **Changed** - [`NetworkConfig.preprocessHttpResponse`]() to process responses from failed HTTP requests as well. In this case, [`NetworkConfig.retryHttpRequest`]() has access to the post-processed response. - The error message when Source preloading fails without any additional details. This case now also has improved logs to help debugging the issue. **Fixed** - A race-condition which led to missing error information resulting in a `Source Error` without any error details. --- ## 3.105.0 Released: 2026-01-09 **Added** - [`Player.videoPlaybackQuality`]() to access the currently playing [`VideoQuality`](). - [`Player.videoDownloadQuality`]() to access the currently downloading [`VideoQuality`](). - Support for [`DownloadFinishedEvent`]()s for segments (video and audio) on iOS 18, tvOS 18 and visionOS 2 and above. **Changed** - Add compatibility with the latest Google Cast iOS sender SDK (4.8.4) - Note: 4.8.4 requires a minimum deployment target of iOS 15. To support iOS 14, use a Google Cast SDK version earlier than 4.8.4. **Deprecated** - [`Player.videoQuality`](). Use [`Player.videoDownloadQuality`]() instead. --- ## 3.104.0 Released: 2025-12-19 **Added** - [`CmcdConfig`]() and [`CmcdConfig.isEnabled`]() to enable sending Common Media Client Data (CMCD). - [`SourceConfig.cmcdConfig`]() namespace to configure Common Media Client Data (CMCD). - [`DeficiencyData.response`]() to retrieve the response even in case the request failed. - [`DownloadFinishedEvent.response`]() to retrieve the response of the request. --- ## 3.103.0 Released: 2025-12-11 **Changed** - [`PlayerEventsApi`]() and its methods are now `open` to allow integration to implement custom event handling **Fixed** - Playback errors when using a HTTP redirect for multivariant playlists which are using CRLF (`\r\n`) new lines characters --- ## 3.102.0 Released: 2025-12-04 **Added** - [`PlayerViewConfig.tweaksConfig`]() to configure experimental [`PlayerView`]() features via [`PlayerViewTweaksConfig`]() - [`PlayerViewTweaksConfig.hidePlaybackControlsInPictureInPicture`]() to hide/show Picture-in-Picture playback controls - [`PlayerView.tweaks`]() namespace of type [`PlayerViewTweaksApi`]() to group [`PlayerView`]() tweak APIs - [`PlayerViewTweaksApi.hidePlaybackControlsInPictureInPicture`]() to dynamically hide/show Picture-in-Picture playback controls at runtime --- ## 3.101.0 Released: 2025-11-28 **Added** - [`AdScheduleChangedEvent`]() event to signal changes to the player's advertising schedule. This event is emitted: - when a new [`AdBreak`]() is scheduled - when an [`AdBreak`]() finished loading its manifest and gets populated with ads. - when an [`AdBreak`]() is removed from the schedule to start playback or gets discarded. - [`AdvertisingApi.schedule`]() to access the upcoming scheduled [`AdBreak`]()s sorted by schedule time (ascending). Subscribe to [`AdScheduleChangedEvent`]() to be notified when the player's advertising schedule changes. - [`AdvertisingConfig.shouldPlayAdItem`]() callback to decide whether an [`AdItem`]() should start playing. It is called once for each [`AdItem`]() shortly before it is about to play. --- ## 3.100.0 Released: 2025-11-25 **Changed** - `Xcode 16.4` and `Swift 5.10` or newer is required to integrate the SDK - [`AdvertisingApi`]() from a `class` to a `protocol` to allow implementing it in integrations --- ## 3.99.0 Released: 2025-11-07 **Added** - [`Player.ads`]() namespace of type [`AdvertisingApi`]() to group advertising related APIs together going forward **Fixed** - [`Player.duration`]() sometimes retuning zero in [`SourceLoadedEvent`]() **Deprecated** - [`Player.skipAd()`]() in favor of [`Player.ads.skip()`]() - [`Player.scheduleAd(adItem:)`]() in favor of [`Player.ads.schedule(adItem:)`]() - [`Player.registerAdContainer(_:)`]() in favor of [`Player.ads.register(adContainer:)`]() --- ## 3.98.0 Released: 2025-10-31 **Added** - [`PlayerConfig.interstitialsConfig`]() of type [`InterstitialsConfig`]() to configure HLS Interstitial specific behaviour - [`InterstitialsConfig.customAttributesMapping`]() to map custom attributes to interstitial specific information such as tracking events and click-through URLs. Defaults to no tracking. Use `CustomAttributesMappingPresets.adCreativeSignaling` to enable SVTA's `X-AD-CREATIVE-SIGNALING` specification support. - [`InterstitialsConfig.macroValueProvider`]() to provide custom values for macro replacement in tracking URLs - Support for adding new properties to already scheduled HLS Interstitials through subsequent `#EXT-X-DATERANGE` tags with the same `ID`. --- ## 3.97.2 Released: 2025-10-16 **Added** - Include `THIRD-PARTY-NOTICES.md` file in all published frameworks **Changed** - API signature of [`HttpRequest.headers`]() from `NSMutableDictionary` to `[String: String]` to improve usability from Swift. ObjC usage is unaffected. **Fixed** - Missing [`SourceUnloadEvent`]() and [`SourceUnloadedEvent`]() before a [`SourceErrorEvent`]() is emitted when the error happens during preloading - HLS Interstitials with `CUE="PRE"` or `CUE="POST"` were filtered out if the `#EXT-X-DATERANGE` time was in the past **Removed** - Unused `DrmRequest` type --- ## 3.97.1 Released: 2025-09-26 **Fixed** - UTF-8 text is decoded incorrectly when passed via [`BitmovinUserInterfaceConfig.customOptions`]() - Missing [`SourceUnloadEvent`]() and [`SourceUnloadedEvent`]() through the [`Player`]() when using [`SourceFailureAction.drop`]() and no upcoming Source is available --- ## 3.97.0 Released: 2025-09-19 **Added** - Support for additional `CUE` attribute values in HLS Interstitials via [`DateRangeMetadata.cueingOptions`](): - `CUE="PRE"` marks an interstitial as a pre-roll (played before main content begins) - `CUE="POST"` marks an interstitial as a post-roll (played after main content has finished) **Changed** - Media and asset-list reloading for HLS Interstitials: Interstitials no longer keep previously loaded resources in memory but re-fetch them from the original URLs on each playback opportunity. - The same lifecycle events as for normal loads are re-emitted: [`AdManifestLoadEvent`](), [`AdManifestLoadedEvent`](), and [`DownloadFinishedEvent`]() (for `X-ASSET-LIST`). - This ensures updated ad assets are always retrieved, allowing for more flexible monetization opportunities (e.g., refreshed ad content on repeated playback after seeking). --- ## 3.96.0 Released: 2025-09-12 **Added** - [`TweaksConfig.sourceFailureAction`]() to specify the action to take when a [`Source`]() results in an error - [`SourceFailureAction.drop`]() to attempt to remove an erroneous [`Source`]() from the playlist if possible **Changed** - Add compatibility with Google IMA SDK for tvOS (4.15.1) - Add compatibility with Google IMA SDK for iOS (3.27.4) **Known Issues** - Google IMA iOS SDK `3.27.4` introduces a memory leak where ads keep the player instance alive even after the [`PlayerView`]() is destroyed (e.g., when navigating to another View). We raised this issue ([link](https://groups.google.com/g/ima-sdk/c/6rXlRajhzRo)) with the IMA team and are awaiting an update. Suggestion: avoid using `3.27.4`. Earlier versions of the Google IMA SDK do not show this issue. - On iOS 26, the same video-variant playlist may be requested multiple times when loading a stream. As a result, [`NetworkConfig.preprocessHttpRequest`]() may receive more invocations than expected. --- ## 3.95.0 Released: 2025-09-09 **Added** - [`PictureInPictureApi.isEnabled`]() to dynamically enable or disable Picture-in-Picture at runtime, independent of the initial configuration - Toggling this property also updates the UI: when set to `false`, the PiP button is removed; when set back to `true`, the PiP button is shown again (if supported) - If PiP is currently active when disabling, the session is exited immediately and playback continues in the player view - [`PictureInPictureAvailabilityChangedEvent`]() to signal changes in Picture-in-Picture availability for a [`PlayerView`](). Can be observed via [`UserInterfaceListener`]() **Changed** - [`PlayerView.pictureInPicture`]() is now always available (non-optional) and provides dynamic control over Picture-in-Picture functionality - [`UserInterfaceApi.isPictureInPictureAvailable`]() now reflects the current, runtime status of Picture-in-Picture availability, instead of only the static configuration (`PictureInPictureConfig.isPictureInPictureEnabled`) --- ## 3.94.1 Released: 2025-08-08 **Fixed** - [`SourceError`]() when playing Apple Immersive Video assets - Skip Ad button losing focus and not being able to focus it again when using BAM with System UI on tvOS --- ## 3.94.0 Released: 2025-07-28 **Added** - [`TweaksConfig.seekToEndThreshold`]() is now also properly supported when seeking to the beginning of the DVR window in a live stream - Enable seeking to and from a Live Streams within a Playlist using [`Player.playlist.seek(source:time:)`]() - Support for [`SourceOptions.startOffset`]() for subsequent [`Source`]()s within a playlist. **Fixed** - Missing [`TimeChangedEvent`]()s after seeking into a Live Stream within a Playlist **Known Issues** - When seeking into a Live Stream using [`Player.playlist.seek(source:time:)`](), the `time` attribute will be ignored - When seeking into a VOD using [`Player.playlist.seek(source:time:)`](), the `time` attribute will always override a configured [`SourceOptions.startOffset`](). Workaround: use the [`SourceOptions.startOffset`]() as input for the seek method. - When transitioning into a Live Stream as a subsequent [`Source`]() within a playlist, playback will start slightly behind the live edge. If a `EXT-X-START:TIME-OFFSET` is present, it will be properly respected. Workaround: if playback is desired to always start at the live edge, set the [`SourceOptions.startOffset`]() to 0 (will override the `EXT-X-START:TIME-OFFSET`). - When transitioning into a Live Stream as a subsequent [`Source`]() within a playlist with a configured [`SourceOptions.startOffset`](), a frame close to the live-edge could be visible until the [`SourceOptions.startOffset`]() is applied. --- ## 3.93.0 Released: 2025-07-10 **Added** - [`DateRangeMetadata.cueingOptions`](), mapping to the `CUE` attribute in `#EXT-X-DATERANGE` tags. - Support for `CUE="ONCE"` on HLS Interstitials: interstitials with this value will be discarded after their first playback, preventing them from being replayed. **Fixed** - `Source.analytics.customData` didn't apply [`customData`]() fields 31 to 50 - [`AdvertisingConfig.shouldPlaySeekedOverAdItems`]() callback could cause playback to stay paused when scrubbing over ads that should all be discarded. **Changed** - [`AdvertisingConfig.shouldPlaySeekedOverAdItems`]() default behaviour for HLS Interstitials: - If none of the seeked-over ads are jump-restricted (`X-RESTRICT="JUMP"`), no item will play after seeking (previously, the last ad would always play). - If any of the seeked-over ads are jump-restricted, the last jump-restricted item will play after seeking (previously, the last ad would always play, no matter whether jump-restricted or not). - HLS Interstitials are now re-playable by default: previously, interstitials were discarded after playback, skip, or failure. Now, interstitial items will play again each time their scheduled time is reached (e.g., after seeking backwards), unless `CUE="ONCE"` is set. --- ## 3.92.1 Released: 2025-07-04 **Fixed** - Content never gets loaded on the Cast receiver, when the Cast device gets connected before calling `Player.load()`. - `CastTimeChangedEvent.currentTime` and [`Player.currentTime`]() returns relative time instead of absolute time when casting a live stream. --- ## 3.92.0 Released: 2025-06-19 **Added** - Support for HLS Interstitials using `#EXT-X-DATERANGE`-based ad signaling. This enables scheduled ad breaks during live or VOD playback via timed metadata in the HLS manifest. Supported attributes: - `X-ASSET-URI` - `X-ASSET-LIST` - `X-RESUME-OFFSET` - `X-PLAYOUT-LIMIT` - `X-RESTRICT` **Fixed** - Missing [`DurationChangedEvent`]() when an HLS stream transitions from Live to VOD resulting in an unusable Player UI **Known Issues** - For some streams the `DurationChanged` event is missing when the stream transitions from Live to VOD indicating a potential `AVPlayer` bug or stream issue. Replay and `timeShifting` is still possible but the UI will stay in live mode. - The System UI appears stuck after a stream transitioned from Live to VOD - HLS Interstitials feature: - The following attributes in `#EXT-X-DATERANGE` tags are not currently supported: `CUE="ONCE"`, `CUE="PRE"`, `CUE="POST"`. - Non-discardable interstitials are not reloaded after they have been played. When such an interstitial is played again (e.g., after seeking backward), the previously loaded asset is reused instead of being fetched again. This may affect scenarios where updated ad content or refreshed asset data is expected. --- ## 3.91.0 Released: 2025-06-16 **Changed** - Improved error code documentation and search preview on the API reference - Default value of [`DownloadConfig.supportClearKeyContent`]() to `true` to allow downloading ClearKey content by default - Live streams without `EXT-X-PROGRAM-DATE-TIME` tags will no longer have continuous relative `currentTime` values due to inaccuracy. - Logs will include more context information about where they are coming from. This will help Bitmovin engineers to backtrack logs to the SDK implementation. - Updated Bitmovin Player Web UI to `3.98.0`. **Deprecated** - [`TweaksConfig.dateBasedTimeShiftingForLiveStreams`](), as the same behavior is now automatically enabled for HLS Live streams where `#EXT-X-PROGRAM-DATE-TIME` is available and `SourceLiveConfig/targetLatency` is set to any numeric value. **Fixed** - [`PlayerView.contentOverlay`]() not working when [`PlayerView`]() is initialized without [`PlayerViewConfig`]() - Improved stability of HLS Low Latency streams when using [`SourceLiveConfig.targetLatency`]() --- ## 3.90.1 Released: 2025-06-06 **Fixed** - Incorrect value of [`Player.subtitle`]() and no [`SubtitleChangedEvent`]() emitted when changing subtitle tracks. This fix improves subtitle track switching reliability and ensures proper integration with iOS Closed Captions settings (Settings > Accessibility > Subtitles & Captioning > Closed Captions + SDH). --- ## 3.90.0 Released: 2025-05-16 **Added** - [`AdvertisingConfig.shouldPlaySeekedOverAdItems`]() callback to allow customization of which [`AdItem`]()s should play when a seek or time-shift operation jumps over multiple ad breaks. This callback is triggered during any forward seek or time-shift where one or more [`AdItem`]()s are scheduled between the original position and the seek target. - [`PlayerView.contentOverlay`]() namespace of type [`ContentOverlayApi`]() to access content overlay related APIs. - [`ContentOverlayApi.view`]() to allow managing content overlay subviews that appear between the video and playback control layers. - [`VideoBoundsChangedEvent`]() to notify about changes of the video bounds via [`UserInterfaceListener.onVideoBoundsChanged`]() - [`PlayerView.videoBounds`]() to access the video bounds of the player view **Deprecated** - [`VideoSizeChangedEvent`]() and [`PlayerListener.onVideoSizeChanged`]() as the event was never emitted **Fixed** - [`SeekEvent`](), [`SeekedEvent`](), [`TimeShiftEvent`]() and [`TimeShiftedEvent`]() emitted on a background thread when using PiP or System UI --- ## 3.89.0 Released: 2025-05-08 **Added** - Support for AirPods touch control to pause and resume playback when [`NowPlayingConfig.isNowPlayingInfoEnabled`]() is set to `true` **Fixed** - Target latency catch up did not trigger after an initial stall when joining an HLS LL stream. - `automaticallyPreservesLatency` not respected after stalls during playback. - Occasional unresponsiveness of Bitmovin Player UI **Changed** - Always perform an initial attempt to reach the target latency regardless of [`SourceLiveConfig.automaticallyPreservesLatency`]() being set --- ## 3.88.0 Released: 2025-04-23 **Added** - [`HttpRequestType.hlsInterstitialsAssetList`]() to identify requests for HLS Interstitial's `X-ASSET-LIST` JSON file as preparation for the upcoming HLS Interstitials support. - [`ThumbnailsApi.container`]() to assign the current thumbnail container - [`ThumbnailsApi.cancelPendingRenderRequests()`]() to cancel any pending thumbnail render requests **Changed** - [`AdSource`]() now implements value-based equality. Two instances are considered equal if all their properties are equal, rather than relying on object identity. - [`ThumbnailsApi.renderThumbnail(forTime:toleranceBefore:toleranceAfter:)`]() and [`ThumbnailsApi.renderThumbnail(for:time:toleranceBefore:toleranceAfter:)`](): - Behavior on multiple calls, in-progress requests are not cancelled anymore. See API documentation for details. - Removed return value, now both methods return `Void`. **Removed** - Deprecated `TweaksConfig.disableSubtitleTracksWhileSeeking` without replacement as it is no longer required. - `ThumbnailsApi.registerContainer()` method in favor of [`ThumbnailsApi.container`]() **Fixed** - [`SubtitleChangedEvent`]() is now properly emitted when the track selection is finished. In case of rapid subtitle track changes, the event for the last change will be emitted always but events for intermediate transitions might not be emitted as they never finished. - Improved error messages for some of the playback-related errors - Slow thumbnail rendering when using [`ThumbnailsApi.renderThumbnail(forTime:toleranceBefore:toleranceAfter:)`]() and [`ThumbnailsApi.renderThumbnail(for:time:toleranceBefore:toleranceAfter:)`]() --- ## 3.87.0 Released: 2025-04-11 **Added** - SDK version to our DocC API reference - `characteristics` to [`SubtitleTrack`]() and [`AudioTrack`]() to access `CHARACTERISTICS` attributes from `EXT-X-MEDIA` renditions **Fixed** - Incorrect documentation rendering for [`AdErrorEvent`](), [`PlayerErrorEvent`](), [`SourceErrorEvent`]() and [`OfflineErrorEvent`]() **Changed** - When [`TweaksConfig.dateBasedTimeShiftingForLiveStreams`]() is enabled for HLS Low Latency streams, the player will try automatically to get closer to the target latency multiple times. Due to system limitations, there is no guarantee that the target latency can be reached. --- ## 3.86.0 Released: 2025-03-27 **Added** - Documentation of error codes in API reference: https://cdn.bitmovin.com/player/ios/3/documentation/bitmovinplayer/errors **Changed** - Changed API reference to use DocC. - The URL to the index page changed from https://cdn.bitmovin.com/player/ios/3/docs/index.html to https://cdn.bitmovin.com/player/ios/3/documentation/bitmovinplayer - URLs to the old documentation will be redirected to the new index page in the upcoming weeks **Removed** - Obsolete player error code `1099`: `JsonDeserializationFailed` --- ## 3.85.2 Released: 2025-03-20 **Fixed** - [`SourceOptions.startOffset`]() not respected on tvOS - Signature validation failure for `xcframework` binaries **Changed** - Extended the documentation for [`TweaksConfig.timeChangedInterval`]() to outline the limitation of a minimum value of 1.0 during AirPlay. --- ## 3.85.1 Released: 2025-03-07 **Fixed** - Incorrect absolute time via [`Player.currentTime`](), `Player.currentTime(.absoluteTime)` and [`CastTimeUpdatedEvent.currentTime`]() APIs during casting if casting was started before calling `Player.load()` **Known Issues** - Invalid signature of distributed `xcframework` files due to revoked certificate. See [this post](https://community.bitmovin.com/t/ios-tvos-visionos-player-sdk-and-analytics-collector-xcframework-signature-issue/3593) for details. --- ## 3.85.0 Released: 2025-02-28 **Added** - Additional error codes to `SourceError.Code` for more granularity when downloading the playlist failed - `2205`: Downloading the playlist has failed due to an invalid manifest URL. - `2210`: Downloading the playlist has failed due to an unhandled HTTP redirect (3xx). - `2220`: Downloading the playlist has failed due to a client-side HTTP error (4xx). - `2221`: Downloading the playlist has failed due to a bad request. - `2222`: Downloading the playlist has failed due to missing or invalid authentication credentials. - `2223`: Downloading the playlist has failed due to insufficient permissions. - `2224`: Downloading the playlist has failed because the requested manifest could not be found. - `2230`: Downloading the playlist has failed due to a general server-side issue (5xx). - `2231`: Downloading the playlist has failed due to an internal server error. - `2232`: Downloading the playlist has failed due to a bad gateway error. - `2233`: downloading the playlist has failed because the server is temporarily unavailable. - `2234`: Downloading the playlist has failed due to a gateway timeout. - `associatedLanguage` to [`SubtitleTrack`]() and [`AudioTrack`]() to access `ASSOC-LANGUAGE` attributes from `EXT-X-MEDIA` renditions - [`TweaksConfig.parseAdditionalMediaAttributes`]() to control whether the `ASSOC-LANGUAGE` attribute from `EXT-X-MEDIA` renditions should be parsed **Changed** - The [`SourceErrorEvent.errorCode`]() now contains the underlying system error code for playback failures - `SourceError.Code`, `PlayerError.Code` and `OfflineError.Code` enums are no longer deprecated. Properties using those types stay deprecated. - Updated Bitmovin Player Web UI to `3.87.0`. - Playlist download errors are now more granular and using the new `SourceError` error codes **Fixed** - [`SourceOptions.startOffset`]() not respected when [`Player.play()`]() is called before `onReady` event is emitted - [`Player.currentTime`](), `Player.currentTime(.absoluteTime)` and [`TimeChangedEvent.currentTime`]() not returning the correct value for live streams without `#EXT-X-PROGRAM-DATE-TIME` tags after AirPlay was started or stopped - `Player.currentTime(.relativeTime)` resets value after AirPlay was started or stopped **Known Issues** - Invalid signature of distributed `xcframework` files due to revoked certificate. See [this post](https://community.bitmovin.com/t/ios-tvos-visionos-player-sdk-and-analytics-collector-xcframework-signature-issue/3593) for details. --- ## 3.84.0 Released: 2025-02-10 **Changed** - [`DeficiencyData.underlyingError`]() from optional to non-optional **Fixed** - [`SourceOptions.startOffset`]() not respected when connecting to AirPlay receiver before starting playback **Removed** - Initializer `DeficiencyData(code:message:underlyingError)`. Use `DeficiencyData(error:)` instead --- ## 3.83.0 Released: 2025-02-03 **Added** - Signature for all `xcframework` binaries to allow verification of the identity of our binaries - Support for [`SourceOptions.startOffset`]() for live-streams when using the System UI - [`TweaksConfig.restoreAirPlayPlaybackPosition`]() to restore the playback position when starting AirPlay for live streams without `#EXT-X-PROGRAM-DATE-TIME` tags **Fixed** - Duplicate [`AirPlayAvailabilityChangedEvent`]() events for the same value on subsequent Source loads - Playback position not restored when starting AirPlay for live streams without `#EXT-X-PROGRAM-DATE-TIME` tags --- ## 3.82.0 Released: 2025-01-17 **Added** - `errorCode` property to [`PlayerErrorEvent`](), [`SourceErrorEvent`](), [`OfflineErrorEvent`]() and [`AdErrorEvent`]() to provide the raw error code. **Deprecated** - `code` property on [`PlayerErrorEvent`](), [`SourceErrorEvent`](), [`OfflineErrorEvent`]() and [`AdErrorEvent`]() in favor of `errorCode` property. **Fixed** - Poster image in [`PlayerView`]() not rendered correctly in React Native applications - Report correct error code `100` via [`AdErrorEvent`]() when VAST XML parsing fails when using Bitmovin Advertising Module - `EXT-X-START:TIME-OFFSET` was not respected when the stream also contains a `EXT-X-PROGRAM-DATE-TIME` tag - The magnifier glass no longer appears when double tapping any text within the Bitmovin Player UI - Played back audio track does not match the one reported as selected by the player and subsequent audio track changes do not work --- ## 3.81.0 Released: 2024-12-19 **Added** - Thumbnail rendering support for custom native UI via [`Player.thumbnails`]() - [`ThumbnailsApi.registerContainer(_:)`]() to register a container for the thumbnails to be rendered into. - [`ThumbnailsApi.renderThumbnail(forTime:toleranceBefore:toleranceAfter:)`]() to render the thumbnail for a specific time into the registered container. - [`ThumbnailsApi.renderThumbnail(for:time:toleranceBefore:toleranceAfter:)`]() to render the thumbnail for a specific source in the playlist at a specific time into the registered container. --- ## 3.80.0 Released: 2024-12-12 **Added** - [`Player.thumbnails`]() namespace of type [`ThumbnailsApi`]() to access thumbnails related APIs. - [`ThumbnailsApi.thumbnail(forTime:)`]() to retrieve the thumbnail for a specific time, if available. **Deprecated** - `Player.thumbnail(forTime:)` in favor of `Player.thumbnails.thumbnail(forTime:)`. **Fixed** - Missing [`PlayingEvent`]() when calling `play()` while seeking when AirPlay is active. --- ## 3.79.0 Released: 2024-12-06 **Changed** - During playback of progressive ads, the UI configured through [`StyleConfig`]() is now used. Before, progressive ads were not played with a UI. This previous behaviour can be restored by setting `AdItem.linearAdUiConfig.requestsUi = false` **Fixed** - Stalling indicator is always displayed during ad playback when System UI is used --- ## 3.78.0 Released: 2024-11-22 **Added** - `.verbose` logging level for `DebugConfig.logging.logger?.level`. This enables logging all events the Player SDK produces, useful to diagnose problems and trace the flow of execution within the Player. **Changed** - All public API types from [`BitmovinPlayer`]() and `BitmovinPlayerCore` now conform to `Sendable` protocol to support Swift Concurrency with Swift 6 - [`PlayerView`]() is now `MainActor` isolated to conform to Swift Concurrency requirements with Swift 6 for `UIView` subclasses - APIs in `BitmovinPlayerAnalytics` now conform to `Sendable` protocol to support Swift Concurrency with Swift 6 **Fixed** - [`AdStartedEvent.indexInQueue`]() is always `0` when using [`AdSourceType.bitmovin`]() - Ads from the same VAST ad tag do not play in order according to the `sequence` attribute value of the `` tag when using [`AdSourceType.bitmovin`]() **Known Issues** - Stalling indicator is always displayed during ad playback when System UI is used --- ## 3.77.0 Released: 2024-10-30 **Added** - [`BitmovinPlayer`]() and `BitmovinPlayerCore` are now published to the public CocoaPods registry. New updates will be only published there. This simplifies integration effort as it no longer requires to specify a custom spec source. - [`BitmovinCastManagerOptions.stopReceiverApplicationWhenEndingSession`]() to control whether the receiver application should be terminated when the user ends the session --- ## 3.76.0 Released: 2024-10-25 **Added** - [`Player.allowsAirPlay`]() and [`RemoteControlConfig.allowsAirPlay`]() to control whether AirPlay is allowed - [`AirPlayAvailabilityChangedEvent`]() to notify about AirPlay availability changes **Deprecated** - [`Player.isAirPlayAvailable`]() in favor of [`Player.allowsAirPlay`]() - [`AirPlayAvailableEvent`]() in favor of [`AirPlayAvailabilityChangedEvent`]() - [`RemoteControlConfig.isAirPlayEnabled`]() in favor of [`RemoteControlConfig.allowsAirPlay`]() --- ## 3.75.0 Released: 2024-10-14 **Added** - [`ImaAdvertisingConfig.shouldPauseOnTap`]() to control whether the ad should pause when the user taps the screen on iOS. **Changed** - During casting, [`Player.currentTime`](), `Player.currentTime(.absoluteTime)` and [`CastTimeUpdatedEvent.currentTime`]() APIs return absolute unix timestamp values instead of relative time --- ## 3.74.1 Released: 2024-10-09 **Fixed** - [`Player.timeshift`]() sometimes not changing playback position for specific live streams --- ## 3.74.0 Released: 2024-10-04 **Changed** - [`BufferLevel`]() is now `open` and can be subclassed for testing purposes - [`BufferLevel`]()'s initializer is now `public` and can be used to create custom instances for testing purposes **Fixed** - Cast receiver not always starting playback at the same position as local player when starting to cast a live stream --- ## 3.73.0 Released: 2024-09-27 **Added** - [`Cue.rawText`]() to access the raw string exactly as it appears in the caption file. The property can be retrieved through [`CueEvent.rawText`](), making it accessible from [`CueParsedEvent`](), [`CueEnterEvent`](), and [`CueExitEvent`](). - [`Cue.attributedText`]() to access the formatted text content of the cue. This property provides the cue's text content with attributes in the `UIKitAttributes` format, making it directly usable with UIKit and SwiftUI components that support attributed strings. It can be retrieved through [`CueEvent.attributedText`](), making it accessible from [`CueParsedEvent`](), [`CueEnterEvent`](), and [`CueExitEvent`](). **Removed** - [`Cue`]()'s convenience initializers for Objective-C: now it will be necessary to use the complete initializer. - `initWithStartTime:endTime:text` - `initWithStartTime:endTime:text:vttProperties` - `initWithStartTime:endTime:html` - `initWithStartTime:endTime:image` **Known Issues** - [`Cue.rawText`]() has the same value as [`Cue.text`]() in case the caption is embedded in the manifest file --- ## 3.72.0 Released: 2024-09-19 **Added** - [`TweaksConfig.dateBasedTimeShiftingForLiveStreams`]() to improve accuracy of reaching target latency when [`SourceLiveConfig.targetLatency`]() is set for HLS Low Latency streams **Removed** - Method not implemented warning when the Web UI is calling `getSeekableRange` --- ## 3.71.1 Released: 2024-09-11 **Fixed** - Unnecessarily downloading the first segment of live HLS streams when initially loading the asset - Potential infinite buffering with HLS Low Latency stream when initially loading the asset --- ## 3.71.0 Released: 2024-09-06 **Added** - iOS 18, tvOS 18 and visionOS 2 support - [`SystemUiApi.contextualActions`]() to allow setting contextual actions on tvOS 15 and above **Fixed** - Missing [`AudioChangedEvent`]() and [`SubtitleChangedEvent`]() during AirPlay when selecting tracks on the receiver with iOS 18 sender used --- ## 3.70.0 Released: 2024-09-02 **Added** - `adQuartileFinished` methods to Analytics SSAI API **Fixed** - [`AdStartedEvent.clickThroughUrl`]() was `nil` even though `AdStartedEvent.ad.clickThroughUrl` was set. Both are set to the same value now. - Unexpected [`CueEnterEvent`]()s and [`CueExitEvent`]()s emitted after unloading a stream with side-loaded subtitles and loading a different stream --- ## 3.69.0 Released: 2024-08-23 **Added** - [`NetworkConfig.preprocessHttpRequest`]() to preprocess HTTP requests before they are sent **Changed** - Pre-roll ads start loading on the first play intention ([`PlayEvent`]()) instead of waiting for [`ReadyEvent`](). When [`PlaybackConfig.isAutoplayEnabled`]() is set to `true`, the ad will start loading simultaneously with the main content. **Fixed** - [`NetworkConfig.preprocessHttpRequestDelegate`]() is called two times for every FairPlay license request - Duplicated [`MetadataParsedEvent`]() and [`MetadataEvent`]() emitted on iOS 18, tvOS 18 and visionOS 2 **Deprecated** - [`NetworkConfig.preprocessHttpRequestDelegate`]() in favor of [`NetworkConfig.preprocessHttpRequest`]() --- ## 3.68.0 Released: 2024-08-07 **Added** - The [`NetworkConfig`]() is now respected for poster image requests - `HttpRequestType.mediaPoster` to identify the request - [`NowPlayingConfig`]() to enable the current Now Playing information for the application. This information will be displayed wherever Now Playing information typically appears, such as the lock screen and inside the control center. This config can be accessed through [`PlayerConfig.nowPlayingConfig`](). - [`BitmovinUserInterfaceConfig.customOptions`]() to provide custom configuration options for a customized Bitmovin Player Web UI - [`BitmovinUserInterfaceConfig.metadata`]() of type [`BitmovinUserInterfaceMetadata`]() to provide default metadata values for the Bitmovin Player Web UI - [`BitmovinUserInterfaceMetadata.title`]() to provide default title of the video source - [`BitmovinUserInterfaceMetadata.sourceDescription`]() to provide default description of the video source - [`BitmovinUserInterfaceConfig.uiManagerFactoryFunction`]() to specify a custom `UIManager` factory method for the Bitmovin Player Web UI **Changed** - The poster image is now cached and not downloaded again during the lifecycle of a [`Source`]() e.g. when the [`Source`]() is inside a playlist and [`isPosterPersistent`]() is active - Extend documentation for closures within [`NetworkConfig`]() by adding an usage example **Fixed** - Properly destroy and release `IMAAdsManager` instances after ads finished playing **Deprecated** - [`TweaksConfig.updatesNowPlayingInfoCenter`]() in favor of `NowPlayingConfig.nowPlayingConfig`. Enabling Now Playing information via [`PlayerConfig.nowPlayingConfig`]() will bypass the flag, disabling AVKit's automatic updates. - [`ImaSettings.disableNowPlayingInfo`]() in favor of `NowPlayingConfig.nowPlayingConfig`. Enabling Now Playing information via [`PlayerConfig.nowPlayingConfig`]() will bypass the flag, disabling IMA's updates. **Known Issues** - There is an unexpected behaviour when using the IMA SDK together with [`NowPlayingConfig`](). The Google IMA SDK adds its own `MPRemoteCommand` for play/pause right when the ad starts loading (not when it started playing). Within this time window (approximately around 10 seconds) it's possible that the Ad and the main content are playing at the same time when a user interacts with the Now Playing feature. We raised this issue ([link](https://groups.google.com/g/ima-sdk/c/OLjsdqO0P9A)) with the IMA team and are awaiting an update for the IMA iOS SDK. --- ## 3.67.0 Released: 2024-07-19 **Added** - [`TweaksConfig.enforcedMinimumBufferLevelForPlayback`]() to configure the minimum buffer level, in seconds, required for transitioning into the playing state. It can be used to avoid flickering [`StallStartedEvent`](), [`StallEndedEvent`]() and improper [`TimeChangedEvent`]() invocations caused by unexpected `AVPlayer` behaviour when stalling on an audio-only stream with an empty buffer - More details to the error messages if a manifest request failed **Fixed** - An issue with the IMA SDK on tvOS where certain ad tags would not emit the `STARTED` event resulting in a missing [`AdStartedEvent`]() --- ## 3.66.1 Released: 2024-06-28 **Fixed** - Seek events not being emitted after reaching [`PlaybackFinishedEvent`]() --- ## 3.66.0 Released: 2024-06-21 **Added** - Support for streaming ads with the Bitmovin Advertising Module (BAM) - Improved VAST `MediaFile` selection by ignoring unsupported MIME-Types and preferring streaming over progressive media files - [`AdSource.videoLoadTimeout`]() to configure the timeout for loading media files of advertisements **Changed** - Update Google IMA SDK for iOS to latest stable version (3.23.0) - Update Google IMA SDK for tvOS to latest stable version (4.13.0) - Update Google Cast iOS sender SDK to latest stable version (4.8.1) **Fixed** - Safe areas not respected for the Bitmovin Player Web UI in landscape --- ## 3.65.0 Released: 2024-06-10 **Changed** - `Xcode 15.4` and `Swift 5.10` or newer is required to integrate the SDK --- ## 3.64.0 Released: 2024-05-29 **Added** - `PlayerAnalyticsApi.AnalyticsSsaiApi` to provide access to the manual SSAI tracking of our Analytics Collector. - Buffering overlay is displayed during ad loading for all ad source types (`.bitmovin`, `.ima`, `.progressive`). - [`VastAdData.wrapperAdSystems`]() and [`VastAdData.wrapperCreativeIds`]() to the [`Ad.data`]() for VAST ads handled by the Google IMA SDK. **Fixed** - Playback error of FairPlay content without setting the [`FairPlayConfig.prepareLicense`]() callback. - Two touch interactions needed to skip an ad or open the click-through link when the Bitmovin Advertising Module is used in combination with our Bitmovin Player Web UI. - Performance degradation when using side-loaded subtitles. **Changed** - [`PlayingEvent`](), in case of pre-roll ad playback, is now emitted after [`AdStartedEvent`](). - [`StallStartedEvent`]() and [`StallEndedEvent`]() are now emitted during ad loading for all ad source types (`.bitmovin`, `.ima`, `.progressive`). - The minimum `BitmovinPlayerCollector` version to `3.7.0`. - Updated Bitmovin Player Web UI to `3.64.0`. --- ## 3.63.0 Released: 2024-05-17 **Changed** - Updated Bitmovin Player Web UI to `3.62.0`. - Bitmovin Advertising Module macro replacement no longer replaces all unknown macros with `-1`. Default value replacement can be managed using [`VastMacroConfig.valueProvider`]() if required. **Fixed** - Bitmovin Advertising Module macro replacement not working if the macro markers are url encoded. --- ## 3.62.0 Released: 2024-05-08 **Added** - [`SourceConfig.liveConfig`]() namespace of type [`SourceLiveConfig`]() to configure behaviour when playing live content. - [`SourceLiveConfig.targetLatency`]() to configure the players offset from the live edge. - [`SourceLiveConfig.automaticallyPreservesLatency`]() to configure if the current latency should be automatically preserved. - [`SourceLiveConfig.minTimeshiftBufferDepth`]() to configure the minimum buffer depth needed to enable time shifting in a stream. - [`Source.latency`]() namespace of type [`SourceLatencyApi`]() to access latency related APIs for live-streams. - [`SourceLatencyApi.automaticallyPreservesLatency`]() to dynamically configure if the current latency should be automatically preserved. - [`SourceLatencyApi.recommendedLatency`]() to provide the system's recommended latency. - [`Player.latency`]() namespace of type [`LatencyApi`]() to access live stream related APIs. - [`LatencyApi.currentLatency`]() to get the current latency in seconds. - [`BitmovinUserInterfaceConfig.enableWebViewInspecting`]() for debugging of custom Bitmovin Player Web UIs. **Changed** - Added `DOCTYPE` declaration to the HTML document used to render the Bitmovin Player Web UI to prevent [quirks mode](https://developer.mozilla.org/en-US/docs/Web/HTML/Quirks_Mode_and_Standards_Mode) **Deprecated** - [`PlayerConfig.liveConfig`]() in favor of [`SourceConfig.liveConfig`](). --- ## 3.61.0 Released: 2024-04-26 **Added** - Support for WebVTT coloring information (text and background colors) for side-loaded WebVTT subtitles, and WebVTT subtitles referenced in the manifest. Subtitle cues containing coloring information are provided as HTML through the [`Cue.html`]() property. **Changed** - When using the [`LogEntry`]() initializer from Swift, the `code` and `data` properties can be omitted. **Fixed** - A memory leak of internal components after the Player was released. --- ## 3.60.0 Released: 2024-04-12 **Added** - The poster-image is now supported when using the System UI ([`UserInterfaceType.system`]()) on iOS and tvOS. - [`TweaksConfig.updatesNowPlayingInfoCenter`]() to decide whether AVKit should update Now Playing information automatically when using System UI. You may want to disable automatic updates in case they are interfering with manual updates you are performing. - Minimalistic Advertising UI during ad playback when the System UI is used in combination with the Bitmovin Advertising Module. - It contains a skip button respecting the customization options from the [`LinearAdUiConfig`](). - It reacts to user interaction for controlling playback. - It handles the `clickThroughUrl` on iOS and visionOS. **Changed** - `text` property of [`CueEnterEvent`]() and [`CueExitEvent`]() contain no HTML tags from side-loaded subtitle tracks. **Fixed** - Clipped subtitle cues in case of side-loaded subtitle track containing multi-byte unicode characters. - Ad not visible when the System UI is used in combination with the Bitmovin Advertising Module. --- ## 3.59.0 Released: 2024-04-05 **Added** - Bitmovin Advertising Module as an alternative to using IMA SDK to playback VAST-compliant ads. Using Bitmovin Advertising Module doesn't require any additional dependencies and offers a drop in replacement for the IMA SDK for the most common advertising scenarios. It supports seamless integration with the latest VAST `4.3` standard while offering reliable backward compatibility down to VAST `2.0`. - [`AdSourceType.bitmovin`]() to enable Bitmovin Advertising Module for an [`AdSource`](). ```swift // Create an [`AdItem`]() with one [`AdSource`]() of type `.bitmovin` let adItem = AdItem( adSources: [AdSource(tag: adTagUrl, ofType: .bitmovin)], // Configure the ad as a pre-roll ad atPosition: "pre" ) // You can either create the schedule before player creation using the advertising config let advertisingConfig = AdvertisingConfig(schedule: [adItem]) // Add the config to your PlayerConfig playerConfig.advertisingConfig = advertisingConfig // Or use the PlayerAPI to scheduled the ad player.scheduleAd(adItem: adItem) ``` - [`LinearAdUiConfig`]() to customise the Bitmovin Advertising UI when [`AdSourceType.bitmovin`]() is configured. ```swift let linearAdUiConfig = LinearAdUiConfig() linearAdUiConfig.message = "This ad will end in {remainingTime}" linearAdUiConfig.untilSkippableMessage = "This ad is skippable in {remainingTime}" linearAdUiConfig.skippableMessage = "You can skip this ad now." // Create an [`AdItem`]() with one [`AdSource`]() of type `.bitmovin` let adItem = AdItem( adSources: [AdSource(tag: adTagUrl, ofType: .bitmovin)], // Configure the ad as a pre-roll ad atPosition: "pre", // Provide a LinearAdUiConfig instance to have built-in support for our default ad UI linearAdUiConfig: linearAdUiConfig ) ``` - [`AdvertisingConfig.bitmovin`]() namespace to configure Bitmovin Advertising Module features. - [`BitmovinAdvertisingConfig.macro`]() to configure macro replacement when using Bitmovin Advertising Module. See [`VastMacroConfig`]() for more details. - [`VastMacro`](), [`VastMacroContext`]() and [`VastMacroScope`]() to facilitate the macro value providing process. - [`Ad.clickThroughUrlOpened`]() callback to track the opening of the `clickThroughUrl` in case a custom UI is used. - `AdvertisingConfig.shouldLoadAdItem(adItem:)` callback that can be used to decide whether an [`AdItem`]() should start loading. It is called once for each [`AdItem`](