Volume Controller

This plugin allows you to control and listen to the system volume on your device. It provides a simple API to get, set, and monitor the system volume.

Notes

For iOS, you need to test on a real device as the simulator does not support volume control.

Supported Platforms

Variables

• bool showSystemUI: Show or hide the volume system UI. The default value is true. Supported on iOS and Android only.

  VolumeController.instance.showSystemUI = true;
  

Functions

• getVolume: Get the current volume from the system.

  double volume = await VolumeController.instance.getVolume();
  

• setVolume: Set the system volume. The input is a double number in the range 0.0, 1.0.

  await VolumeController.instance.setVolume(double volume);
  

• addListener: Add a listener to monitor system volume changes.

  • fetchInitialVolume: This parameter is optional and is used to fetch the initial volume when the listener is added. The default value is true.

    VolumeController.instance.addListener((volume) {
      // Do something with the volume
    }, fetchInitialVolume: true);
    

• removeListener: Remove the volume listener.

  VolumeController.instance.removeListener();
  

• isMuted: Check if the system volume is muted. On iOS and Android, this checks if the volume level is equal to 0.

  bool isMuted = await VolumeController.instance.isMuted();
  

• setMute: Mute or unmute the system volume. On iOS and Android, this sets the volume level to 0, and restores the previous volume level when unmuted.

  await VolumeController.instance.setMute(bool mute);