@capgo/capacitor-video-player 8.2.14 → 8.3.0

package/android/src/main/java/com/capgo/videoplayer/VideoPlayerPlugin.java

@@ -46,7 +46,7 @@ import org.json.JSONObject;
 )
 public class VideoPlayerPlugin extends Plugin {
 
-    private final String pluginVersion = "8.2.14";
+    private final String pluginVersion = "8.3.0";
 
     // Permission alias constants
     private static final String PERMISSION_DENIED_ERROR = "Unable to access media videos, user denied permission request";
@@ -90,6 +90,7 @@ public class VideoPlayerPlugin extends Plugin {
     private String subtitle = "";
     private String language = "";
     private List<VideoSubtitleTrack> subtitleTracks = new ArrayList<>();
+    private List<VideoChapter> chapters = new ArrayList<>();
     private JSObject subTitleOptions;
     private JSObject drmOptions;
     private final JSObject ret = new JSObject();
@@ -208,6 +209,7 @@ public class VideoPlayerPlugin extends Plugin {
                 language = call.getString("language");
             }
             subtitleTracks = parseSubtitleTracks(call);
+            chapters = parseChapters(call);
             subTitleOptions = new JSObject();
             if (call.getData().has("subtitleOptions")) {
                 subTitleOptions = call.getObject("subtitleOptions");
@@ -982,6 +984,7 @@ public class VideoPlayerPlugin extends Plugin {
                     showControls,
                     displayMode,
                     resolvedSubtitleTracks,
+                    chapters,
                     subTitleOptions,
                     headers,
                     title,
@@ -1144,7 +1147,8 @@ public class VideoPlayerPlugin extends Plugin {
                             showControls,
                             displayMode,
                             new ArrayList<>(),
-                            null,
+                            chapters,
+                            subTitleOptions,
                             headers,
                             title,
                             smallTitle,
@@ -1198,6 +1202,46 @@ public class VideoPlayerPlugin extends Plugin {
         return tracks;
     }
 
+    private List<VideoChapter> parseChapters(PluginCall call) {
+        List<VideoChapter> parsed = new ArrayList<>();
+        if (!call.getData().has("chapters")) {
+            return parsed;
+        }
+        JSArray chapterArray = call.getArray("chapters");
+        if (chapterArray == null) {
+            return parsed;
+        }
+        for (int i = 0; i < chapterArray.length(); i++) {
+            JSONObject entry = chapterArray.optJSONObject(i);
+            if (entry == null) {
+                Log.w(TAG, "Skipping malformed chapter entry at index " + i);
+                continue;
+            }
+            Object rawTitle = entry.opt("title");
+            if (!(rawTitle instanceof String)) {
+                continue;
+            }
+            String chapterTitle = (String) rawTitle;
+            if (chapterTitle.trim().isEmpty()) {
+                continue;
+            }
+            if (!entry.has("startTime")) {
+                continue;
+            }
+            double startTime = entry.optDouble("startTime", -1);
+            if (Double.isNaN(startTime) || Double.isInfinite(startTime) || startTime < 0) {
+                continue;
+            }
+            Double endTime = entry.has("endTime") ? entry.optDouble("endTime", -1) : null;
+            if (endTime != null && (Double.isNaN(endTime) || Double.isInfinite(endTime) || endTime <= startTime)) {
+                endTime = null;
+            }
+            parsed.add(new VideoChapter(chapterTitle.trim(), startTime, endTime));
+        }
+        parsed.sort((left, right) -> Double.compare(left.startTimeSeconds, right.startTimeSeconds));
+        return parsed;
+    }
+
     private List<VideoSubtitleTrack> resolveSubtitleTracks(List<VideoSubtitleTrack> tracks) {
         List<VideoSubtitleTrack> resolved = new ArrayList<>();
         if (tracks == null) {
@@ -1227,6 +1271,7 @@ public class VideoPlayerPlugin extends Plugin {
         Boolean showControls,
         String displayMode,
         List<VideoSubtitleTrack> subtitleTracks,
+        List<VideoChapter> chapters,
         JSObject subTitleOptions,
         JSObject headers,
         String title,
@@ -1253,6 +1298,7 @@ public class VideoPlayerPlugin extends Plugin {
             showControls,
             displayMode,
             subtitleTracks,
+            chapters,
             subTitleOptions,
             headers,
             title,

package/android/src/main/res/drawable/ic_chapters_white.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="utf-8"?>
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="24"
+    android:viewportHeight="24">
+    <path
+        android:fillColor="#FFFFFFFF"
+        android:pathData="M4,10.5c-0.83,0 -1.5,0.67 -1.5,1.5s0.67,1.5 1.5,1.5 1.5,-0.67 1.5,-1.5 -0.67,-1.5 -1.5,-1.5zM4,4.5c-0.83,0 -1.5,0.67 -1.5,1.5S3.17,7.5 4,7.5 5.5,6.83 5.5,6 4.83,4.5 4,4.5zM4,16.5c-0.83,0 -1.5,0.67 -1.5,1.5s0.67,1.5 1.5,1.5 1.5,-0.67 1.5,-1.5 -0.67,-1.5 -1.5,-1.5zM7,19h14v-2H7v2zM7,13h14v-2H7v2zM7,5v2h14V5H7z" />
+</vector>

package/android/src/main/res/layout/exo_playback_control_view.xml

@@ -115,6 +115,15 @@
           android:background="?actionBarItemBackground"
           android:visibility="gone"/>
 
+        <ImageButton
+          android:id="@+id/exo_chapters"
+          android:layout_width="48dp"
+          android:layout_height="48dp"
+          android:background="?actionBarItemBackground"
+          android:src="@drawable/ic_chapters_white"
+          android:visibility="gone"
+          android:contentDescription="@string/chapters_button"/>
+
         <ImageButton
           android:id="@+id/exo_pip"
           android:layout_width="48dp"

package/android/src/main/res/values/strings.xml

@@ -1,3 +1,5 @@
 <resources>
     <string name="my_string">Just a simple string</string>
+    <string name="chapters">Chapters</string>
+    <string name="chapters_button">Chapters button</string>
 </resources>

package/dist/docs.json

@@ -431,6 +431,15 @@
           ],
           "type": "VideoSubtitle[] | undefined"
         },
+        {
+          "name": "chapters",
+          "tags": [],
+          "docs": "Chapter markers for long-form content (iOS, Android).\nShown as a chapter list in the native fullscreen player; selecting a chapter seeks to `startTime`.",
+          "complexTypes": [
+            "VideoChapter"
+          ],
+          "type": "VideoChapter[] | undefined"
+        },
         {
           "name": "subtitleOptions",
           "tags": [],
@@ -485,7 +494,7 @@
         {
           "name": "audioCategory",
           "tags": [],
-          "docs": "iOS audio session category behavior (iOS).\n- \"ambient\": respects the iPhone silent switch (default)\n- \"playback\": ignores the iPhone silent switch\n- \"moviePlayback\": playback optimized for video and long-form AirPlay\ndefault: \"ambient\"",
+          "docs": "iOS audio session category behavior (iOS).\n- \"ambient\": respects the iPhone silent switch\n- \"playback\": ignores the iPhone silent switch\n- \"moviePlayback\": playback optimized for video and long-form AirPlay.\n\nWhen omitted, the plugin resolves the category from other options: `\"playback\"` if\n`pipEnabled` or `bkmodeEnabled` is true (both default to true), otherwise `\"ambient\"`.",
           "complexTypes": [],
           "type": "'ambient' | 'playback' | 'moviePlayback' | undefined"
         },
@@ -600,31 +609,61 @@
         }
       ]
     },
+    {
+      "name": "VideoChapter",
+      "slug": "videochapter",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "title",
+          "tags": [],
+          "docs": "Chapter title shown in the chapter list",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "startTime",
+          "tags": [],
+          "docs": "Start time in seconds",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "endTime",
+          "tags": [],
+          "docs": "End time in seconds (optional). Stored for future timeline markers; chapter jumps use `startTime` only in this release.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
     {
       "name": "SubTitleOptions",
       "slug": "subtitleoptions",
-      "docs": "",
+      "docs": "Optional styling for on-screen subtitles.\n\nOn iOS, colors and font size are applied through `AVPlayerItem`\n`textStyleRules`, which Apple documents for WebVTT only. IMSC1 and other\nin-manifest timed text formats are not styled through this API.\nInline WebVTT cue styles can take precedence over equivalent\n`subtitleOptions` values; the plugin sets text style rules as a platform\nfallback, not a guaranteed override of authored cue styling.",
       "tags": [],
       "methods": [],
       "properties": [
         {
           "name": "foregroundColor",
           "tags": [],
-          "docs": "Foreground Color in RGBA (default rgba(255,255,255,1)",
+          "docs": "Foreground color in RGBA. On Android, when the plugin applies subtitle\nstyling, omitted values fall back to `rgba(255,255,255,1)`. When\n`subtitleOptions` is absent, embedded cue colors from the media can\noverride that fallback. On iOS, omitted colors are not set by the plugin;\nthe platform uses the viewer's caption appearance settings instead of fixed\nplugin defaults.",
           "complexTypes": [],
           "type": "string | undefined"
         },
         {
           "name": "backgroundColor",
           "tags": [],
-          "docs": "Background Color in RGBA (default rgba(0,0,0,1)",
+          "docs": "Background color in RGBA. On Android, when the plugin applies subtitle\nstyling in fullscreen, omitted values fall back to `rgba(0,0,0,1)`. In\npicture-in-picture, omitted values fall back to transparent when the plugin\napplies its caption style (for example sidecar subtitles or non-empty\n`subtitleOptions` that include a color override). An empty\n`subtitleOptions` object alone does not select that fallback. With\nfont-size-only options, embedded cue styles stay enabled, so authored cue\nbackgrounds can remain visible in PiP. When `subtitleOptions` is absent,\nembedded cue colors from the media can override the fallback. On iOS,\nomitted colors are not set by the plugin; the platform uses the viewer's\ncaption appearance settings instead of fixed plugin defaults.",
           "complexTypes": [],
           "type": "string | undefined"
         },
         {
           "name": "fontSize",
           "tags": [],
-          "docs": "Font Size in pixels (default 16)",
+          "docs": "Font size in CSS pixels. On Android, supplied values are rounded to the\nnearest integer before applying. When omitted on embedded tracks without a\nsidecar subtitle URI, Android uses `SubtitleView.setUserDefaultTextSize()`\n(the user's system caption size), not a fixed 16 px size. Sidecar subtitles\nstill use a fixed default size when this property is omitted. On iOS,\nvalues map to AVFoundation relative size where 16 equals the system default\n(100%).",
           "complexTypes": [],
           "type": "number | undefined"
         }

package/dist/esm/definitions.d.ts

@@ -148,6 +148,11 @@ export interface capVideoPlayerOptions {
      * When provided, takes precedence over `subtitle` / `language`.
      */
     subtitles?: VideoSubtitle[];
+    /**
+     * Chapter markers for long-form content (iOS, Android).
+     * Shown as a chapter list in the native fullscreen player; selecting a chapter seeks to `startTime`.
+     */
+    chapters?: VideoChapter[];
     /**
      * SubTitle Options
      */
@@ -182,10 +187,12 @@ export interface capVideoPlayerOptions {
     bkmodeEnabled?: boolean;
     /**
      * iOS audio session category behavior (iOS).
-     * - "ambient": respects the iPhone silent switch (default)
+     * - "ambient": respects the iPhone silent switch
      * - "playback": ignores the iPhone silent switch
-     * - "moviePlayback": playback optimized for video and long-form AirPlay
-     * default: "ambient"
+     * - "moviePlayback": playback optimized for video and long-form AirPlay.
+     *
+     * When omitted, the plugin resolves the category from other options: `"playback"` if
+     * `pipEnabled` or `bkmodeEnabled` is true (both default to true), otherwise `"ambient"`.
      */
     audioCategory?: 'ambient' | 'playback' | 'moviePlayback';
     /**
@@ -350,17 +357,62 @@ export interface VideoSubtitle {
      */
     language?: string;
 }
+export interface VideoChapter {
+    /**
+     * Chapter title shown in the chapter list
+     */
+    title: string;
+    /**
+     * Start time in seconds
+     */
+    startTime: number;
+    /**
+     * End time in seconds (optional). Stored for future timeline markers; chapter jumps use `startTime` only in this release.
+     */
+    endTime?: number;
+}
+/**
+ * Optional styling for on-screen subtitles.
+ *
+ * On iOS, colors and font size are applied through `AVPlayerItem`
+ * `textStyleRules`, which Apple documents for WebVTT only. IMSC1 and other
+ * in-manifest timed text formats are not styled through this API.
+ * Inline WebVTT cue styles can take precedence over equivalent
+ * `subtitleOptions` values; the plugin sets text style rules as a platform
+ * fallback, not a guaranteed override of authored cue styling.
+ */
 export interface SubTitleOptions {
     /**
-     * Foreground Color in RGBA (default rgba(255,255,255,1)
+     * Foreground color in RGBA. On Android, when the plugin applies subtitle
+     * styling, omitted values fall back to `rgba(255,255,255,1)`. When
+     * `subtitleOptions` is absent, embedded cue colors from the media can
+     * override that fallback. On iOS, omitted colors are not set by the plugin;
+     * the platform uses the viewer's caption appearance settings instead of fixed
+     * plugin defaults.
      */
     foregroundColor?: string;
     /**
-     * Background Color in RGBA (default rgba(0,0,0,1)
+     * Background color in RGBA. On Android, when the plugin applies subtitle
+     * styling in fullscreen, omitted values fall back to `rgba(0,0,0,1)`. In
+     * picture-in-picture, omitted values fall back to transparent when the plugin
+     * applies its caption style (for example sidecar subtitles or non-empty
+     * `subtitleOptions` that include a color override). An empty
+     * `subtitleOptions` object alone does not select that fallback. With
+     * font-size-only options, embedded cue styles stay enabled, so authored cue
+     * backgrounds can remain visible in PiP. When `subtitleOptions` is absent,
+     * embedded cue colors from the media can override the fallback. On iOS,
+     * omitted colors are not set by the plugin; the platform uses the viewer's
+     * caption appearance settings instead of fixed plugin defaults.
      */
     backgroundColor?: string;
     /**
-     * Font Size in pixels (default 16)
+     * Font size in CSS pixels. On Android, supplied values are rounded to the
+     * nearest integer before applying. When omitted on embedded tracks without a
+     * sidecar subtitle URI, Android uses `SubtitleView.setUserDefaultTextSize()`
+     * (the user's system caption size), not a fixed 16 px size. Sidecar subtitles
+     * still use a fixed default size when this property is omitted. On iOS,
+     * values map to AVFoundation relative size where 16 equals the system default
+     * (100%).
      */
     fontSize?: number;
 }

package/dist/esm/definitions.js.map

@@ -1 +1 @@
-{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export interface VideoPlayerPlugin {\n  /**\n   * Initialize a video player\n   *\n   */\n  initPlayer(options: capVideoPlayerOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Return if a given playerId is playing\n   *\n   */\n  isPlaying(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Play the current video from a given playerId\n   *\n   */\n  play(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Pause the current video from a given playerId\n   *\n   */\n  pause(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Get the duration of the current video from a given playerId\n   *\n   */\n  getDuration(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Get the current time of the current video from a given playerId\n   *\n   */\n  getCurrentTime(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Set the current time to seek the current video to from a given playerId\n   *\n   */\n  setCurrentTime(options: capVideoTimeOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Get the volume of the current video from a given playerId\n   *\n   */\n  getVolume(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Set the volume of the current video to from a given playerId\n   *\n   */\n  setVolume(options: capVideoVolumeOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Get the muted of the current video from a given playerId\n   *\n   */\n  getMuted(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Set the muted of the current video to from a given playerId\n   *\n   */\n  setMuted(options: capVideoMutedOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Set the rate of the current video from a given playerId\n   *\n   */\n  setRate(options: capVideoRateOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Get the rate of the current video from a given playerId\n   *\n   */\n  getRate(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Stop all players playing\n   *\n   */\n  stopAllPlayers(): Promise<capVideoPlayerResult>;\n  /**\n   * Show controller\n   *\n   */\n  showController(): Promise<capVideoPlayerResult>;\n  /**\n   * isControllerIsFullyVisible\n   *\n   */\n  isControllerIsFullyVisible(): Promise<capVideoPlayerResult>;\n  /**\n   * Exit player\n   *\n   */\n  exitPlayer(): Promise<capVideoPlayerResult>;\n  /**\n   * Hide the currently presented player UI without stopping playback (native fullscreen).\n   *\n   * Call `showPlayer()` to show it again.\n   */\n  hidePlayer(): Promise<capVideoPlayerResult>;\n  /**\n   * Show again a previously hidden player UI (native fullscreen).\n   */\n  showPlayer(): Promise<capVideoPlayerResult>;\n  /**\n   * Get the native Capacitor plugin version.\n   * On web, the implementation returns `\"web\"`.\n   *\n   * @returns Promise resolving to the plugin version string for this build (`\"web\"` on web)\n   */\n  getPluginVersion(): Promise<{ version: string }>;\n}\nexport interface capEchoOptions {\n  /**\n   *  String to be echoed\n   */\n\n  value?: string;\n}\nexport interface capVideoPlayerOptions {\n  /**\n   * Player mode\n   *  - \"fullscreen\"\n   *  - \"embedded\" (Web only)\n   */\n  mode?: string;\n  /**\n   * The url of the video to play\n   */\n  url?: string;\n  /**\n   * Optional override URL used when casting to Chromecast (iOS, Android).\n   *\n   * This lets you cast an alternative rendition/manifest (e.g. MPEG-DASH + Widevine)\n   * while keeping the on-device playback URL unchanged (e.g. HLS + FairPlay on iOS).\n   */\n  chromecastUrl?: string;\n  /**\n   * The url of subtitle associated with the video\n   *\n   * Prefer `subtitles` when providing more than one track.\n   * Kept for backward compatibility.\n   */\n  subtitle?: string;\n  /**\n   * The language of subtitle\n   * see https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers\n   *\n   * Prefer `subtitles` when providing more than one track.\n   * Kept for backward compatibility.\n   */\n  language?: string;\n  /**\n   * Multiple subtitle tracks (iOS, Android).\n   * When provided, takes precedence over `subtitle` / `language`.\n   */\n  subtitles?: VideoSubtitle[];\n  /**\n   * SubTitle Options\n   */\n  subtitleOptions?: SubTitleOptions;\n  /**\n   * Id of DIV Element parent of the player\n   */\n  playerId?: string;\n  /**\n   * Initial playing rate\n   */\n  rate?: number;\n  /**\n   * Exit on VideoEnd (iOS, Android)\n   * default: true\n   */\n  exitOnEnd?: boolean;\n  /**\n   * Loop on VideoEnd when exitOnEnd false (iOS, Android)\n   * default: false\n   */\n  loopOnEnd?: boolean;\n  /**\n   * Picture in Picture Enable (iOS, Android)\n   * default: true\n   */\n  pipEnabled?: boolean;\n  /**\n   * Background Mode Enable (iOS, Android)\n   * default: true\n   */\n  bkmodeEnabled?: boolean;\n  /**\n   * iOS audio session category behavior (iOS).\n   * - \"ambient\": respects the iPhone silent switch (default)\n   * - \"playback\": ignores the iPhone silent switch\n   * - \"moviePlayback\": playback optimized for video and long-form AirPlay\n   * default: \"ambient\"\n   */\n  audioCategory?: 'ambient' | 'playback' | 'moviePlayback';\n  /**\n   * Show Controls Enable (iOS, Android)\n   * default: true\n   */\n  showControls?: boolean;\n  /**\n   * Display Mode [\"all\", \"portrait\", \"landscape\"] (iOS, Android)\n   * default: \"all\"\n   */\n  displayMode?: string;\n  /**\n   * Component Tag or DOM Element Tag (React app)\n   */\n  componentTag?: string;\n  /**\n   * Player Width (mode \"embedded\" only)\n   */\n  width?: number;\n  /**\n   * Player height (mode \"embedded\" only)\n   */\n  height?: number;\n  /**\n   * Headers for the request (iOS, Android)\n   * by Manuel García Marín (https://github.com/PhantomPainX)\n   */\n  headers?: {\n    [key: string]: string;\n  };\n  /**\n   * Title shown in the player and Chromecast metadata (iOS, Android)\n   * by Manuel García Marín (https://github.com/PhantomPainX)\n   */\n  title?: string;\n  /**\n   * Subtitle shown below the title in the player and Chromecast metadata (iOS, Android)\n   * by Manuel García Marín (https://github.com/PhantomPainX)\n   */\n  smallTitle?: string;\n  /**\n   * ExoPlayer Progress Bar and Spinner color (Android)\n   * by Manuel García Marín (https://github.com/PhantomPainX)\n   * Must be a valid hex color code\n   * default: #FFFFFF\n   */\n  accentColor?: string;\n  /**\n   * Chromecast enable/disable (iOS, Android)\n   * iOS requires Google Cast SDK setup and local network Info.plist keys.\n   * by Manuel García Marín (https://github.com/PhantomPainX)\n   * default: true\n   */\n  chromecast?: boolean;\n  /**\n   * Artwork url to be shown in Chromecast player (iOS, Android)\n   * by Manuel García Marín (https://github.com/PhantomPainX)\n   * default: \"\"\n   */\n  artwork?: string;\n  /**\n   * DRM configuration for protected content (iOS: FairPlay, Android: Widevine)\n   *\n   * When casting, Widevine's `certificateUrl` (license URL) is also forwarded to Chromecast\n   * receivers as `media.customData.laurl`.\n   */\n  drm?: DrmOptions;\n}\nexport interface capVideoPlayerIdOptions {\n  /**\n   * Id of DIV Element parent of the player\n   */\n  playerId?: string;\n}\nexport interface capVideoRateOptions {\n  /**\n   * Id of DIV Element parent of the player\n   */\n  playerId?: string;\n  /**\n   * Rate value\n   */\n  rate?: number;\n}\nexport interface capVideoVolumeOptions {\n  /**\n   * Id of DIV Element parent of the player\n   */\n  playerId?: string;\n  /**\n   * Volume value between [0 - 1]\n   */\n  volume?: number;\n}\nexport interface capVideoTimeOptions {\n  /**\n   * Id of DIV Element parent of the player\n   */\n  playerId?: string;\n  /**\n   * Video time value you want to seek to\n   */\n  seektime?: number;\n}\nexport interface capVideoMutedOptions {\n  /**\n   * Id of DIV Element parent of the player\n   */\n  playerId?: string;\n  /**\n   * Muted value true or false\n   */\n  muted?: boolean;\n}\nexport interface capVideoListener {\n  /**\n   * Id of DIV Element parent of the player\n   */\n  playerId?: string;\n  /**\n   * Video current time when listener triggered\n   */\n  currentTime?: number;\n}\nexport interface capExitListener {\n  /**\n   * Dismiss value true or false\n   */\n  dismiss?: boolean;\n  /**\n   * Video current time when listener triggered\n   */\n  currentTime?: number;\n}\nexport interface capVideoPlayerResult {\n  /**\n   * result set to true when successful else false\n   */\n  result?: boolean;\n  /**\n   * method name\n   */\n  method?: string;\n  /**\n   * value returned\n   */\n  value?: any;\n  /**\n   * message string\n   */\n  message?: string;\n}\nexport interface VideoSubtitle {\n  /**\n   * The url of the subtitle file (vtt, srt, ...)\n   */\n  subtitle: string;\n  /**\n   * The language of the subtitle\n   * see https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers\n   */\n  language?: string;\n}\nexport interface SubTitleOptions {\n  /**\n   * Foreground Color in RGBA (default rgba(255,255,255,1)\n   */\n  foregroundColor?: string;\n  /**\n   * Background Color in RGBA (default rgba(0,0,0,1)\n   */\n  backgroundColor?: string;\n  /**\n   * Font Size in pixels (default 16)\n   */\n  fontSize?: number;\n}\nexport interface FairPlayDrmOptions {\n  /**\n   * The URL to fetch the FairPlay certificate\n   */\n  certificateUrl?: string;\n  /**\n   * The URL to send the SPC and receive the CKC license (FairPlay license server URL)\n   */\n  contentKeySpcUrl?: string;\n  /**\n   * Optional FairPlay asset identifier used when generating the SPC.\n   * Defaults to the `skd://` content identifier from the key request.\n   */\n  assetId?: string;\n}\nexport interface PlayreadyDrmOptions {\n  /**\n   * The URL to fetch the PlayReady license\n   */\n  certificateUrl?: string;\n}\nexport interface WidevineDrmOptions {\n  /**\n   * The URL to fetch the Widevine license\n   */\n  certificateUrl?: string;\n}\nexport interface DrmOptions {\n  /**\n   * FairPlay DRM configuration (iOS)\n   */\n  fairplay?: FairPlayDrmOptions;\n  /**\n   * PlayReady DRM configuration\n   */\n  playready?: PlayreadyDrmOptions;\n  /**\n   * Widevine DRM configuration (Android)\n   */\n  widevine?: WidevineDrmOptions;\n}\n"]}
+{"version":3,"file":"definitions.js","sourceRoot":"","sources":["../../src/definitions.ts"],"names":[],"mappings":"","sourcesContent":["export interface VideoPlayerPlugin {\n  /**\n   * Initialize a video player\n   *\n   */\n  initPlayer(options: capVideoPlayerOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Return if a given playerId is playing\n   *\n   */\n  isPlaying(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Play the current video from a given playerId\n   *\n   */\n  play(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Pause the current video from a given playerId\n   *\n   */\n  pause(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Get the duration of the current video from a given playerId\n   *\n   */\n  getDuration(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Get the current time of the current video from a given playerId\n   *\n   */\n  getCurrentTime(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Set the current time to seek the current video to from a given playerId\n   *\n   */\n  setCurrentTime(options: capVideoTimeOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Get the volume of the current video from a given playerId\n   *\n   */\n  getVolume(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Set the volume of the current video to from a given playerId\n   *\n   */\n  setVolume(options: capVideoVolumeOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Get the muted of the current video from a given playerId\n   *\n   */\n  getMuted(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Set the muted of the current video to from a given playerId\n   *\n   */\n  setMuted(options: capVideoMutedOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Set the rate of the current video from a given playerId\n   *\n   */\n  setRate(options: capVideoRateOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Get the rate of the current video from a given playerId\n   *\n   */\n  getRate(options: capVideoPlayerIdOptions): Promise<capVideoPlayerResult>;\n  /**\n   * Stop all players playing\n   *\n   */\n  stopAllPlayers(): Promise<capVideoPlayerResult>;\n  /**\n   * Show controller\n   *\n   */\n  showController(): Promise<capVideoPlayerResult>;\n  /**\n   * isControllerIsFullyVisible\n   *\n   */\n  isControllerIsFullyVisible(): Promise<capVideoPlayerResult>;\n  /**\n   * Exit player\n   *\n   */\n  exitPlayer(): Promise<capVideoPlayerResult>;\n  /**\n   * Hide the currently presented player UI without stopping playback (native fullscreen).\n   *\n   * Call `showPlayer()` to show it again.\n   */\n  hidePlayer(): Promise<capVideoPlayerResult>;\n  /**\n   * Show again a previously hidden player UI (native fullscreen).\n   */\n  showPlayer(): Promise<capVideoPlayerResult>;\n  /**\n   * Get the native Capacitor plugin version.\n   * On web, the implementation returns `\"web\"`.\n   *\n   * @returns Promise resolving to the plugin version string for this build (`\"web\"` on web)\n   */\n  getPluginVersion(): Promise<{ version: string }>;\n}\nexport interface capEchoOptions {\n  /**\n   *  String to be echoed\n   */\n\n  value?: string;\n}\nexport interface capVideoPlayerOptions {\n  /**\n   * Player mode\n   *  - \"fullscreen\"\n   *  - \"embedded\" (Web only)\n   */\n  mode?: string;\n  /**\n   * The url of the video to play\n   */\n  url?: string;\n  /**\n   * Optional override URL used when casting to Chromecast (iOS, Android).\n   *\n   * This lets you cast an alternative rendition/manifest (e.g. MPEG-DASH + Widevine)\n   * while keeping the on-device playback URL unchanged (e.g. HLS + FairPlay on iOS).\n   */\n  chromecastUrl?: string;\n  /**\n   * The url of subtitle associated with the video\n   *\n   * Prefer `subtitles` when providing more than one track.\n   * Kept for backward compatibility.\n   */\n  subtitle?: string;\n  /**\n   * The language of subtitle\n   * see https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers\n   *\n   * Prefer `subtitles` when providing more than one track.\n   * Kept for backward compatibility.\n   */\n  language?: string;\n  /**\n   * Multiple subtitle tracks (iOS, Android).\n   * When provided, takes precedence over `subtitle` / `language`.\n   */\n  subtitles?: VideoSubtitle[];\n  /**\n   * Chapter markers for long-form content (iOS, Android).\n   * Shown as a chapter list in the native fullscreen player; selecting a chapter seeks to `startTime`.\n   */\n  chapters?: VideoChapter[];\n  /**\n   * SubTitle Options\n   */\n  subtitleOptions?: SubTitleOptions;\n  /**\n   * Id of DIV Element parent of the player\n   */\n  playerId?: string;\n  /**\n   * Initial playing rate\n   */\n  rate?: number;\n  /**\n   * Exit on VideoEnd (iOS, Android)\n   * default: true\n   */\n  exitOnEnd?: boolean;\n  /**\n   * Loop on VideoEnd when exitOnEnd false (iOS, Android)\n   * default: false\n   */\n  loopOnEnd?: boolean;\n  /**\n   * Picture in Picture Enable (iOS, Android)\n   * default: true\n   */\n  pipEnabled?: boolean;\n  /**\n   * Background Mode Enable (iOS, Android)\n   * default: true\n   */\n  bkmodeEnabled?: boolean;\n  /**\n   * iOS audio session category behavior (iOS).\n   * - \"ambient\": respects the iPhone silent switch\n   * - \"playback\": ignores the iPhone silent switch\n   * - \"moviePlayback\": playback optimized for video and long-form AirPlay.\n   *\n   * When omitted, the plugin resolves the category from other options: `\"playback\"` if\n   * `pipEnabled` or `bkmodeEnabled` is true (both default to true), otherwise `\"ambient\"`.\n   */\n  audioCategory?: 'ambient' | 'playback' | 'moviePlayback';\n  /**\n   * Show Controls Enable (iOS, Android)\n   * default: true\n   */\n  showControls?: boolean;\n  /**\n   * Display Mode [\"all\", \"portrait\", \"landscape\"] (iOS, Android)\n   * default: \"all\"\n   */\n  displayMode?: string;\n  /**\n   * Component Tag or DOM Element Tag (React app)\n   */\n  componentTag?: string;\n  /**\n   * Player Width (mode \"embedded\" only)\n   */\n  width?: number;\n  /**\n   * Player height (mode \"embedded\" only)\n   */\n  height?: number;\n  /**\n   * Headers for the request (iOS, Android)\n   * by Manuel García Marín (https://github.com/PhantomPainX)\n   */\n  headers?: {\n    [key: string]: string;\n  };\n  /**\n   * Title shown in the player and Chromecast metadata (iOS, Android)\n   * by Manuel García Marín (https://github.com/PhantomPainX)\n   */\n  title?: string;\n  /**\n   * Subtitle shown below the title in the player and Chromecast metadata (iOS, Android)\n   * by Manuel García Marín (https://github.com/PhantomPainX)\n   */\n  smallTitle?: string;\n  /**\n   * ExoPlayer Progress Bar and Spinner color (Android)\n   * by Manuel García Marín (https://github.com/PhantomPainX)\n   * Must be a valid hex color code\n   * default: #FFFFFF\n   */\n  accentColor?: string;\n  /**\n   * Chromecast enable/disable (iOS, Android)\n   * iOS requires Google Cast SDK setup and local network Info.plist keys.\n   * by Manuel García Marín (https://github.com/PhantomPainX)\n   * default: true\n   */\n  chromecast?: boolean;\n  /**\n   * Artwork url to be shown in Chromecast player (iOS, Android)\n   * by Manuel García Marín (https://github.com/PhantomPainX)\n   * default: \"\"\n   */\n  artwork?: string;\n  /**\n   * DRM configuration for protected content (iOS: FairPlay, Android: Widevine)\n   *\n   * When casting, Widevine's `certificateUrl` (license URL) is also forwarded to Chromecast\n   * receivers as `media.customData.laurl`.\n   */\n  drm?: DrmOptions;\n}\nexport interface capVideoPlayerIdOptions {\n  /**\n   * Id of DIV Element parent of the player\n   */\n  playerId?: string;\n}\nexport interface capVideoRateOptions {\n  /**\n   * Id of DIV Element parent of the player\n   */\n  playerId?: string;\n  /**\n   * Rate value\n   */\n  rate?: number;\n}\nexport interface capVideoVolumeOptions {\n  /**\n   * Id of DIV Element parent of the player\n   */\n  playerId?: string;\n  /**\n   * Volume value between [0 - 1]\n   */\n  volume?: number;\n}\nexport interface capVideoTimeOptions {\n  /**\n   * Id of DIV Element parent of the player\n   */\n  playerId?: string;\n  /**\n   * Video time value you want to seek to\n   */\n  seektime?: number;\n}\nexport interface capVideoMutedOptions {\n  /**\n   * Id of DIV Element parent of the player\n   */\n  playerId?: string;\n  /**\n   * Muted value true or false\n   */\n  muted?: boolean;\n}\nexport interface capVideoListener {\n  /**\n   * Id of DIV Element parent of the player\n   */\n  playerId?: string;\n  /**\n   * Video current time when listener triggered\n   */\n  currentTime?: number;\n}\nexport interface capExitListener {\n  /**\n   * Dismiss value true or false\n   */\n  dismiss?: boolean;\n  /**\n   * Video current time when listener triggered\n   */\n  currentTime?: number;\n}\nexport interface capVideoPlayerResult {\n  /**\n   * result set to true when successful else false\n   */\n  result?: boolean;\n  /**\n   * method name\n   */\n  method?: string;\n  /**\n   * value returned\n   */\n  value?: any;\n  /**\n   * message string\n   */\n  message?: string;\n}\nexport interface VideoSubtitle {\n  /**\n   * The url of the subtitle file (vtt, srt, ...)\n   */\n  subtitle: string;\n  /**\n   * The language of the subtitle\n   * see https://github.com/libyal/libfwnt/wiki/Language-Code-identifiers\n   */\n  language?: string;\n}\nexport interface VideoChapter {\n  /**\n   * Chapter title shown in the chapter list\n   */\n  title: string;\n  /**\n   * Start time in seconds\n   */\n  startTime: number;\n  /**\n   * End time in seconds (optional). Stored for future timeline markers; chapter jumps use `startTime` only in this release.\n   */\n  endTime?: number;\n}\n/**\n * Optional styling for on-screen subtitles.\n *\n * On iOS, colors and font size are applied through `AVPlayerItem`\n * `textStyleRules`, which Apple documents for WebVTT only. IMSC1 and other\n * in-manifest timed text formats are not styled through this API.\n * Inline WebVTT cue styles can take precedence over equivalent\n * `subtitleOptions` values; the plugin sets text style rules as a platform\n * fallback, not a guaranteed override of authored cue styling.\n */\nexport interface SubTitleOptions {\n  /**\n   * Foreground color in RGBA. On Android, when the plugin applies subtitle\n   * styling, omitted values fall back to `rgba(255,255,255,1)`. When\n   * `subtitleOptions` is absent, embedded cue colors from the media can\n   * override that fallback. On iOS, omitted colors are not set by the plugin;\n   * the platform uses the viewer's caption appearance settings instead of fixed\n   * plugin defaults.\n   */\n  foregroundColor?: string;\n  /**\n   * Background color in RGBA. On Android, when the plugin applies subtitle\n   * styling in fullscreen, omitted values fall back to `rgba(0,0,0,1)`. In\n   * picture-in-picture, omitted values fall back to transparent when the plugin\n   * applies its caption style (for example sidecar subtitles or non-empty\n   * `subtitleOptions` that include a color override). An empty\n   * `subtitleOptions` object alone does not select that fallback. With\n   * font-size-only options, embedded cue styles stay enabled, so authored cue\n   * backgrounds can remain visible in PiP. When `subtitleOptions` is absent,\n   * embedded cue colors from the media can override the fallback. On iOS,\n   * omitted colors are not set by the plugin; the platform uses the viewer's\n   * caption appearance settings instead of fixed plugin defaults.\n   */\n  backgroundColor?: string;\n  /**\n   * Font size in CSS pixels. On Android, supplied values are rounded to the\n   * nearest integer before applying. When omitted on embedded tracks without a\n   * sidecar subtitle URI, Android uses `SubtitleView.setUserDefaultTextSize()`\n   * (the user's system caption size), not a fixed 16 px size. Sidecar subtitles\n   * still use a fixed default size when this property is omitted. On iOS,\n   * values map to AVFoundation relative size where 16 equals the system default\n   * (100%).\n   */\n  fontSize?: number;\n}\nexport interface FairPlayDrmOptions {\n  /**\n   * The URL to fetch the FairPlay certificate\n   */\n  certificateUrl?: string;\n  /**\n   * The URL to send the SPC and receive the CKC license (FairPlay license server URL)\n   */\n  contentKeySpcUrl?: string;\n  /**\n   * Optional FairPlay asset identifier used when generating the SPC.\n   * Defaults to the `skd://` content identifier from the key request.\n   */\n  assetId?: string;\n}\nexport interface PlayreadyDrmOptions {\n  /**\n   * The URL to fetch the PlayReady license\n   */\n  certificateUrl?: string;\n}\nexport interface WidevineDrmOptions {\n  /**\n   * The URL to fetch the Widevine license\n   */\n  certificateUrl?: string;\n}\nexport interface DrmOptions {\n  /**\n   * FairPlay DRM configuration (iOS)\n   */\n  fairplay?: FairPlayDrmOptions;\n  /**\n   * PlayReady DRM configuration\n   */\n  playready?: PlayreadyDrmOptions;\n  /**\n   * Widevine DRM configuration (Android)\n   */\n  widevine?: WidevineDrmOptions;\n}\n"]}

package/ios/Sources/VideoPlayerPlugin/AVPlayerControlsVisibilityObserver.swift

@@ -221,7 +221,20 @@ enum VideoPlayerCastSeekSync {
 }
 
 enum VideoPlayerCastOverlayLayout {
+    static let topRowOffset: CGFloat = 60
+    static let trailingInset: CGFloat = 16
+    static let controlSize: CGFloat = 44
+    static let verticalStackSpacing: CGFloat = 8
+
     static func overlayView(for playerViewController: AVPlayerViewController) -> UIView? {
         playerViewController.contentOverlayView
     }
+
+    /// Cast uses the top trailing slot; chapter stacks below when Cast overlay is enabled.
+    static func chapterButtonTopOffset(chromecastEnabled: Bool) -> CGFloat {
+        guard chromecastEnabled else {
+            return topRowOffset
+        }
+        return topRowOffset + controlSize + verticalStackSpacing
+    }
 }