Merge pull request #532 from bitmovin/feature/enable-lock-screen-cont…

…rols

iOS: support Media Controls

CHANGELOG.md

@@ -2,10 +2,18 @@
 
 ## [Unreleased]
 
+### Added
+
+- `LockScreenControlConfig` to configure the lock screen information for the application. When `isEnabled` is `true`, the current media information will be shown on the lock-screen and within the control center
+
 ### Changed
 
 - Update Bitmovin's native Android SDK version to `3.84.0`
 
+### Deprecated
+
+- `TweaksConfig.updatesNowPlayingInfoCenter` in favor of `LockScreenControlConfig.isEnabled`
+
 ## [0.29.0] - 2024-09-09
 
 ### Added

ios/RCTConvert+BitmovinPlayer.swift

@@ -42,6 +42,9 @@ extension RCTConvert {
         if let networkConfig = RCTConvert.networkConfig(json["networkConfig"]) {
             playerConfig.networkConfig = networkConfig
         }
+        if let nowPlayingConfig = RCTConvert.lockScreenControlConfig(json["lockScreenControlConfig"]) {
+            playerConfig.nowPlayingConfig = nowPlayingConfig
+        }
 #if os(iOS)
         if let remoteControlConfig = RCTConvert.remoteControlConfig(json["remoteControlConfig"]) {
             playerConfig.remoteControlConfig = remoteControlConfig
@@ -1328,6 +1331,17 @@ extension RCTConvert {
             "body": toJson(data: httpResponse.body)
         ]
     }
+
+    static func lockScreenControlConfig(_ json: Any?) -> NowPlayingConfig? {
+        guard let json = json as? [String: Any?] else {
+            return nil
+        }
+        let nowPlayingConfig = NowPlayingConfig()
+        if let isEnabled = json["isEnabled"] as? Bool {
+            nowPlayingConfig.isNowPlayingInfoEnabled = isEnabled
+        }
+        return nowPlayingConfig
+    }
 }
 /**
  * React native specific PlayerViewConfig.

src/index.ts

@@ -24,3 +24,4 @@ export * from './playerConfig';
 export * from './liveConfig';
 export * from './bufferApi';
 export * from './network';
+export * from './lockScreenControlConfig';

src/lockScreenControlConfig.ts

@@ -0,0 +1,50 @@
+/**
+ * Configures the lock screen information for the application. This information will be displayed
+ * wherever current media information typically appears, such as the lock screen
+ * and inside the control center.
+ */
+export interface LockScreenControlConfig {
+  /**
+   * Enable the default behavior of displaying media information
+   * on the lock screen and within the control center.
+   * Default is `false`.
+   *
+   * For a detailed list of the supported features in the **default behavior**,
+   * check the **Default Supported Features** section.
+   *
+   * @note Enabling this flag will automatically treat {@link TweaksConfig.updatesNowPlayingInfoCenter} as `false`.
+   *
+   * ## Limitations
+   * ---
+   * - At the moment, the current media information is disabled during casting.
+   *
+   * ## Known Issues
+   * ---
+   * **iOS**:
+   * - There is unexpected behavior when using the IMA SDK. The Google IMA SDK adds its own commands
+   *   for play/pause as soon as the ad starts loading (not when it starts playing). Within this window
+   *   (approximately around 10 seconds), it is possible that both the ad and the main content are playing
+   *   at the same time when a user interacts with the lock-screen control feature.
+   *
+   * ## Default Supported Features
+   * ---
+   * Here is the list of features supported by the default behavior.
+   *
+   * ### Populated Metadata
+   * - asset URL (to visualize the correct kind of data — _e.g. a waveform for audio files_)
+   * - title
+   * - artwork
+   * - live or VOD status
+   * - playback rate
+   * - default playback rate
+   * - elapsed time
+   * - duration
+   *
+   * ### Registered Commands
+   * - toggle play/pause
+   * - change playback position
+   * - skip forward
+   * - skip backward
+   */
+  isEnabled?: boolean;
+}

src/playerConfig.ts

@@ -9,6 +9,7 @@ import { NativeInstanceConfig } from './nativeInstance';
 import { PlaybackConfig } from './playbackConfig';
 import { LiveConfig } from './liveConfig';
 import { NetworkConfig } from './network/networkConfig';
+import { LockScreenControlConfig } from './lockScreenControlConfig';
 
 /**
  * Object used to configure a new `Player` instance.
@@ -73,4 +74,10 @@ export interface PlayerConfig extends NativeInstanceConfig {
    * Configures network request manipulation functionality. A default {@link NetworkConfig} is set initially.
    */
   networkConfig?: NetworkConfig;
+  /**
+   * Configures the lock screen information for the application. This information will be displayed
+   * wherever current media information typically appears, such as the lock screen
+   * and inside the control center.
+   */
+  lockScreenControlConfig?: LockScreenControlConfig;
 }

src/tweaksConfig.ts

@@ -166,6 +166,7 @@ export interface TweaksConfig {
    *
    * Default is `true`.
    *
+   * @deprecated To enable the Now Playing information use {@link LockScreenControlConfig.isEnabled}
    * @platform iOS
    */
   updatesNowPlayingInfoCenter?: boolean;