capacitor-plugin-playlist 0.6.2 → 0.7.0

package/dist/docs.json

@@ -12,12 +12,12 @@
           {
             "name": "eventName",
             "docs": "",
-            "type": "\"status\""
+            "type": "'status'"
           },
           {
             "name": "listenerFunc",
             "docs": "",
-            "type": "(data: PlaylistStatusChangeCallbackArg) => void"
+            "type": "PlaylistStatusChangeCallback"
           }
         ],
         "returns": "Promise<PluginListenerHandle>",
@@ -27,7 +27,7 @@
           "PluginListenerHandle",
           "PlaylistStatusChangeCallback"
         ],
-        "slug": "addlistener"
+        "slug": "addlistenerstatus-"
       },
       {
         "name": "setOptions",
@@ -371,6 +371,282 @@
         }
       ]
     },
+    {
+      "name": "PlaylistStatusChangeCallbackArg",
+      "slug": "playliststatuschangecallbackarg",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "action",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "status",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "OnStatusCallbackData"
+          ],
+          "type": "OnStatusCallbackData"
+        }
+      ]
+    },
+    {
+      "name": "OnStatusCallbackData",
+      "slug": "onstatuscallbackdata",
+      "docs": "Encapsulates the data received by an onStatus callback",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "trackId",
+          "tags": [],
+          "docs": "The ID of this track. If the track is null or has completed, this value is \"NONE\"\nIf the playlist is completed, this value is \"INVALID\"",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "msgType",
+          "tags": [],
+          "docs": "The type of status update",
+          "complexTypes": [
+            "RmxAudioStatusMessage"
+          ],
+          "type": "RmxAudioStatusMessage"
+        },
+        {
+          "name": "value",
+          "tags": [],
+          "docs": "The status payload. For all updates except ERROR, the data package is described by OnStatusCallbackUpdateData.\nFor Errors, the data is shaped as OnStatusErrorCallbackData",
+          "complexTypes": [
+            "OnStatusCallbackUpdateData",
+            "OnStatusTrackChangedData",
+            "OnStatusErrorCallbackData"
+          ],
+          "type": "OnStatusCallbackUpdateData | OnStatusTrackChangedData | OnStatusErrorCallbackData"
+        }
+      ]
+    },
+    {
+      "name": "OnStatusCallbackUpdateData",
+      "slug": "onstatuscallbackupdatedata",
+      "docs": "Contains the current track status as of the moment an onStatus update event is emitted.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "trackId",
+          "tags": [],
+          "docs": "The ID of this track corresponding to this event. If the track is null or has completed, this value is \"NONE\".\nThis will happen when skipping to the beginning or end of the playlist.\nIf the playlist is completed, this value is \"INVALID\"",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "isStream",
+          "tags": [],
+          "docs": "Boolean indicating whether this is a streaming track.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "currentIndex",
+          "tags": [],
+          "docs": "The current index of the track in the playlist.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "status",
+          "tags": [],
+          "docs": "The current status of the track, as a string. This is used\nto summarize the various event states that a track can be in; e.g. \"playing\" is true for any number\nof track statuses. The Javascript interface takes care of this for you; this field is here only for reference.",
+          "complexTypes": [],
+          "type": "'error' | 'unknown' | 'ready' | 'playing' | 'loading' | 'paused'"
+        },
+        {
+          "name": "currentPosition",
+          "tags": [],
+          "docs": "Current playback position of the reported track.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "duration",
+          "tags": [],
+          "docs": "The known duration of the reported track. For streams or malformed MP3's, this value will be 0.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "playbackPercent",
+          "tags": [],
+          "docs": "Progress of track playback, as a percent, in the range 0 - 100",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "bufferPercent",
+          "tags": [],
+          "docs": "Buffering progress of the track, as a percent, in the range 0 - 100",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "bufferStart",
+          "tags": [],
+          "docs": "The starting position of the buffering progress. For now, this is always reported as 0.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "bufferEnd",
+          "tags": [],
+          "docs": "The maximum position, in seconds, of the track buffer. For now, only the buffer with the maximum\nplayback position is reported, even if there are other segments (due to seeking, for example).\nPractically speaking you don't need to worry about that, as in both implementations the\nminor gaps are automatically filled in by the underlying players.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "OnStatusTrackChangedData",
+      "slug": "onstatustrackchangeddata",
+      "docs": "Reports information about the playlist state when a track changes.\nIncludes the new track, its index, and the state of the playlist.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "currentItem",
+          "tags": [],
+          "docs": "The new track that has been selected. May be null if you are at the end of the playlist,\nor the playlist has been emptied.",
+          "complexTypes": [
+            "AudioTrack"
+          ],
+          "type": "AudioTrack"
+        },
+        {
+          "name": "currentIndex",
+          "tags": [],
+          "docs": "The 0-based index of the new track. If the playlist has ended or been cleared, this will be -1.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "isAtEnd",
+          "tags": [],
+          "docs": "Indicates whether the playlist is now currently at the last item in the list.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "isAtBeginning",
+          "tags": [],
+          "docs": "Indicates whether the playlist is now at the first item in the list",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "hasNext",
+          "tags": [],
+          "docs": "Indicates if there are additional playlist items after the current item.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "hasPrevious",
+          "tags": [],
+          "docs": "Indicates if there are any items before this one in the playlist.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "AudioTrack",
+      "slug": "audiotrack",
+      "docs": "An audio track for playback by the playlist.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "isStream",
+          "tags": [],
+          "docs": "This item is a streaming asset. Make sure this is set to true for stream URLs,\notherwise you will get odd behavior when the asset is paused.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "trackId",
+          "tags": [],
+          "docs": "trackId is optional and if not passed in, an auto-generated UUID will be used.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "assetUrl",
+          "tags": [],
+          "docs": "URL of the asset; can be local, a URL, or a streaming URL.\nIf the asset is a stream, make sure that isStream is set to true,\notherwise the plugin can't properly handle the item's buffer.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "albumArt",
+          "tags": [],
+          "docs": "The local or remote URL to an image asset to be shown for this track.\nIf this is null, the plugin's default image is used.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "artist",
+          "tags": [],
+          "docs": "The track's artist",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "album",
+          "tags": [],
+          "docs": "Album the track belongs to",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "title",
+          "tags": [],
+          "docs": "Title of the track",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "OnStatusErrorCallbackData",
+      "slug": "onstatuserrorcallbackdata",
+      "docs": "Represents an error reported by the onStatus callback.",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "code",
+          "tags": [],
+          "docs": "Error code",
+          "complexTypes": [
+            "RmxAudioErrorType"
+          ],
+          "type": "RmxAudioErrorType"
+        },
+        {
+          "name": "message",
+          "tags": [],
+          "docs": "The error, as a message",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
     {
       "name": "AudioPlayerOptions",
       "slug": "audioplayeroptions",
@@ -399,7 +675,7 @@
           "complexTypes": [
             "NotificationOptions"
           ],
-          "type": "NotificationOptions | undefined"
+          "type": "NotificationOptions"
         }
       ]
     },
@@ -434,7 +710,7 @@
             "Array",
             "AudioTrack"
           ],
-          "type": "AudioTrack[]"
+          "type": "Array<AudioTrack>"
         },
         {
           "name": "options",
@@ -1284,64 +1560,6 @@
         }
       ]
     },
-    {
-      "name": "AudioTrack",
-      "slug": "audiotrack",
-      "docs": "An audio track for playback by the playlist.",
-      "tags": [],
-      "methods": [],
-      "properties": [
-        {
-          "name": "isStream",
-          "tags": [],
-          "docs": "This item is a streaming asset. Make sure this is set to true for stream URLs,\notherwise you will get odd behavior when the asset is paused.",
-          "complexTypes": [],
-          "type": "boolean | undefined"
-        },
-        {
-          "name": "trackId",
-          "tags": [],
-          "docs": "trackId is optional and if not passed in, an auto-generated UUID will be used.",
-          "complexTypes": [],
-          "type": "string | undefined"
-        },
-        {
-          "name": "assetUrl",
-          "tags": [],
-          "docs": "URL of the asset; can be local, a URL, or a streaming URL.\nIf the asset is a stream, make sure that isStream is set to true,\notherwise the plugin can't properly handle the item's buffer.",
-          "complexTypes": [],
-          "type": "string"
-        },
-        {
-          "name": "albumArt",
-          "tags": [],
-          "docs": "The local or remote URL to an image asset to be shown for this track.\nIf this is null, the plugin's default image is used.",
-          "complexTypes": [],
-          "type": "string | undefined"
-        },
-        {
-          "name": "artist",
-          "tags": [],
-          "docs": "The track's artist",
-          "complexTypes": [],
-          "type": "string"
-        },
-        {
-          "name": "album",
-          "tags": [],
-          "docs": "Album the track belongs to",
-          "complexTypes": [],
-          "type": "string"
-        },
-        {
-          "name": "title",
-          "tags": [],
-          "docs": "Title of the track",
-          "complexTypes": [],
-          "type": "string"
-        }
-      ]
-    },
     {
       "name": "PlaylistItemOptions",
       "slug": "playlistitemoptions",
@@ -1412,7 +1630,7 @@
             "Array",
             "AudioTrack"
           ],
-          "type": "AudioTrack[]"
+          "type": "Array<AudioTrack>"
         }
       ]
     },
@@ -1454,7 +1672,7 @@
             "Array",
             "RemoveItemOptions"
           ],
-          "type": "RemoveItemOptions[]"
+          "type": "Array<RemoveItemOptions>"
         }
       ]
     },
@@ -1615,5 +1833,208 @@
       ]
     }
   ],
-  "enums": []
+  "enums": [
+    {
+      "name": "RmxAudioStatusMessage",
+      "slug": "rmxaudiostatusmessage",
+      "members": [
+        {
+          "name": "RMXSTATUS_NONE",
+          "value": "0",
+          "tags": [],
+          "docs": "The starting state of the plugin. You will never see this value;\nit changes before the callbacks are even registered to report changes to this value."
+        },
+        {
+          "name": "RMXSTATUS_REGISTER",
+          "value": "1",
+          "tags": [],
+          "docs": "Raised when the plugin registers the callback handler for onStatus callbacks.\nYou will probably not be able to see this (nor do you need to)."
+        },
+        {
+          "name": "RMXSTATUS_INIT",
+          "value": "2",
+          "tags": [],
+          "docs": "Reserved for future use"
+        },
+        {
+          "name": "RMXSTATUS_ERROR",
+          "value": "5",
+          "tags": [],
+          "docs": "Indicates an error is reported in the 'value' field."
+        },
+        {
+          "name": "RMXSTATUS_LOADING",
+          "value": "10",
+          "tags": [],
+          "docs": "The reported track is being loaded by the player"
+        },
+        {
+          "name": "RMXSTATUS_CANPLAY",
+          "value": "11",
+          "tags": [],
+          "docs": "The reported track is able to begin playback"
+        },
+        {
+          "name": "RMXSTATUS_LOADED",
+          "value": "15",
+          "tags": [],
+          "docs": "The reported track has loaded 100% of the file (either from disc or network)"
+        },
+        {
+          "name": "RMXSTATUS_STALLED",
+          "value": "20",
+          "tags": [],
+          "docs": "(iOS only): Playback has stalled due to insufficient network"
+        },
+        {
+          "name": "RMXSTATUS_BUFFERING",
+          "value": "25",
+          "tags": [],
+          "docs": "Reports an update in the reported track's buffering status"
+        },
+        {
+          "name": "RMXSTATUS_PLAYING",
+          "value": "30",
+          "tags": [],
+          "docs": "The reported track has started (or resumed) playing"
+        },
+        {
+          "name": "RMXSTATUS_PAUSE",
+          "value": "35",
+          "tags": [],
+          "docs": "The reported track has been paused, either by the user or by the system.\n(iOS only): This value is raised when MP3's are malformed (but still playable).\nThese require the user to explicitly press play again. This can be worked\naround and is on the TODO list."
+        },
+        {
+          "name": "RMXSTATUS_PLAYBACK_POSITION",
+          "value": "40",
+          "tags": [],
+          "docs": "Reports a change in the reported track's playback position."
+        },
+        {
+          "name": "RMXSTATUS_SEEK",
+          "value": "45",
+          "tags": [],
+          "docs": "The reported track has seeked.\nOn Android, only the plugin consumer can generate this (Notification controls on Android do not include a seek bar).\nOn iOS, the Command Center includes a seek bar so this will be reported when the user has seeked via Command Center."
+        },
+        {
+          "name": "RMXSTATUS_COMPLETED",
+          "value": "50",
+          "tags": [],
+          "docs": "The reported track has completed playback."
+        },
+        {
+          "name": "RMXSTATUS_DURATION",
+          "value": "55",
+          "tags": [],
+          "docs": "The reported track's duration has changed. This is raised once, when duration is updated for the first time.\nFor streams, this value is never reported."
+        },
+        {
+          "name": "RMXSTATUS_STOPPED",
+          "value": "60",
+          "tags": [],
+          "docs": "All playback has stopped, probably because the plugin is shutting down."
+        },
+        {
+          "name": "RMX_STATUS_SKIP_FORWARD",
+          "value": "90",
+          "tags": [],
+          "docs": "The playlist has skipped forward to the next track.\nOn both Android and iOS, this will be raised if the notification controls/Command Center were used to skip.\nIt is unlikely you need to consume this event: RMXSTATUS_TRACK_CHANGED is also reported when this occurs,\nso you can generalize your track change handling in one place."
+        },
+        {
+          "name": "RMX_STATUS_SKIP_BACK",
+          "value": "95",
+          "tags": [],
+          "docs": "The playlist has skipped back to the previous track.\nOn both Android and iOS, this will be raised if the notification controls/Command Center were used to skip.\nIt is unlikely you need to consume this event: RMXSTATUS_TRACK_CHANGED is also reported when this occurs,\nso you can generalize your track change handling in one place."
+        },
+        {
+          "name": "RMXSTATUS_TRACK_CHANGED",
+          "value": "100",
+          "tags": [],
+          "docs": "Reported when the current track has changed in the native player. This event contains full data about\nthe new track, including the index and the actual track itself. The type of the 'value' field in this case\nis OnStatusTrackChangedData."
+        },
+        {
+          "name": "RMXSTATUS_PLAYLIST_COMPLETED",
+          "value": "105",
+          "tags": [],
+          "docs": "The entire playlist has completed playback.\nAfter this event has been raised, the current item is set to null and the current index to -1."
+        },
+        {
+          "name": "RMXSTATUS_ITEM_ADDED",
+          "value": "110",
+          "tags": [],
+          "docs": "An item has been added to the playlist. For the setPlaylistItems and addAllItems methods, this status is\nraised once for every track in the collection."
+        },
+        {
+          "name": "RMXSTATUS_ITEM_REMOVED",
+          "value": "115",
+          "tags": [],
+          "docs": "An item has been removed from the playlist. For the removeItems and clearAllItems methods, this status is\nraised once for every track that was removed."
+        },
+        {
+          "name": "RMXSTATUS_PLAYLIST_CLEARED",
+          "value": "120",
+          "tags": [],
+          "docs": "All items have been removed from the playlist"
+        },
+        {
+          "name": "RMXSTATUS_VIEWDISAPPEAR",
+          "value": "200",
+          "tags": [],
+          "docs": "Just for testing.. you don't need this and in fact can never receive it, the plugin is destroyed before it can be raised."
+        }
+      ]
+    },
+    {
+      "name": "RmxAudioErrorType",
+      "slug": "rmxaudioerrortype",
+      "members": [
+        {
+          "name": "RMXERR_NONE_ACTIVE",
+          "value": "0",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "RMXERR_ABORTED",
+          "value": "1",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "RMXERR_NETWORK",
+          "value": "2",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "RMXERR_DECODE",
+          "value": "3",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "RMXERR_NONE_SUPPORTED",
+          "value": "4",
+          "tags": [],
+          "docs": ""
+        }
+      ]
+    }
+  ],
+  "typeAliases": [
+    {
+      "name": "PlaylistStatusChangeCallback",
+      "slug": "playliststatuschangecallback",
+      "docs": "",
+      "types": [
+        {
+          "text": "(data: PlaylistStatusChangeCallbackArg): void",
+          "complexTypes": [
+            "PlaylistStatusChangeCallbackArg"
+          ]
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
 }

package/dist/esm/web.d.ts

@@ -30,6 +30,8 @@ export declare class PlaylistWeb extends WebPlugin implements PlaylistPlugin {
     skipForward(): Promise<void>;
     skipBack(): Promise<void>;
     setPlaybackRate(options: SetPlaybackRateOptions): Promise<void>;
+    setMediaSessionRemoteControlMetadata(): Promise<void>;
+    mediaSessionControlsHandler(actionDetails: MediaSessionActionDetails): Promise<void>;
     registerHtmlListeners(position?: number): void;
     protected getCurrentTrackId(): string | undefined;
     protected getCurrentIndex(): number;

package/dist/esm/web.js

@@ -193,6 +193,48 @@ export class PlaylistWeb extends WebPlugin {
         }
         return Promise.reject();
     }
+    async setMediaSessionRemoteControlMetadata() {
+        const audioTrack = this.currentTrack;
+        if (!navigator.mediaSession) {
+            console.warn('Media Session API not available');
+            return Promise.reject();
+        }
+        navigator.mediaSession.metadata = new MediaMetadata({
+            title: audioTrack.title,
+            artist: audioTrack.artist,
+            album: audioTrack.album,
+            artwork: [
+                { src: audioTrack.albumArt, sizes: '96x96', type: 'image/jpeg' },
+                { src: audioTrack.albumArt, sizes: '128x128', type: 'image/jpeg' },
+                { src: audioTrack.albumArt, sizes: '192x192', type: 'image/jpeg' },
+                { src: audioTrack.albumArt, sizes: '256x256', type: 'image/jpeg' },
+                { src: audioTrack.albumArt, sizes: '384x384', type: 'image/jpeg' },
+                { src: audioTrack.albumArt, sizes: '512x512', type: 'image/jpeg' },
+            ]
+        });
+        navigator.mediaSession.setActionHandler('play', (details) => { this.mediaSessionControlsHandler(details); });
+        navigator.mediaSession.setActionHandler('pause', (details) => { this.mediaSessionControlsHandler(details); });
+        navigator.mediaSession.setActionHandler('nexttrack', (details) => { this.mediaSessionControlsHandler(details); });
+        navigator.mediaSession.setActionHandler('previoustrack', (details) => { this.mediaSessionControlsHandler(details); });
+        return Promise.resolve();
+    }
+    async mediaSessionControlsHandler(actionDetails) {
+        switch (actionDetails.action) {
+            case 'play':
+                this.play();
+                break;
+            case 'pause':
+                this.pause();
+                break;
+            case 'nexttrack':
+                this.skipForward();
+                break;
+            case 'previoustrack':
+                this.skipBack();
+                break;
+        }
+        return Promise.resolve();
+    }
     // register events
     /*
       private registerHlsListeners(hls: Hls, position?: number) {
@@ -220,6 +262,7 @@ export class PlaylistWeb extends WebPlugin {
             (_a = this.audio) === null || _a === void 0 ? void 0 : _a.removeEventListener('canplay', canPlayListener);
         };
         if (this.audio) {
+            this.audio.addEventListener('loadstart', () => { this.setMediaSessionRemoteControlMetadata(); });
             this.audio.addEventListener('canplay', canPlayListener);
             this.audio.addEventListener('playing', () => {
                 this.updateStatus(RmxAudioStatusMessage.RMXSTATUS_PLAYING, this.getCurrentTrackStatus('playing'));