3.0.0 • Published 1 year ago

ionic-cap-volume-button-listener v3.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

ionic-cap-volume-button-listener

Listen for Volume Button pressed in IONIC Capacitor Project

Install

npm install ionic-cap-volume-button-listener
npx cap sync

API

addListener('volumeButtonPressed', ...)

addListener(event: 'volumeButtonPressed', listenerFunc: VolumeButtonPressedListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for presses on the hardware volume buttons

ParamType
event'volumeButtonPressed'
listenerFuncVolumeButtonPressedListener

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.0.0


removeAllListeners()

removeAllListeners() => Promise<void>

Removes all listeners for this plugin

Since: 1.0.0


Interfaces

PluginListenerHandle

PropType
remove() => Promise<void>

Type Aliases

VolumeButtonPressedListener

({ direction, }: VolumeButtonPressed): void

VolumeButtonPressed

{ direction: 'up' | 'down' }

For Android Only if(direction == 'up' ) Then Event will not be captures and continue original function like volume increase

if(direction == 'down' ) Then Event will be captures and no further action will be performed like no volume decrease

Credit: https://github.com/thiagobrez/capacitor-volume-buttons