@capawesome/capacitor-volume 0.0.1

package/dist/docs.json

@@ -0,0 +1,540 @@
+{
+  "api": {
+    "name": "VolumePlugin",
+    "slug": "volumeplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "getVolume",
+        "signature": "(options?: GetVolumeOptions | undefined) => Promise<GetVolumeResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "GetVolumeOptions | undefined"
+          }
+        ],
+        "returns": "Promise<GetVolumeResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Get the current volume level.\n\nOn iOS, this always returns the media volume.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "GetVolumeResult",
+          "GetVolumeOptions"
+        ],
+        "slug": "getvolume"
+      },
+      {
+        "name": "isWatching",
+        "signature": "() => Promise<IsWatchingResult>",
+        "parameters": [],
+        "returns": "Promise<IsWatchingResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Check whether the hardware volume buttons are currently being watched.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "IsWatchingResult"
+        ],
+        "slug": "iswatching"
+      },
+      {
+        "name": "setVolume",
+        "signature": "(options: SetVolumeOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SetVolumeOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Set the volume level.\n\nOn iOS, this always sets the media volume.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "SetVolumeOptions"
+        ],
+        "slug": "setvolume"
+      },
+      {
+        "name": "startWatching",
+        "signature": "(options?: StartWatchingOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "StartWatchingOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Start watching the hardware volume buttons.\n\nThe `volumeButtonPressed` and `volumeChange` events are only\nemitted while watching.\n\nIf the volume buttons are already being watched, this call has\nno effect. Call `stopWatching()` first to change the options.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "StartWatchingOptions"
+        ],
+        "slug": "startwatching"
+      },
+      {
+        "name": "stopWatching",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Stop watching the hardware volume buttons.\n\nOn iOS, this also restores the volume level that was set when\nwatching started if the `suppressVolumeChange` option was enabled.\n\nOnly available on Android and iOS.",
+        "complexTypes": [],
+        "slug": "stopwatching"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'volumeButtonPressed', listenerFunc: (event: VolumeButtonPressedEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'volumeButtonPressed'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: VolumeButtonPressedEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Called when a hardware volume button is pressed while watching.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "VolumeButtonPressedEvent"
+        ],
+        "slug": "addlistenervolumebuttonpressed-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'volumeChange', listenerFunc: (event: VolumeChangeEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'volumeChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: VolumeChangeEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Called when the volume level changes while watching.\n\nOn Android, this is called for changes to the music stream.\nOn iOS, this is called for changes to the media volume and is\nnot called while the `suppressVolumeChange` option is enabled.\n\nOnly available on Android and iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "VolumeChangeEvent"
+        ],
+        "slug": "addlistenervolumechange-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Remove all listeners for this plugin.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "GetVolumeResult",
+      "slug": "getvolumeresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "volume",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "0.5",
+              "name": "example"
+            }
+          ],
+          "docs": "The current volume level as a value between `0` and `1`.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "GetVolumeOptions",
+      "slug": "getvolumeoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "stream",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "VolumeStream.Music",
+              "name": "default"
+            },
+            {
+              "text": "'music'",
+              "name": "example"
+            }
+          ],
+          "docs": "The audio stream to get the volume for.\n\nOnly available on Android.",
+          "complexTypes": [
+            "VolumeStream"
+          ],
+          "type": "VolumeStream"
+        }
+      ]
+    },
+    {
+      "name": "IsWatchingResult",
+      "slug": "iswatchingresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "watching",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "true",
+              "name": "example"
+            }
+          ],
+          "docs": "Whether the hardware volume buttons are currently being watched.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "SetVolumeOptions",
+      "slug": "setvolumeoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "stream",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "VolumeStream.Music",
+              "name": "default"
+            },
+            {
+              "text": "'music'",
+              "name": "example"
+            }
+          ],
+          "docs": "The audio stream to set the volume for.\n\nOnly available on Android.",
+          "complexTypes": [
+            "VolumeStream"
+          ],
+          "type": "VolumeStream"
+        },
+        {
+          "name": "volume",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "0.5",
+              "name": "example"
+            }
+          ],
+          "docs": "The volume level to set as a value between `0` and `1`.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "StartWatchingOptions",
+      "slug": "startwatchingoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "suppressVolumeChange",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "true",
+              "name": "example"
+            }
+          ],
+          "docs": "Whether to keep the volume level unchanged when a hardware volume\nbutton is pressed while watching.\n\nOn Android, the volume key events are consumed so that the system\ndoes not apply the volume change or display the volume panel.\nOn iOS, the volume level is reset immediately after each button\npress and the system volume indicator is hidden. If the volume\nlevel is close to the minimum or maximum, it is nudged to a value\nfrom which both buttons can still be detected. The original volume\nlevel is restored when watching stops.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "VolumeButtonPressedEvent",
+      "slug": "volumebuttonpressedevent",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "direction",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "'up'",
+              "name": "example"
+            }
+          ],
+          "docs": "The direction of the pressed hardware volume button.",
+          "complexTypes": [
+            "Direction"
+          ],
+          "type": "Direction"
+        }
+      ]
+    },
+    {
+      "name": "VolumeChangeEvent",
+      "slug": "volumechangeevent",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "volume",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            },
+            {
+              "text": "0.5",
+              "name": "example"
+            }
+          ],
+          "docs": "The new volume level as a value between `0` and `1`.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    }
+  ],
+  "enums": [
+    {
+      "name": "VolumeStream",
+      "slug": "volumestream",
+      "members": [
+        {
+          "name": "Alarm",
+          "value": "'alarm'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The audio stream for alarms."
+        },
+        {
+          "name": "Music",
+          "value": "'music'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The audio stream for music and media playback."
+        },
+        {
+          "name": "Notification",
+          "value": "'notification'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The audio stream for notifications."
+        },
+        {
+          "name": "Ring",
+          "value": "'ring'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The audio stream for the phone ring."
+        },
+        {
+          "name": "System",
+          "value": "'system'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The audio stream for system sounds."
+        },
+        {
+          "name": "VoiceCall",
+          "value": "'voiceCall'",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The audio stream for phone calls."
+        }
+      ]
+    }
+  ],
+  "typeAliases": [
+    {
+      "name": "Direction",
+      "slug": "direction",
+      "docs": "The direction of a hardware volume button.\n\n- `up`: The volume up button.\n- `down`: The volume down button.",
+      "types": [
+        {
+          "text": "'down'",
+          "complexTypes": []
+        },
+        {
+          "text": "'up'",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}