[!IMPORTANT]
This repository has been merged into @capacitor-community/volume-buttons, where is it going to be actively maintained

capacitor-volume-buttons

Hardware volume buttons listener for Capacitor

Install

npm install capacitor-custom-button
npx cap sync

Quick example

  useEffect(() => {
    const onCustomButtonPressed = ({ isLongPress }: CustomButtonPressed) => {
      console.log(key);
    };

    const listener = CustomButton.addListener('customButtonPressed', onCustomButtonPressed);

    return () => {
      listener.remove();
    };
  }, []);

API

• addListener('pttButtonPressed', ...)
• addListener('headsetButtonPressed', ...)
• removeAllListeners()
• Interfaces
• Type Aliases

addListener('pttButtonPressed', ...)

addListener(event: 'pttButtonPressed', listenerFunc: ButtonPressedListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for presses on the hardware CUSTOM PTT button

| Param | Type | | ------------------ | ----------------------------------------------------------------------- | | event | 'pttButtonPressed' | | listenerFunc | ButtonPressedListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.0.0

addListener('headsetButtonPressed', ...)

addListener(event: 'headsetButtonPressed', listenerFunc: ButtonPressedListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for presses on the hardware HEADSET PTT button

| Param | Type | | ------------------ | ----------------------------------------------------------------------- | | event | 'headsetButtonPressed' | | listenerFunc | ButtonPressedListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.0.0

removeAllListeners()

removeAllListeners() => Promise<void>

Removes all listeners for this plugin

Since: 1.0.0

Interfaces

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |

Type Aliases

ButtonPressedListener

({ isLongPress }: ButtonPressed): void

ButtonPressed

{ isLongPress: boolean }