This plugin is designed to provide easy access to native audio settings on both Android and iOS platforms within the Capacitor framework.
The plugin offers a unified API to retrieve and monitor audio settings, allowing developers to seamlessly integrate audio-related functionalities into their Capacitor applications.
npm install native-audio-settings
npx cap sync
getMainVolume() => Promise<{ mainVolume: number; maxMainVolume: number; }>
Returns: Promise<{ mainVolume: number; maxMainVolume: number; }>
getNotificationVolume() => Promise<{ notificationVolume: number; maxNotificationVolume: number; }>
Returns: Promise<{ notificationVolume: number; maxNotificationVolume: number; }>
addListener(eventName: 'notificationVolumeChange', listenerFunc: (info: { notificationVolume: number; maxNotificationVolume: number; }) => void) => Promise<{ remove: () => void; }>
Param | Type |
---|---|
eventName |
'notificationVolumeChange' |
listenerFunc |
(info: { notificationVolume: number; maxNotificationVolume: number; }) => void |
Returns: Promise<{ remove: () => void; }>
We appreciate your contribution to enhance and expand the project. To ensure a smooth and rewarding collaboration process, please follow these guidelines.
Before starting development work, please create an Issue to discuss the changes you want to implement. This allows for feedback and a shared understanding of the purpose and scope of your proposed contribution.
Create a fork of this repository and work in your fork instead of the main repository. This ensures that your changes can be reviewed before being integrated into the main project.
Adhere to existing code conventions and style in the project. A consistent codebase facilitates review and maintenance.
Open a pull request against the main repository when your work is ready for review. Please provide a clearly formulated description of your changes and additions.
Expect constructive review of your work. Be prepared to make changes and answer questions during the review process.
Ensure that your changes are thoroughly tested.
Most importantly, have fun! Contributing to open source is a positive experience, and we appreciate your effort.
None yet, but bring it on!
This project is licensed under the MIT License - see the LICENSE.md file for details.
Development of the native-audio-settings plugin is ongoing, with regular updates and enhancements. If you are interested in contributing or becoming a maintainer, please reach out.