npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@mozartec/capacitor-microphone

v6.0.0

Published

This Microphone API provides the ability to interact with the microphone and record Audio

Downloads

6,051

Readme

This Microphone API provides the ability to interact with the microphone and record Audio

Maintenance License Dependency Status devDependency Status npm version NPM Downloads

Platform support

| | iOS | Android | Web | | ------------ |--------------------- | ------------------ | ------------------ | | Availability | :heavy_check_mark: | :heavy_check_mark: | :x: | | Encoding | kAudioFormatMPEG4AAC | MPEG_4 / AAC | :x: | | Extension | .m4a | .m4a | :x: |

Installation

Install

npm install @mozartec/capacitor-microphone
npx cap sync

Demo

Demo code

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 in the iOS Guide for more information on setting iOS permissions in Xcode.

Android

This API requires the following permission to be added to your AndroidManifest.xml:

<uses-permission android:name="android.permission.RECORD_AUDIO" />

The RECORD_AUDIO permission is for recording audio.

Read about Setting Permissions in the Android Guide for more information on setting Android permissions.

API

checkPermissions()

checkPermissions() => Promise<PermissionStatus>

Checks microphone permission

Returns: Promise<PermissionStatus>

Since: 0.0.3


requestPermissions()

requestPermissions() => Promise<PermissionStatus>

Requests microphone permission

Returns: Promise<PermissionStatus>

Since: 0.0.3


startRecording()

startRecording() => Promise<void>

Starts recoding session if no session is in progress

Since: 0.0.3


stopRecording()

stopRecording() => Promise<AudioRecording>

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 (only .m4a supported on this version) | 0.0.3 | | mimeType | string | file encoding "audio/aac" (kAudioFormatMPEG4AAC for iOS) (MPEG_4 / AAC for Android) | 0.0.3 |

Type Aliases

MicrophonePermissionState

PermissionState | 'limited'

PermissionState

'prompt' | 'prompt-with-rationale' | 'granted' | 'denied'