Mozartec Capacitor Microphone
@mozartec/capacitor-microphone
This Microphone API provides the ability to interact with the microphone and record Audio
[](https://github.com/mozartec/capacitor-microphone/graphs/commit-activity) [](/LICENSE)
[](https://david-dm.org/mozartec/capacitor-microphone) [](https://david-dm.org/mozartec/capacitor-microphone?type=dev)
[](https://www.npmjs.com/package/@mozartec/capacitor-microphone) [](https://www.npmjs.com/package/@mozartec/capacitor-microphone)
## Platform support
| | iOS | Android | Web (Preview) |
| ------------ |--------------------- | ------------------ | ------------------ |
| Availability | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| Encoding | kAudioFormatMPEG4AAC (audio/aac) | MPEG_4 / AAC (audio/aac) | audio/webm or audio/mp4 or audio/ogg or audio/wav |
| Extension | .m4a | .m4a | .webm or .mp4 or .ogg or .wav |
## Installation
## Install
```bash
npm install @mozartec/capacitor-microphone
npx cap sync
```
## Demo
[Demo code](_demo/)
## iOS
iOS requires the following usage description to be added and filled out for your app in `Info.plist`:
- `NSMicrophoneUsageDescription` (`Privacy - Microphone Usage Description`)
Read about [Configuring `Info.plist`](https://capacitorjs.com/docs/ios/configuration#configuring-infoplist) in the [iOS Guide](https://capacitorjs.com/docs/ios) for more information on setting iOS permissions in Xcode.
## Android
This API requires the following permission to be added to your `AndroidManifest.xml`:
```xml
```
The RECORD_AUDIO permission is for recording audio.
Read about [Setting Permissions](https://capacitorjs.com/docs/android/configuration#setting-permissions) in the [Android Guide](https://capacitorjs.com/docs/android) for more information on setting Android permissions.
## API
* [`checkPermissions()`](#checkpermissions)
* [`requestPermissions()`](#requestpermissions)
* [`startRecording()`](#startrecording)
* [`stopRecording()`](#stoprecording)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)
### checkPermissions()
```typescript
checkPermissions() => Promise
```
Checks microphone permission
**Returns:** Promise<PermissionStatus>
**Since:** 0.0.3
--------------------
### requestPermissions()
```typescript
requestPermissions() => Promise
```
Requests microphone permission
**Returns:** Promise<PermissionStatus>
**Since:** 0.0.3
--------------------
### startRecording()
```typescript
startRecording() => Promise<{ status: string; }>
```
Starts recoding session if no session is in progress
**Returns:** Promise<{ status: string; }>
**Since:** 0.0.3
--------------------
### stopRecording()
```typescript
stopRecording() => Promise
```
Stops recoding session if one is in progress
**Returns:** Promise<AudioRecording>
**Since:** 0.0.3
--------------------
### Interfaces
#### PermissionStatus
| Prop | Type |
| ---------------- | ------------------------------------------------------------------------------- |
| **`microphone`** | MicrophonePermissionState |
#### AudioRecording
| Prop | Type | Description | Since |
| ------------------ | ------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
| **`base64String`** | string | The base64 encoded string representation of the audio file. | 0.0.3 |
| **`dataUrl`** | string | The url starting with 'data:audio/aac;base64,' and the base64 encoded string representation of the audio file. | 0.0.3 |
| **`path`** | string | platform-specific file URL that can be read later using the Filesystem API. | 0.0.3 |
| **`webPath`** | string | webPath returns a path that can be used to set the src attribute of an audio element can be useful for testing. | 0.0.3 |
| **`duration`** | number | recoding duration in milliseconds | 0.0.3 |
| **`format`** | string | file extension: ".m4a" for (iOS and Android) and ".webm" \| ".mp4" \| ".ogg" \| ".wav" for Web based on compatibility | 0.0.3 |
| **`mimeType`** | string | file encoding: "audio/aac" for (iOS and Android) and "audio/webm \| "audio/mp4" \| "audio/ogg" \| "audio/wav" for Web based on compatibility | 0.0.3 |
### Type Aliases
#### MicrophonePermissionState
PermissionState | 'limited'
#### PermissionState
'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'