@capawesome/capacitor-audio-session 0.0.1

package/dist/docs.json

@@ -0,0 +1,759 @@
+{
+  "api": {
+    "name": "AudioSessionPlugin",
+    "slug": "audiosessionplugin",
+    "docs": "",
+    "tags": [],
+    "methods": [
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'interruption', listenerFunc: (event: InterruptionEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'interruption'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: InterruptionEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Called when the audio session is interrupted, e.g. by an incoming phone call.\n\nOnly available on iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "InterruptionEvent"
+        ],
+        "slug": "addlistenerinterruption-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'routeChange', listenerFunc: (event: RouteChangeEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'routeChange'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: RouteChangeEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Called when the audio route changes, e.g. when headphones are plugged in or out.\n\nOnly available on iOS.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "RouteChangeEvent"
+        ],
+        "slug": "addlistenerroutechange-"
+      },
+      {
+        "name": "configure",
+        "signature": "(options: ConfigureOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "ConfigureOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Configure the audio session category, mode and options.\n\nOnly available on iOS.",
+        "complexTypes": [
+          "ConfigureOptions"
+        ],
+        "slug": "configure"
+      },
+      {
+        "name": "getCurrentOutputs",
+        "signature": "() => Promise<GetCurrentOutputsResult>",
+        "parameters": [],
+        "returns": "Promise<GetCurrentOutputsResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Get the audio outputs of the current audio route.\n\nOnly available on iOS.",
+        "complexTypes": [
+          "GetCurrentOutputsResult"
+        ],
+        "slug": "getcurrentoutputs"
+      },
+      {
+        "name": "overrideOutput",
+        "signature": "(options: OverrideOutputOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "OverrideOutputOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Override the audio output port that is used for playback.\n\nOnly available on iOS.",
+        "complexTypes": [
+          "OverrideOutputOptions"
+        ],
+        "slug": "overrideoutput"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Remove all listeners for this plugin.\n\nOnly available on iOS.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      },
+      {
+        "name": "setActive",
+        "signature": "(options: SetActiveOptions) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "SetActiveOptions"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "0.1.0"
+          }
+        ],
+        "docs": "Activate or deactivate the audio session.\n\nOnly available on iOS.",
+        "complexTypes": [
+          "SetActiveOptions"
+        ],
+        "slug": "setactive"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "InterruptionEvent",
+      "slug": "interruptionevent",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "shouldResume",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether playback should resume after the interruption ended.\n\nOnly `true` if `type` is `ended`.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "type",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The type of the interruption.",
+          "complexTypes": [
+            "InterruptionType"
+          ],
+          "type": "InterruptionType"
+        }
+      ]
+    },
+    {
+      "name": "RouteChangeEvent",
+      "slug": "routechangeevent",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "outputs",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The audio outputs of the audio route after the change.",
+          "complexTypes": [
+            "AudioSessionOutput"
+          ],
+          "type": "AudioSessionOutput[]"
+        },
+        {
+          "name": "reason",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The reason why the audio route changed.",
+          "complexTypes": [
+            "RouteChangeReason"
+          ],
+          "type": "RouteChangeReason"
+        }
+      ]
+    },
+    {
+      "name": "AudioSessionOutput",
+      "slug": "audiosessionoutput",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "portName",
+          "tags": [
+            {
+              "text": "'Speaker'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The human-readable name of the audio output port.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "portType",
+          "tags": [
+            {
+              "text": "'Speaker'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The type of the audio output port.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    },
+    {
+      "name": "ConfigureOptions",
+      "slug": "configureoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "category",
+          "tags": [
+            {
+              "text": "'playback'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The audio session category.",
+          "complexTypes": [
+            "AudioSessionCategory"
+          ],
+          "type": "AudioSessionCategory"
+        },
+        {
+          "name": "mode",
+          "tags": [
+            {
+              "text": "'default'",
+              "name": "default"
+            },
+            {
+              "text": "'moviePlayback'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The audio session mode.",
+          "complexTypes": [
+            "AudioSessionMode"
+          ],
+          "type": "AudioSessionMode"
+        },
+        {
+          "name": "options",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The audio session category options.",
+          "complexTypes": [
+            "AudioSessionCategoryOptions"
+          ],
+          "type": "AudioSessionCategoryOptions"
+        }
+      ]
+    },
+    {
+      "name": "AudioSessionCategoryOptions",
+      "slug": "audiosessioncategoryoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "allowAirPlay",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether AirPlay devices can be used for output.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "allowBluetooth",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether Bluetooth hands-free devices can be used for input and output.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "allowBluetoothA2DP",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether Bluetooth A2DP devices can be used for output.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "defaultToSpeaker",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether audio is routed to the built-in speaker instead of the receiver\nwhen no other audio route is connected.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "duckOthers",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether audio from other sessions is reduced in volume (ducked) while audio\nfrom this session plays.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "interruptSpokenAudioAndMixWithOthers",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether audio from other sessions using the `spokenAudio` mode is interrupted\nand audio from this session is mixed with the remaining audio.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "mixWithOthers",
+          "tags": [
+            {
+              "text": "false",
+              "name": "default"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether audio from this session mixes with audio from other active sessions\ninstead of interrupting them.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "GetCurrentOutputsResult",
+      "slug": "getcurrentoutputsresult",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "outputs",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The audio outputs of the current audio route.",
+          "complexTypes": [
+            "AudioSessionOutput"
+          ],
+          "type": "AudioSessionOutput[]"
+        }
+      ]
+    },
+    {
+      "name": "OverrideOutputOptions",
+      "slug": "overrideoutputoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "type",
+          "tags": [
+            {
+              "text": "'speaker'",
+              "name": "example"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The audio output port to route playback to.",
+          "complexTypes": [
+            "OverrideOutputType"
+          ],
+          "type": "OverrideOutputType"
+        }
+      ]
+    },
+    {
+      "name": "SetActiveOptions",
+      "slug": "setactiveoptions",
+      "docs": "",
+      "tags": [
+        {
+          "text": "0.1.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "active",
+          "tags": [
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether the audio session should be activated (`true`) or deactivated (`false`).",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "notifyOthersOnDeactivation",
+          "tags": [
+            {
+              "text": "true",
+              "name": "default"
+            },
+            {
+              "text": "0.1.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether other audio sessions are notified when this session is deactivated,\nso they can resume playback.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "InterruptionType",
+      "slug": "interruptiontype",
+      "docs": "The type of an audio session interruption.",
+      "types": [
+        {
+          "text": "'began'",
+          "complexTypes": []
+        },
+        {
+          "text": "'ended'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "RouteChangeReason",
+      "slug": "routechangereason",
+      "docs": "The reason why the audio route changed.",
+      "types": [
+        {
+          "text": "'categoryChange'",
+          "complexTypes": []
+        },
+        {
+          "text": "'newDeviceAvailable'",
+          "complexTypes": []
+        },
+        {
+          "text": "'noSuitableRouteForCategory'",
+          "complexTypes": []
+        },
+        {
+          "text": "'oldDeviceUnavailable'",
+          "complexTypes": []
+        },
+        {
+          "text": "'override'",
+          "complexTypes": []
+        },
+        {
+          "text": "'routeConfigurationChange'",
+          "complexTypes": []
+        },
+        {
+          "text": "'unknown'",
+          "complexTypes": []
+        },
+        {
+          "text": "'wakeFromSleep'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "AudioSessionCategory",
+      "slug": "audiosessioncategory",
+      "docs": "The audio session category.",
+      "types": [
+        {
+          "text": "'ambient'",
+          "complexTypes": []
+        },
+        {
+          "text": "'multiRoute'",
+          "complexTypes": []
+        },
+        {
+          "text": "'playAndRecord'",
+          "complexTypes": []
+        },
+        {
+          "text": "'playback'",
+          "complexTypes": []
+        },
+        {
+          "text": "'record'",
+          "complexTypes": []
+        },
+        {
+          "text": "'soloAmbient'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "AudioSessionMode",
+      "slug": "audiosessionmode",
+      "docs": "The audio session mode.",
+      "types": [
+        {
+          "text": "'default'",
+          "complexTypes": []
+        },
+        {
+          "text": "'gameChat'",
+          "complexTypes": []
+        },
+        {
+          "text": "'measurement'",
+          "complexTypes": []
+        },
+        {
+          "text": "'moviePlayback'",
+          "complexTypes": []
+        },
+        {
+          "text": "'spokenAudio'",
+          "complexTypes": []
+        },
+        {
+          "text": "'videoChat'",
+          "complexTypes": []
+        },
+        {
+          "text": "'videoRecording'",
+          "complexTypes": []
+        },
+        {
+          "text": "'voiceChat'",
+          "complexTypes": []
+        },
+        {
+          "text": "'voicePrompt'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "OverrideOutputType",
+      "slug": "overrideoutputtype",
+      "docs": "The audio output port to route playback to.",
+      "types": [
+        {
+          "text": "'default'",
+          "complexTypes": []
+        },
+        {
+          "text": "'speaker'",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}