@capgo/capacitor-audio-recorder 7.0.0

package/dist/docs.json

@@ -0,0 +1,646 @@
+{
+  "api": {
+    "name": "CapacitorAudioRecorderPlugin",
+    "slug": "capacitoraudiorecorderplugin",
+    "docs": "Capacitor plugin contract for recording audio.",
+    "tags": [
+      {
+        "text": "1.0.0",
+        "name": "since"
+      }
+    ],
+    "methods": [
+      {
+        "name": "startRecording",
+        "signature": "(options?: StartRecordingOptions | undefined) => Promise<void>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "Recording configuration options.",
+            "type": "StartRecordingOptions | undefined"
+          }
+        ],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "options Recording configuration options."
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Start recording audio using the device microphone.",
+        "complexTypes": [
+          "StartRecordingOptions"
+        ],
+        "slug": "startrecording"
+      },
+      {
+        "name": "pauseRecording",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Pause the ongoing recording. Only available on Android (API 24+), iOS, and Web.",
+        "complexTypes": [],
+        "slug": "pauserecording"
+      },
+      {
+        "name": "resumeRecording",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Resume a previously paused recording.",
+        "complexTypes": [],
+        "slug": "resumerecording"
+      },
+      {
+        "name": "stopRecording",
+        "signature": "() => Promise<StopRecordingResult>",
+        "parameters": [],
+        "returns": "Promise<StopRecordingResult>",
+        "tags": [
+          {
+            "name": "returns",
+            "text": "Recording metadata such as duration and URI/blob."
+          },
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Stop the current recording and persist the recorded audio.",
+        "complexTypes": [
+          "StopRecordingResult"
+        ],
+        "slug": "stoprecording"
+      },
+      {
+        "name": "cancelRecording",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Cancel the current recording and discard any captured audio.",
+        "complexTypes": [],
+        "slug": "cancelrecording"
+      },
+      {
+        "name": "getRecordingStatus",
+        "signature": "() => Promise<GetRecordingStatusResult>",
+        "parameters": [],
+        "returns": "Promise<GetRecordingStatusResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Retrieve the current recording status.",
+        "complexTypes": [
+          "GetRecordingStatusResult"
+        ],
+        "slug": "getrecordingstatus"
+      },
+      {
+        "name": "checkPermissions",
+        "signature": "() => Promise<PermissionStatus>",
+        "parameters": [],
+        "returns": "Promise<PermissionStatus>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Return the current permission state for accessing the microphone.",
+        "complexTypes": [
+          "PermissionStatus"
+        ],
+        "slug": "checkpermissions"
+      },
+      {
+        "name": "requestPermissions",
+        "signature": "() => Promise<PermissionStatus>",
+        "parameters": [],
+        "returns": "Promise<PermissionStatus>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Request permission to access the microphone.",
+        "complexTypes": [
+          "PermissionStatus"
+        ],
+        "slug": "requestpermissions"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'recordingError', listenerFunc: (event: RecordingErrorEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'recordingError'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: RecordingErrorEvent) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Listen for recording errors.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "RecordingErrorEvent"
+        ],
+        "slug": "addlistenerrecordingerror-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'recordingPaused', listenerFunc: () => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'recordingPaused'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "() => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Listen for pause events emitted when a recording is paused.",
+        "complexTypes": [
+          "PluginListenerHandle"
+        ],
+        "slug": "addlistenerrecordingpaused-"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'recordingStopped', listenerFunc: (event: RecordingStoppedEvent) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "",
+            "type": "'recordingStopped'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "",
+            "type": "(event: StopRecordingResult) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Listen for recording completion events.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "RecordingStoppedEvent"
+        ],
+        "slug": "addlistenerrecordingstopped-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "1.0.0"
+          }
+        ],
+        "docs": "Remove all registered listeners.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "StartRecordingOptions",
+      "slug": "startrecordingoptions",
+      "docs": "Options accepted by {@link CapacitorAudioRecorderPlugin.startRecording}.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "audioSessionCategoryOptions",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The audio session category options for recording. Only available on iOS.",
+          "complexTypes": [
+            "AudioSessionCategoryOption"
+          ],
+          "type": "AudioSessionCategoryOption[] | undefined"
+        },
+        {
+          "name": "audioSessionMode",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The audio session mode for recording. Only available on iOS.",
+          "complexTypes": [
+            "AudioSessionMode"
+          ],
+          "type": "AudioSessionMode"
+        },
+        {
+          "name": "bitRate",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The audio bit rate in bytes per second.\nOnly available on Android and iOS.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "sampleRate",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The audio sample rate in Hz.\nOnly available on Android and iOS.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "StopRecordingResult",
+      "slug": "stoprecordingresult",
+      "docs": "Result returned by {@link CapacitorAudioRecorderPlugin.stopRecording}.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "blob",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The recorded audio as a Blob. Only available on Web.",
+          "complexTypes": [
+            "Blob"
+          ],
+          "type": "Blob"
+        },
+        {
+          "name": "duration",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The duration of the recording in milliseconds.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "uri",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The URI pointing to the recorded file. Only available on Android and iOS.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        }
+      ]
+    },
+    {
+      "name": "GetRecordingStatusResult",
+      "slug": "getrecordingstatusresult",
+      "docs": "Result returned by {@link CapacitorAudioRecorderPlugin.getRecordingStatus}.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "status",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The current recording status.",
+          "complexTypes": [
+            "RecordingStatus"
+          ],
+          "type": "RecordingStatus"
+        }
+      ]
+    },
+    {
+      "name": "PermissionStatus",
+      "slug": "permissionstatus",
+      "docs": "Permission information returned by {@link CapacitorAudioRecorderPlugin.checkPermissions}\nand {@link CapacitorAudioRecorderPlugin.requestPermissions}.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "recordAudio",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The permission state for audio recording.",
+          "complexTypes": [
+            "PermissionState"
+          ],
+          "type": "PermissionState"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "RecordingErrorEvent",
+      "slug": "recordingerrorevent",
+      "docs": "Event emitted when an error occurs during recording.",
+      "tags": [
+        {
+          "text": "1.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "message",
+          "tags": [
+            {
+              "text": "1.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "The error message.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    }
+  ],
+  "enums": [
+    {
+      "name": "AudioSessionCategoryOption",
+      "slug": "audiosessioncategoryoption",
+      "members": [
+        {
+          "name": "AllowAirPlay",
+          "value": "'ALLOW_AIR_PLAY'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "AllowBluetooth",
+          "value": "'ALLOW_BLUETOOTH'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "AllowBluetoothA2DP",
+          "value": "'ALLOW_BLUETOOTH_A2DP'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "DefaultToSpeaker",
+          "value": "'DEFAULT_TO_SPEAKER'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "DuckOthers",
+          "value": "'DUCK_OTHERS'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "InterruptSpokenAudioAndMixWithOthers",
+          "value": "'INTERRUPT_SPOKEN_AUDIO_AND_MIX_WITH_OTHERS'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "MixWithOthers",
+          "value": "'MIX_WITH_OTHERS'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "OverrideMutedMicrophoneInterruption",
+          "value": "'OVERRIDE_MUTED_MICROPHONE_INTERRUPTION'",
+          "tags": [],
+          "docs": ""
+        }
+      ]
+    },
+    {
+      "name": "AudioSessionMode",
+      "slug": "audiosessionmode",
+      "members": [
+        {
+          "name": "Default",
+          "value": "'DEFAULT'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "GameChat",
+          "value": "'GAME_CHAT'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "Measurement",
+          "value": "'MEASUREMENT'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "SpokenAudio",
+          "value": "'SPOKEN_AUDIO'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "VideoChat",
+          "value": "'VIDEO_CHAT'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "VideoRecording",
+          "value": "'VIDEO_RECORDING'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "VoiceChat",
+          "value": "'VOICE_CHAT'",
+          "tags": [],
+          "docs": ""
+        }
+      ]
+    },
+    {
+      "name": "RecordingStatus",
+      "slug": "recordingstatus",
+      "members": [
+        {
+          "name": "Inactive",
+          "value": "'INACTIVE'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "Recording",
+          "value": "'RECORDING'",
+          "tags": [],
+          "docs": ""
+        },
+        {
+          "name": "Paused",
+          "value": "'PAUSED'",
+          "tags": [],
+          "docs": ""
+        }
+      ]
+    }
+  ],
+  "typeAliases": [
+    {
+      "name": "PermissionState",
+      "slug": "permissionstate",
+      "docs": "",
+      "types": [
+        {
+          "text": "'prompt'",
+          "complexTypes": []
+        },
+        {
+          "text": "'prompt-with-rationale'",
+          "complexTypes": []
+        },
+        {
+          "text": "'granted'",
+          "complexTypes": []
+        },
+        {
+          "text": "'denied'",
+          "complexTypes": []
+        }
+      ]
+    },
+    {
+      "name": "RecordingStoppedEvent",
+      "slug": "recordingstoppedevent",
+      "docs": "Event emitted when a recording completes.",
+      "types": [
+        {
+          "text": "StopRecordingResult",
+          "complexTypes": [
+            "StopRecordingResult"
+          ]
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}