https://github.com/mcluck90/cordova-plugin-android-volume

Allows you to set the volume in a Cordova app on an Android device
https://github.com/mcluck90/cordova-plugin-android-volume

android cordova cordova-android cordova-plugin volume

Last synced: 2 days ago
JSON representation

Allows you to set the volume in a Cordova app on an Android device

• Host: GitHub
• URL: https://github.com/mcluck90/cordova-plugin-android-volume
• Owner: MCluck90
• License: mit
• Created: 2017-07-14T19:39:23.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-08-13T16:43:07.000Z (over 4 years ago)
• Last Synced: 2024-04-25T15:02:30.805Z (10 months ago)
• Topics: android, cordova, cordova-android, cordova-plugin, volume
• Language: Java
• Size: 22.5 KB
• Stars: 10
• Watchers: 4
• Forks: 11
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cordova Android Volume Plugin

Very self-explanatory. Allows you to get and set the volume for Android devices in a Cordova app.

# API

## Get Functions

`success` is a callback called to return the volume. The first parameter is the volume level.

`error` is a callback called if anything goes wrong. (Optional)

```js

// Get the alarm volume level

window.androidVolume.getAlarm(success, error);

// Get the DTMF volume level

window.androidVolume.getDTMF(success, error);

// Get the music/media volume level

window.androidVolume.getMusic(success, error);

// Get the notification volume level

window.androidVolume.getNotification(success, error);

// Get the ringer volume level

window.androidVolume.getRinger(success, error);

// Get the system volume level

window.androidVolume.getSystem(success, error);

// Get the voice call volume level

window.androidVolume.getVoiceCall(success, error);

```

## Set Functions

`volume` is an integer between 0 and 100.

`showToast` is a boolean which, if true, will report the volume change in a toast message. Default: `true`. (Optional)

`success` is a callback called whenever the volume is changed. The first parameter is the new volume value. (Optional)

`error` is a calback called if anything goes wrong. (Optional)

```js

// Set all different types of volume to the same level

window.androidVolume.set(volume, showToast, success, error)

// Set the alarm volume level

window.androidVolume.setAlarm(volume, showToast, success, error)

// Set all different types of volume to the same level

// Alias for `set`

window.androidVolume.setAll(volume, showToast, success, error)

// Set the DTMF volume level

window.androidVolume.setDTMF(volume, showToast, success, error)

// Set the music/media volume level

window.androidVolume.setMusic(volume, showToast, success, error)

// Set the notification volume level

window.androidVolume.setNotification(volume, showToast, success, error)

// Set the ringer/ringtone volume level

window.androidVolume.setRinger(volume, showToast, success, error)

// Set the system volume level

window.androidVolume.setSystem(volume, showToast, success, error)

// Set the voice call volume level

window.androidVolume.setVoiceCall(volume, showToast, success, error)

```

## Events

To get updates whenever the volume of the device changes, you may register for `volume` updates

```js

window.addEventListener('volume', function(ev) {

    console.log("type " + ev.volumeType + ", level " + ev.volumeLevel);

}, false);

```