@capgo/native-audio 8.2.11 → 8.2.13

package/dist/docs.json

@@ -149,12 +149,12 @@
       },
       {
         "name": "play",
-        "signature": "(options: { assetId: string; time?: number; delay?: number; }) => Promise<void>",
+        "signature": "(options: AssetPlayOptions) => Promise<void>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "{ assetId: string; time?: number | undefined; delay?: number | undefined; }"
+            "type": "AssetPlayOptions"
           }
         ],
         "returns": "Promise<void>",
@@ -169,24 +169,26 @@
           },
           {
             "name": "link",
-            "text": "PlayOptions}"
+            "text": "AssetPlayOptions}"
           },
           {
             "name": "returns"
           }
         ],
         "docs": "Play an audio file",
-        "complexTypes": [],
+        "complexTypes": [
+          "AssetPlayOptions"
+        ],
         "slug": "play"
       },
       {
         "name": "pause",
-        "signature": "(options: Assets) => Promise<void>",
+        "signature": "(options: AssetPauseOptions) => Promise<void>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "Assets"
+            "type": "AssetPauseOptions"
           }
         ],
         "returns": "Promise<void>",
@@ -201,7 +203,7 @@
           },
           {
             "name": "link",
-            "text": "Assets}"
+            "text": "AssetPauseOptions}"
           },
           {
             "name": "returns"
@@ -209,18 +211,18 @@
         ],
         "docs": "Pause an audio file",
         "complexTypes": [
-          "Assets"
+          "AssetPauseOptions"
         ],
         "slug": "pause"
       },
       {
         "name": "resume",
-        "signature": "(options: Assets) => Promise<void>",
+        "signature": "(options: AssetResumeOptions) => Promise<void>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "Assets"
+            "type": "AssetResumeOptions"
           }
         ],
         "returns": "Promise<void>",
@@ -235,7 +237,7 @@
           },
           {
             "name": "link",
-            "text": "Assets}"
+            "text": "AssetResumeOptions}"
           },
           {
             "name": "returns"
@@ -243,7 +245,7 @@
         ],
         "docs": "Resume an audio file",
         "complexTypes": [
-          "Assets"
+          "AssetResumeOptions"
         ],
         "slug": "resume"
       },
@@ -283,12 +285,12 @@
       },
       {
         "name": "stop",
-        "signature": "(options: Assets) => Promise<void>",
+        "signature": "(options: AssetStopOptions) => Promise<void>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "Assets"
+            "type": "AssetStopOptions"
           }
         ],
         "returns": "Promise<void>",
@@ -303,7 +305,7 @@
           },
           {
             "name": "link",
-            "text": "Assets}"
+            "text": "AssetStopOptions}"
           },
           {
             "name": "returns"
@@ -311,7 +313,7 @@
         ],
         "docs": "Stop an audio file",
         "complexTypes": [
-          "Assets"
+          "AssetStopOptions"
         ],
         "slug": "stop"
       },
@@ -351,12 +353,12 @@
       },
       {
         "name": "setVolume",
-        "signature": "(options: { assetId: string; volume: number; }) => Promise<void>",
+        "signature": "(options: AssetVolume) => Promise<void>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "{ assetId: string; volume: number; }"
+            "type": "AssetVolume"
           }
         ],
         "returns": "Promise<void>",
@@ -378,17 +380,19 @@
           }
         ],
         "docs": "Set the volume of an audio file",
-        "complexTypes": [],
+        "complexTypes": [
+          "AssetVolume"
+        ],
         "slug": "setvolume"
       },
       {
         "name": "setRate",
-        "signature": "(options: { assetId: string; rate: number; }) => Promise<void>",
+        "signature": "(options: AssetRate) => Promise<void>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "{ assetId: string; rate: number; }"
+            "type": "AssetRate"
           }
         ],
         "returns": "Promise<void>",
@@ -403,24 +407,26 @@
           },
           {
             "name": "link",
-            "text": "AssetPlayOptions}"
+            "text": "AssetRate}"
           },
           {
             "name": "returns"
           }
         ],
         "docs": "Set the rate of an audio file",
-        "complexTypes": [],
+        "complexTypes": [
+          "AssetRate"
+        ],
         "slug": "setrate"
       },
       {
         "name": "setCurrentTime",
-        "signature": "(options: { assetId: string; time: number; }) => Promise<void>",
+        "signature": "(options: AssetSetTime) => Promise<void>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "{ assetId: string; time: number; }"
+            "type": "AssetSetTime"
           }
         ],
         "returns": "Promise<void>",
@@ -435,24 +441,26 @@
           },
           {
             "name": "link",
-            "text": "AssetPlayOptions}"
+            "text": "AssetSetTime}"
           },
           {
             "name": "returns"
           }
         ],
         "docs": "Set the current time of an audio file",
-        "complexTypes": [],
+        "complexTypes": [
+          "AssetSetTime"
+        ],
         "slug": "setcurrenttime"
       },
       {
         "name": "getCurrentTime",
-        "signature": "(options: { assetId: string; }) => Promise<{ currentTime: number; }>",
+        "signature": "(options: Assets) => Promise<{ currentTime: number; }>",
         "parameters": [
           {
             "name": "options",
             "docs": "",
-            "type": "{ assetId: string; }"
+            "type": "Assets"
           }
         ],
         "returns": "Promise<{ currentTime: number; }>",
@@ -467,14 +475,16 @@
           },
           {
             "name": "link",
-            "text": "AssetPlayOptions}"
+            "text": "Assets}"
           },
           {
             "name": "returns"
           }
         ],
         "docs": "Get the current time of an audio file",
-        "complexTypes": [],
+        "complexTypes": [
+          "Assets"
+        ],
         "slug": "getcurrenttime"
       },
       {
@@ -499,13 +509,13 @@
           },
           {
             "name": "link",
-            "text": "AssetPlayOptions}"
+            "text": "Assets}"
           },
           {
             "name": "returns"
           }
         ],
-        "docs": "Get the duration of an audio file",
+        "docs": "Get the duration of an audio file in seconds",
         "complexTypes": [
           "Assets"
         ],
@@ -533,7 +543,7 @@
           },
           {
             "name": "link",
-            "text": "AssetPlayOptions}"
+            "text": "Assets}"
           },
           {
             "name": "returns"
@@ -621,6 +631,31 @@
         "complexTypes": [],
         "slug": "clearcache"
       },
+      {
+        "name": "setDebugMode",
+        "signature": "(options: { enabled: boolean; }) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "- Options to enable or disable debug mode",
+            "type": "{ enabled: boolean; }"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "6.5.0"
+          },
+          {
+            "name": "param",
+            "text": "options - Options to enable or disable debug mode"
+          }
+        ],
+        "docs": "Set debug mode logging",
+        "complexTypes": [],
+        "slug": "setdebugmode"
+      },
       {
         "name": "getPluginVersion",
         "signature": "() => Promise<{ version: string; }>",
@@ -669,13 +704,6 @@
       "tags": [],
       "methods": [],
       "properties": [
-        {
-          "name": "fade",
-          "tags": [],
-          "docs": "Play the audio with Fade effect, only available for IOS",
-          "complexTypes": [],
-          "type": "boolean | undefined"
-        },
         {
           "name": "focus",
           "tags": [],
@@ -956,6 +984,138 @@
         }
       ]
     },
+    {
+      "name": "AssetPlayOptions",
+      "slug": "assetplayoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "assetId",
+          "tags": [],
+          "docs": "Asset Id, unique identifier of the file",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "time",
+          "tags": [],
+          "docs": "Time to start playing the audio, in seconds",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "delay",
+          "tags": [],
+          "docs": "Delay to start playing the audio, in seconds",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "volume",
+          "tags": [],
+          "docs": "Volume of the audio, between 0.1 and 1.0",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "fadeIn",
+          "tags": [],
+          "docs": "Whether to fade in the audio",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "fadeOut",
+          "tags": [],
+          "docs": "Whether to fade out the audio",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "fadeInDuration",
+          "tags": [],
+          "docs": "Fade in duration in seconds.\nOnly used if fadeIn is true.\nDefault is 1s.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "fadeOutDuration",
+          "tags": [],
+          "docs": "Fade out duration in seconds.\nOnly used if fadeOut is true.\nDefault is 1s.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "fadeOutStartTime",
+          "tags": [],
+          "docs": "Time in seconds from the start of the audio to start fading out.\nOnly used if fadeOut is true.\nDefault is fadeOutDuration before end of audio.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "AssetPauseOptions",
+      "slug": "assetpauseoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "assetId",
+          "tags": [],
+          "docs": "Asset Id, unique identifier of the file",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "fadeOut",
+          "tags": [],
+          "docs": "Whether to fade out the audio before pausing",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "fadeOutDuration",
+          "tags": [],
+          "docs": "Fade out duration in seconds.\nDefault is 1s.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "AssetResumeOptions",
+      "slug": "assetresumeoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "assetId",
+          "tags": [],
+          "docs": "Asset Id, unique identifier of the file",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "fadeIn",
+          "tags": [],
+          "docs": "Whether to fade in the audio during resume",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "fadeInDuration",
+          "tags": [],
+          "docs": "Fade in duration in seconds.\nDefault is 1s.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
     {
       "name": "Assets",
       "slug": "assets",
@@ -972,6 +1132,112 @@
         }
       ]
     },
+    {
+      "name": "AssetStopOptions",
+      "slug": "assetstopoptions",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "assetId",
+          "tags": [],
+          "docs": "Asset Id, unique identifier of the file",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "fadeOut",
+          "tags": [],
+          "docs": "Whether to fade out the audio before stopping",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "fadeOutDuration",
+          "tags": [],
+          "docs": "Fade out duration in seconds.\nDefault is 1s.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "AssetVolume",
+      "slug": "assetvolume",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "assetId",
+          "tags": [],
+          "docs": "Asset Id, unique identifier of the file",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "volume",
+          "tags": [],
+          "docs": "Volume of the audio, between 0.1 and 1.0",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "duration",
+          "tags": [],
+          "docs": "Time over which to fade to the target volume, in seconds. Default is 0s (immediate).",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "AssetRate",
+      "slug": "assetrate",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "assetId",
+          "tags": [],
+          "docs": "Asset Id, unique identifier of the file",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "rate",
+          "tags": [],
+          "docs": "Rate of the audio, between 0.1 and 1.0",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "AssetSetTime",
+      "slug": "assetsettime",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "assetId",
+          "tags": [],
+          "docs": "Asset Id, unique identifier of the file",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "time",
+          "tags": [],
+          "docs": "Time to set the audio, in seconds",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
     {
       "name": "PluginListenerHandle",
       "slug": "pluginlistenerhandle",