capacitor-plugin-playlist 0.4.0 → 0.4.2

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": "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",
@@ -379,129 +655,908 @@
       "methods": [],
       "properties": [
         {
-          "name": "verbose",
-          "tags": [],
-          "docs": "Should the plugin's javascript dump the status message stream to the javascript console?",
-          "complexTypes": [],
-          "type": "boolean | undefined"
+          "name": "verbose",
+          "tags": [],
+          "docs": "Should the plugin's javascript dump the status message stream to the javascript console?",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "resetStreamOnPause",
+          "tags": [],
+          "docs": "If true, when pausing a live stream, play will continue from the LIVE POSITION (e.g. the stream\njumps forward to the current point in time, rather than picking up where it left off when you paused).\nIf false, the stream will continue where you paused. The drawback of doing this is that when the audio\nbuffer fills, it will jump forward to the current point in time, cause a disjoint in playback.\n\nDefault is true.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "options",
+          "tags": [],
+          "docs": "Further options for notifications",
+          "complexTypes": [
+            "NotificationOptions"
+          ],
+          "type": "NotificationOptions"
+        }
+      ]
+    },
+    {
+      "name": "NotificationOptions",
+      "slug": "notificationoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "icon",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PlaylistOptions",
+      "slug": "playlistoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "items",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "Array",
+            "AudioTrack"
+          ],
+          "type": "Array<AudioTrack>"
+        },
+        {
+          "name": "options",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [
+            "PlaylistItemOptions"
+          ],
+          "type": "PlaylistItemOptions"
+        }
+      ]
+    },
+    {
+      "name": "Array",
+      "slug": "array",
+      "docs": "",
+      "tags": [],
+      "methods": [
+        {
+          "name": "toString",
+          "signature": "() => string",
+          "parameters": [],
+          "returns": "string",
+          "tags": [],
+          "docs": "Returns a string representation of an array.",
+          "complexTypes": [],
+          "slug": "tostring"
+        },
+        {
+          "name": "toLocaleString",
+          "signature": "() => string",
+          "parameters": [],
+          "returns": "string",
+          "tags": [],
+          "docs": "Returns a string representation of an array. The elements are converted to string using their toLocalString methods.",
+          "complexTypes": [],
+          "slug": "tolocalestring"
+        },
+        {
+          "name": "pop",
+          "signature": "() => T | undefined",
+          "parameters": [],
+          "returns": "T | undefined",
+          "tags": [],
+          "docs": "Removes the last element from an array and returns it.\r\nIf the array is empty, undefined is returned and the array is not modified.",
+          "complexTypes": [
+            "T"
+          ],
+          "slug": "pop"
+        },
+        {
+          "name": "push",
+          "signature": "(...items: T[]) => number",
+          "parameters": [
+            {
+              "name": "items",
+              "docs": "New elements to add to the array.",
+              "type": "T[]"
+            }
+          ],
+          "returns": "number",
+          "tags": [
+            {
+              "name": "param",
+              "text": "items New elements to add to the array."
+            }
+          ],
+          "docs": "Appends new elements to the end of an array, and returns the new length of the array.",
+          "complexTypes": [
+            "T"
+          ],
+          "slug": "push"
+        },
+        {
+          "name": "concat",
+          "signature": "(...items: ConcatArray<T>[]) => T[]",
+          "parameters": [
+            {
+              "name": "items",
+              "docs": "Additional arrays and/or items to add to the end of the array.",
+              "type": "ConcatArray<T>[]"
+            }
+          ],
+          "returns": "T[]",
+          "tags": [
+            {
+              "name": "param",
+              "text": "items Additional arrays and/or items to add to the end of the array."
+            }
+          ],
+          "docs": "Combines two or more arrays.\r\nThis method returns a new array without modifying any existing arrays.",
+          "complexTypes": [
+            "T",
+            "ConcatArray"
+          ],
+          "slug": "concat"
+        },
+        {
+          "name": "concat",
+          "signature": "(...items: (T | ConcatArray<T>)[]) => T[]",
+          "parameters": [
+            {
+              "name": "items",
+              "docs": "Additional arrays and/or items to add to the end of the array.",
+              "type": "(T | ConcatArray<T>)[]"
+            }
+          ],
+          "returns": "T[]",
+          "tags": [
+            {
+              "name": "param",
+              "text": "items Additional arrays and/or items to add to the end of the array."
+            }
+          ],
+          "docs": "Combines two or more arrays.\r\nThis method returns a new array without modifying any existing arrays.",
+          "complexTypes": [
+            "T",
+            "ConcatArray"
+          ],
+          "slug": "concat"
+        },
+        {
+          "name": "join",
+          "signature": "(separator?: string | undefined) => string",
+          "parameters": [
+            {
+              "name": "separator",
+              "docs": "A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.",
+              "type": "string | undefined"
+            }
+          ],
+          "returns": "string",
+          "tags": [
+            {
+              "name": "param",
+              "text": "separator A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma."
+            }
+          ],
+          "docs": "Adds all the elements of an array into a string, separated by the specified separator string.",
+          "complexTypes": [],
+          "slug": "join"
+        },
+        {
+          "name": "reverse",
+          "signature": "() => T[]",
+          "parameters": [],
+          "returns": "T[]",
+          "tags": [],
+          "docs": "Reverses the elements in an array in place.\r\nThis method mutates the array and returns a reference to the same array.",
+          "complexTypes": [
+            "T"
+          ],
+          "slug": "reverse"
+        },
+        {
+          "name": "shift",
+          "signature": "() => T | undefined",
+          "parameters": [],
+          "returns": "T | undefined",
+          "tags": [],
+          "docs": "Removes the first element from an array and returns it.\r\nIf the array is empty, undefined is returned and the array is not modified.",
+          "complexTypes": [
+            "T"
+          ],
+          "slug": "shift"
+        },
+        {
+          "name": "slice",
+          "signature": "(start?: number | undefined, end?: number | undefined) => T[]",
+          "parameters": [
+            {
+              "name": "start",
+              "docs": "The beginning index of the specified portion of the array.\r\nIf start is undefined, then the slice begins at index 0.",
+              "type": "number | undefined"
+            },
+            {
+              "name": "end",
+              "docs": "The end index of the specified portion of the array. This is exclusive of the element at the index 'end'.\r\nIf end is undefined, then the slice extends to the end of the array.",
+              "type": "number | undefined"
+            }
+          ],
+          "returns": "T[]",
+          "tags": [
+            {
+              "name": "param",
+              "text": "start The beginning index of the specified portion of the array.\r\nIf start is undefined, then the slice begins at index 0."
+            },
+            {
+              "name": "param",
+              "text": "end The end index of the specified portion of the array. This is exclusive of the element at the index 'end'.\r\nIf end is undefined, then the slice extends to the end of the array."
+            }
+          ],
+          "docs": "Returns a copy of a section of an array.\r\nFor both start and end, a negative index can be used to indicate an offset from the end of the array.\r\nFor example, -2 refers to the second to last element of the array.",
+          "complexTypes": [
+            "T"
+          ],
+          "slug": "slice"
+        },
+        {
+          "name": "sort",
+          "signature": "(compareFn?: ((a: T, b: T) => number) | undefined) => this",
+          "parameters": [
+            {
+              "name": "compareFn",
+              "docs": "Function used to determine the order of the elements. It is expected to return\r\na negative value if first argument is less than second argument, zero if they're equal and a positive\r\nvalue otherwise. If omitted, the elements are sorted in ascending, ASCII character order.\r\n```ts\r\n[11,2,22,1].sort((a, b) => a - b)\r\n```",
+              "type": "((a: T, b: T) => number) | undefined"
+            }
+          ],
+          "returns": "this",
+          "tags": [
+            {
+              "name": "param",
+              "text": "compareFn Function used to determine the order of the elements. It is expected to return\r\na negative value if first argument is less than second argument, zero if they're equal and a positive\r\nvalue otherwise. If omitted, the elements are sorted in ascending, ASCII character order.\r\n```ts\r\n[11,2,22,1].sort((a, b) => a - b)\r\n```"
+            }
+          ],
+          "docs": "Sorts an array in place.\r\nThis method mutates the array and returns a reference to the same array.",
+          "complexTypes": [
+            "T"
+          ],
+          "slug": "sort"
+        },
+        {
+          "name": "splice",
+          "signature": "(start: number, deleteCount?: number | undefined) => T[]",
+          "parameters": [
+            {
+              "name": "start",
+              "docs": "The zero-based location in the array from which to start removing elements.",
+              "type": "number"
+            },
+            {
+              "name": "deleteCount",
+              "docs": "The number of elements to remove.",
+              "type": "number | undefined"
+            }
+          ],
+          "returns": "T[]",
+          "tags": [
+            {
+              "name": "param",
+              "text": "start The zero-based location in the array from which to start removing elements."
+            },
+            {
+              "name": "param",
+              "text": "deleteCount The number of elements to remove."
+            },
+            {
+              "name": "returns",
+              "text": "An array containing the elements that were deleted."
+            }
+          ],
+          "docs": "Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.",
+          "complexTypes": [
+            "T"
+          ],
+          "slug": "splice"
+        },
+        {
+          "name": "splice",
+          "signature": "(start: number, deleteCount: number, ...items: T[]) => T[]",
+          "parameters": [
+            {
+              "name": "start",
+              "docs": "The zero-based location in the array from which to start removing elements.",
+              "type": "number"
+            },
+            {
+              "name": "deleteCount",
+              "docs": "The number of elements to remove.",
+              "type": "number"
+            },
+            {
+              "name": "items",
+              "docs": "Elements to insert into the array in place of the deleted elements.",
+              "type": "T[]"
+            }
+          ],
+          "returns": "T[]",
+          "tags": [
+            {
+              "name": "param",
+              "text": "start The zero-based location in the array from which to start removing elements."
+            },
+            {
+              "name": "param",
+              "text": "deleteCount The number of elements to remove."
+            },
+            {
+              "name": "param",
+              "text": "items Elements to insert into the array in place of the deleted elements."
+            },
+            {
+              "name": "returns",
+              "text": "An array containing the elements that were deleted."
+            }
+          ],
+          "docs": "Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.",
+          "complexTypes": [
+            "T"
+          ],
+          "slug": "splice"
+        },
+        {
+          "name": "unshift",
+          "signature": "(...items: T[]) => number",
+          "parameters": [
+            {
+              "name": "items",
+              "docs": "Elements to insert at the start of the array.",
+              "type": "T[]"
+            }
+          ],
+          "returns": "number",
+          "tags": [
+            {
+              "name": "param",
+              "text": "items Elements to insert at the start of the array."
+            }
+          ],
+          "docs": "Inserts new elements at the start of an array, and returns the new length of the array.",
+          "complexTypes": [
+            "T"
+          ],
+          "slug": "unshift"
+        },
+        {
+          "name": "indexOf",
+          "signature": "(searchElement: T, fromIndex?: number | undefined) => number",
+          "parameters": [
+            {
+              "name": "searchElement",
+              "docs": "The value to locate in the array.",
+              "type": "T"
+            },
+            {
+              "name": "fromIndex",
+              "docs": "The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.",
+              "type": "number | undefined"
+            }
+          ],
+          "returns": "number",
+          "tags": [
+            {
+              "name": "param",
+              "text": "searchElement The value to locate in the array."
+            },
+            {
+              "name": "param",
+              "text": "fromIndex The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0."
+            }
+          ],
+          "docs": "Returns the index of the first occurrence of a value in an array, or -1 if it is not present.",
+          "complexTypes": [
+            "T"
+          ],
+          "slug": "indexof"
+        },
+        {
+          "name": "lastIndexOf",
+          "signature": "(searchElement: T, fromIndex?: number | undefined) => number",
+          "parameters": [
+            {
+              "name": "searchElement",
+              "docs": "The value to locate in the array.",
+              "type": "T"
+            },
+            {
+              "name": "fromIndex",
+              "docs": "The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.",
+              "type": "number | undefined"
+            }
+          ],
+          "returns": "number",
+          "tags": [
+            {
+              "name": "param",
+              "text": "searchElement The value to locate in the array."
+            },
+            {
+              "name": "param",
+              "text": "fromIndex The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array."
+            }
+          ],
+          "docs": "Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.",
+          "complexTypes": [
+            "T"
+          ],
+          "slug": "lastindexof"
+        },
+        {
+          "name": "every",
+          "signature": "<S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any) => this is S[]",
+          "parameters": [
+            {
+              "name": "predicate",
+              "docs": "A function that accepts up to three arguments. The every method calls\r\nthe predicate function for each element in the array until the predicate returns a value\r\nwhich is coercible to the Boolean value false, or until the end of the array.",
+              "type": "(value: T, index: number, array: T[]) => value is S"
+            },
+            {
+              "name": "thisArg",
+              "docs": "An object to which the this keyword can refer in the predicate function.\r\nIf thisArg is omitted, undefined is used as the this value.",
+              "type": "any"
+            }
+          ],
+          "returns": "boolean",
+          "tags": [
+            {
+              "name": "param",
+              "text": "predicate A function that accepts up to three arguments. The every method calls\r\nthe predicate function for each element in the array until the predicate returns a value\r\nwhich is coercible to the Boolean value false, or until the end of the array."
+            },
+            {
+              "name": "param",
+              "text": "thisArg An object to which the this keyword can refer in the predicate function.\r\nIf thisArg is omitted, undefined is used as the this value."
+            }
+          ],
+          "docs": "Determines whether all the members of an array satisfy the specified test.",
+          "complexTypes": [
+            "T",
+            "S"
+          ],
+          "slug": "every"
+        },
+        {
+          "name": "every",
+          "signature": "(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => boolean",
+          "parameters": [
+            {
+              "name": "predicate",
+              "docs": "A function that accepts up to three arguments. The every method calls\r\nthe predicate function for each element in the array until the predicate returns a value\r\nwhich is coercible to the Boolean value false, or until the end of the array.",
+              "type": "(value: T, index: number, array: T[]) => unknown"
+            },
+            {
+              "name": "thisArg",
+              "docs": "An object to which the this keyword can refer in the predicate function.\r\nIf thisArg is omitted, undefined is used as the this value.",
+              "type": "any"
+            }
+          ],
+          "returns": "boolean",
+          "tags": [
+            {
+              "name": "param",
+              "text": "predicate A function that accepts up to three arguments. The every method calls\r\nthe predicate function for each element in the array until the predicate returns a value\r\nwhich is coercible to the Boolean value false, or until the end of the array."
+            },
+            {
+              "name": "param",
+              "text": "thisArg An object to which the this keyword can refer in the predicate function.\r\nIf thisArg is omitted, undefined is used as the this value."
+            }
+          ],
+          "docs": "Determines whether all the members of an array satisfy the specified test.",
+          "complexTypes": [
+            "T"
+          ],
+          "slug": "every"
+        },
+        {
+          "name": "some",
+          "signature": "(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => boolean",
+          "parameters": [
+            {
+              "name": "predicate",
+              "docs": "A function that accepts up to three arguments. The some method calls\r\nthe predicate function for each element in the array until the predicate returns a value\r\nwhich is coercible to the Boolean value true, or until the end of the array.",
+              "type": "(value: T, index: number, array: T[]) => unknown"
+            },
+            {
+              "name": "thisArg",
+              "docs": "An object to which the this keyword can refer in the predicate function.\r\nIf thisArg is omitted, undefined is used as the this value.",
+              "type": "any"
+            }
+          ],
+          "returns": "boolean",
+          "tags": [
+            {
+              "name": "param",
+              "text": "predicate A function that accepts up to three arguments. The some method calls\r\nthe predicate function for each element in the array until the predicate returns a value\r\nwhich is coercible to the Boolean value true, or until the end of the array."
+            },
+            {
+              "name": "param",
+              "text": "thisArg An object to which the this keyword can refer in the predicate function.\r\nIf thisArg is omitted, undefined is used as the this value."
+            }
+          ],
+          "docs": "Determines whether the specified callback function returns true for any element of an array.",
+          "complexTypes": [
+            "T"
+          ],
+          "slug": "some"
         },
         {
-          "name": "resetStreamOnPause",
-          "tags": [],
-          "docs": "If true, when pausing a live stream, play will continue from the LIVE POSITION (e.g. the stream\njumps forward to the current point in time, rather than picking up where it left off when you paused).\nIf false, the stream will continue where you paused. The drawback of doing this is that when the audio\nbuffer fills, it will jump forward to the current point in time, cause a disjoint in playback.\n\nDefault is true.",
-          "complexTypes": [],
-          "type": "boolean | undefined"
+          "name": "forEach",
+          "signature": "(callbackfn: (value: T, index: number, array: T[]) => void, thisArg?: any) => void",
+          "parameters": [
+            {
+              "name": "callbackfn",
+              "docs": "A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.",
+              "type": "(value: T, index: number, array: T[]) => void"
+            },
+            {
+              "name": "thisArg",
+              "docs": "An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.",
+              "type": "any"
+            }
+          ],
+          "returns": "void",
+          "tags": [
+            {
+              "name": "param",
+              "text": "callbackfn A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array."
+            },
+            {
+              "name": "param",
+              "text": "thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value."
+            }
+          ],
+          "docs": "Performs the specified action for each element in an array.",
+          "complexTypes": [
+            "T"
+          ],
+          "slug": "foreach"
         },
         {
-          "name": "options",
-          "tags": [],
-          "docs": "Further options for notifications",
+          "name": "map",
+          "signature": "<U>(callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any) => U[]",
+          "parameters": [
+            {
+              "name": "callbackfn",
+              "docs": "A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.",
+              "type": "(value: T, index: number, array: T[]) => U"
+            },
+            {
+              "name": "thisArg",
+              "docs": "An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.",
+              "type": "any"
+            }
+          ],
+          "returns": "U[]",
+          "tags": [
+            {
+              "name": "param",
+              "text": "callbackfn A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array."
+            },
+            {
+              "name": "param",
+              "text": "thisArg An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value."
+            }
+          ],
+          "docs": "Calls a defined callback function on each element of an array, and returns an array that contains the results.",
           "complexTypes": [
-            "NotificationOptions"
+            "U",
+            "T"
           ],
-          "type": "NotificationOptions | undefined"
-        }
-      ]
-    },
-    {
-      "name": "NotificationOptions",
-      "slug": "notificationoptions",
-      "docs": "",
-      "tags": [],
-      "methods": [],
-      "properties": [
+          "slug": "map"
+        },
         {
-          "name": "icon",
-          "tags": [],
-          "docs": "",
-          "complexTypes": [],
-          "type": "string | undefined"
-        }
-      ]
-    },
-    {
-      "name": "PlaylistOptions",
-      "slug": "playlistoptions",
-      "docs": "",
-      "tags": [],
-      "methods": [],
-      "properties": [
+          "name": "filter",
+          "signature": "<S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any) => S[]",
+          "parameters": [
+            {
+              "name": "predicate",
+              "docs": "A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.",
+              "type": "(value: T, index: number, array: T[]) => value is S"
+            },
+            {
+              "name": "thisArg",
+              "docs": "An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.",
+              "type": "any"
+            }
+          ],
+          "returns": "S[]",
+          "tags": [
+            {
+              "name": "param",
+              "text": "predicate A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array."
+            },
+            {
+              "name": "param",
+              "text": "thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value."
+            }
+          ],
+          "docs": "Returns the elements of an array that meet the condition specified in a callback function.",
+          "complexTypes": [
+            "S",
+            "T"
+          ],
+          "slug": "filter"
+        },
         {
-          "name": "items",
-          "tags": [],
-          "docs": "",
+          "name": "filter",
+          "signature": "(predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => T[]",
+          "parameters": [
+            {
+              "name": "predicate",
+              "docs": "A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.",
+              "type": "(value: T, index: number, array: T[]) => unknown"
+            },
+            {
+              "name": "thisArg",
+              "docs": "An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.",
+              "type": "any"
+            }
+          ],
+          "returns": "T[]",
+          "tags": [
+            {
+              "name": "param",
+              "text": "predicate A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array."
+            },
+            {
+              "name": "param",
+              "text": "thisArg An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value."
+            }
+          ],
+          "docs": "Returns the elements of an array that meet the condition specified in a callback function.",
           "complexTypes": [
-            "Array",
-            "AudioTrack"
+            "T"
           ],
-          "type": "Array<AudioTrack>"
+          "slug": "filter"
         },
         {
-          "name": "options",
+          "name": "reduce",
+          "signature": "(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T) => T",
+          "parameters": [
+            {
+              "name": "callbackfn",
+              "docs": "A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.",
+              "type": "(previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T"
+            }
+          ],
+          "returns": "T",
+          "tags": [
+            {
+              "name": "param",
+              "text": "callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array."
+            },
+            {
+              "name": "param",
+              "text": "initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value."
+            }
+          ],
+          "docs": "Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.",
+          "complexTypes": [
+            "T"
+          ],
+          "slug": "reduce"
+        },
+        {
+          "name": "reduce",
+          "signature": "(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T) => T",
+          "parameters": [
+            {
+              "name": "callbackfn",
+              "docs": "",
+              "type": "(previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T"
+            },
+            {
+              "name": "initialValue",
+              "docs": "",
+              "type": "T"
+            }
+          ],
+          "returns": "T",
           "tags": [],
           "docs": "",
           "complexTypes": [
-            "PlaylistItemOptions"
+            "T"
           ],
-          "type": "PlaylistItemOptions"
-        }
-      ]
-    },
-    {
-      "name": "AudioTrack",
-      "slug": "audiotrack",
-      "docs": "An audio track for playback by the playlist.",
-      "tags": [],
-      "methods": [],
-      "properties": [
+          "slug": "reduce"
+        },
         {
-          "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": "reduce",
+          "signature": "<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U) => U",
+          "parameters": [
+            {
+              "name": "callbackfn",
+              "docs": "A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.",
+              "type": "(previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U"
+            },
+            {
+              "name": "initialValue",
+              "docs": "If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.",
+              "type": "U"
+            }
+          ],
+          "returns": "U",
+          "tags": [
+            {
+              "name": "param",
+              "text": "callbackfn A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array."
+            },
+            {
+              "name": "param",
+              "text": "initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value."
+            }
+          ],
+          "docs": "Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.",
+          "complexTypes": [
+            "U",
+            "T"
+          ],
+          "slug": "reduce"
         },
         {
-          "name": "trackId",
-          "tags": [],
-          "docs": "trackId is optional and if not passed in, an auto-generated UUID will be used.",
-          "complexTypes": [],
-          "type": "string | undefined"
+          "name": "reduceRight",
+          "signature": "(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T) => T",
+          "parameters": [
+            {
+              "name": "callbackfn",
+              "docs": "A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.",
+              "type": "(previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T"
+            }
+          ],
+          "returns": "T",
+          "tags": [
+            {
+              "name": "param",
+              "text": "callbackfn A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array."
+            },
+            {
+              "name": "param",
+              "text": "initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value."
+            }
+          ],
+          "docs": "Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.",
+          "complexTypes": [
+            "T"
+          ],
+          "slug": "reduceright"
         },
         {
-          "name": "assetUrl",
+          "name": "reduceRight",
+          "signature": "(callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T) => T",
+          "parameters": [
+            {
+              "name": "callbackfn",
+              "docs": "",
+              "type": "(previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T"
+            },
+            {
+              "name": "initialValue",
+              "docs": "",
+              "type": "T"
+            }
+          ],
+          "returns": "T",
           "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"
+          "docs": "",
+          "complexTypes": [
+            "T"
+          ],
+          "slug": "reduceright"
         },
         {
-          "name": "albumArt",
+          "name": "reduceRight",
+          "signature": "<U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U) => U",
+          "parameters": [
+            {
+              "name": "callbackfn",
+              "docs": "A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.",
+              "type": "(previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U"
+            },
+            {
+              "name": "initialValue",
+              "docs": "If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.",
+              "type": "U"
+            }
+          ],
+          "returns": "U",
+          "tags": [
+            {
+              "name": "param",
+              "text": "callbackfn A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array."
+            },
+            {
+              "name": "param",
+              "text": "initialValue If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value."
+            }
+          ],
+          "docs": "Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.",
+          "complexTypes": [
+            "U",
+            "T"
+          ],
+          "slug": "reduceright"
+        }
+      ],
+      "properties": [
+        {
+          "name": "length",
           "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.",
+          "docs": "Gets or sets the length of the array. This is a number one higher than the highest index in the array.",
           "complexTypes": [],
-          "type": "string | undefined"
-        },
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "ConcatArray",
+      "slug": "concatarray",
+      "docs": "",
+      "tags": [],
+      "methods": [
         {
-          "name": "artist",
+          "name": "join",
+          "signature": "(separator?: string | undefined) => string",
+          "parameters": [
+            {
+              "name": "separator",
+              "docs": "",
+              "type": "string | undefined"
+            }
+          ],
+          "returns": "string",
           "tags": [],
-          "docs": "The track's artist",
+          "docs": "",
           "complexTypes": [],
-          "type": "string"
+          "slug": "join"
         },
         {
-          "name": "album",
+          "name": "slice",
+          "signature": "(start?: number | undefined, end?: number | undefined) => T[]",
+          "parameters": [
+            {
+              "name": "start",
+              "docs": "",
+              "type": "number | undefined"
+            },
+            {
+              "name": "end",
+              "docs": "",
+              "type": "number | undefined"
+            }
+          ],
+          "returns": "T[]",
           "tags": [],
-          "docs": "Album the track belongs to",
-          "complexTypes": [],
-          "type": "string"
-        },
+          "docs": "",
+          "complexTypes": [
+            "T"
+          ],
+          "slug": "slice"
+        }
+      ],
+      "properties": [
         {
-          "name": "title",
+          "name": "length",
           "tags": [],
-          "docs": "Title of the track",
+          "docs": "",
           "complexTypes": [],
-          "type": "string"
+          "type": "number"
         }
       ]
     },
@@ -778,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": []
 }