win32audio

https://pub.dev/packages/win32audio
Admin
A Flutter Windows plugin that manages audio devices, allows setting default devices and...
Tokens:3,212
Snippets:28
Trust Score:9.9
Update:6 months ago
Show doc for...
Tokens:
Raw
### Listen to Audio Changes

Source: https://pub.dev/packages/win32audio

Setup and add listeners to track audio device state changes.

```dart
void main() {
    
  WidgetsFlutterBinding.ensureInitialized();
  await Audio.setupChangeListener();
}
[...]
initState() {
    Audio.addChangeListener((String type, String id) async {
      print(type);
      print(id);
    });
}
```

--------------------------------

### Manage Default Audio Device

Source: https://pub.dev/packages/win32audio

Get, set, or cycle through the default audio device.

```dart
  var defaultDevice = AudioDevice();
  
  defaultDevice = (await Audio.getDefaultDevice(audioDeviceType))!;
```

```dart
await Audio.setDefaultDevice(audioDevices[0].id, {bool console = false, bool multimedia = true, bool communications = false});
```

```dart
    await Audio.switchDefaultDevice(audioDeviceType, {bool console = false, bool multimedia = true, bool communications = false});
```

--------------------------------

### Initialize Win32 Audio Plugin

Source: https://pub.dev/packages/win32audio/example

Sets up the Flutter binding and initializes the audio change listener. This should be called at the beginning of the application's main function.

```dart
import 'package:flutter/material.dart';
import 'dart:async';

import 'package:win32audio/win32audio.dart';
import 'widgets/animated_progress_bar.dart';
import 'widgets/win_icon_widget.dart';

void main() async {
  WidgetsFlutterBinding.ensureInitialized();
  await Audio.setupChangeListener();
  runApp(const MyApp());
}
```

--------------------------------

### Enumerate Audio Devices and Mixers

Source: https://pub.dev/packages/win32audio

Retrieve lists of available audio devices or active process volumes.

```dart
  var audioDevices = <AudioDevice>[];

    audioDevices = await Audio.enumDevices(audioDeviceType) ?? [];
```

```dart
  var mixerList = <ProcessVolume>[];

  mixerList = await Audio.enumAudioMixer() ?? [];
```

--------------------------------

### Implement Audio Device UI Controls

Source: https://pub.dev/packages/win32audio/example

UI components for fetching audio devices and switching the default device using the win32audio package.

```dart
                  alignment: Alignment.centerLeft,
                  width: 100,
                  child: TextButton(
                    child: Text(
                      fetchStatus,
                      style: const TextStyle(color: Colors.white),
                      strutStyle: const StrutStyle(forceStrutHeight: true),
                    ),
                    onPressed: () async {
                      setState(() {
                        fetchStatus = 'Getting...';
                      });
                      fetchAudioDevices();
                    },
                  ),
                ),
                Row(
                  crossAxisAlignment: CrossAxisAlignment.end,
                  children: <Widget>[
                    Container(
                      alignment: Alignment.centerRight,
                      child: TextButton(
                          child: Row(
                            mainAxisAlignment: MainAxisAlignment.end,
                            crossAxisAlignment: CrossAxisAlignment.center,
                            children: <Widget>[
                              Padding(
                                padding: const EdgeInsets.only(right: 5),
                                child: Align(
                                  alignment: Alignment.topCenter,
                                  heightFactor: 1.15,
                                  child: Text(
                                    defaultDevice.name,
                                    textAlign: TextAlign.justify,
                                    style: const TextStyle(color: Colors.black),
                                    strutStyle: const StrutStyle(forceStrutHeight: true),
                                  ),
                                ),
                              ),
                              const Icon(Icons.swap_vertical_circle_outlined, color: Colors.black),
                            ],
                          ),
                          onPressed: () async {
                            await Audio.switchDefaultDevice(audioDeviceType);
                            fetchAudioDevices();
                            setState(() {});
                          }),
                    ),
                  ],
                ),
              ],
            ),
          ),
        ),
        body: Column(
          mainAxisAlignment: MainAxisAlignment.spaceBetween,
          children: <Widget>[
            //?  SELECT AUDIO DEVICE
            //? DROPDOWN
            Column(children: <Widget>[
              DropdownButton<AudioDeviceType>(
                  value: audioDeviceType,
                  items: AudioDeviceType.values.map((AudioDeviceType e) {
                    return DropdownMenuItem<AudioDeviceType>(
                      value: e,
                      child: Text(e.toString()),
                    );
                  }).toList(),
                  onChanged: (Object? e) async {
                    audioDeviceType = e as AudioDeviceType;
                    fetchStatus = e.toString();
                    fetchAudioDevices();
                    setState(() {});
                  }),
            ]),
            //? VOLUME INFO
            Flexible(
              //VOLUME
              flex: 1,
              fit: FlexFit.tight,
              child: Center(
                child: Text(
                  "Volume:${(__volume * 100).toStringAsFixed(0)}%",
                  style: const TextStyle(fontSize: 32),
                ),
              ),
            ),
            //? VOLUMESCROLLER
            Flexible(
              //SLIDER
              flex: 1,
              fit: FlexFit.tight,
              child: Slider(
                value: __volume,
                min: 0,
                max: 1,
                divisions: 25,
                onChanged: (double e) async {
                  await Audio.setVolume(e.toDouble(), audioDeviceType);
                  __volume = e;
                  setState(() {});
                },
              ),
            ),
            //? LIST AUDIO DEVICES
            Flexible(
                flex: 2,
                fit: FlexFit.loose,
                child: ListView.builder(
                    itemCount: audioDevices.length,
                    itemBuilder: (BuildContext context, int index) {
                      return ListTile(
                        leading: WinIconWidget(
                          path: audioDevices[index].iconPath,
                          iconID: audioDevices[index].iconID,
                        ),
                        title: Text(audioDevices[index].name),
                        trailing: Row(
                          mainAxisSize: MainAxisSize.min,
                          children: <Widget>[
                            IconButton(
                              icon: const Icon(Icons.graphic_eq),
                              tooltip: 'Sample Rate',
```

--------------------------------

### Add win32audio to pubspec.yaml

Source: https://pub.dev/packages/win32audio/install

Manually add the dependency to your project configuration file.

```yaml
dependencies:
  win32audio: ^1.5.0
```

--------------------------------

### Add win32audio dependency via CLI

Source: https://pub.dev/packages/win32audio/install

Use this command in your terminal to add the package to your Flutter project.

```bash
 $ flutter pub add win32audio
```

--------------------------------

### Fetch Audio Devices and Volume

Source: https://pub.dev/packages/win32audio/example

Retrieves a list of available audio devices for a specified type, sets the default volume, and fetches the default audio device. It also retrieves the audio mixer list.

```dart
Future<void> fetchAudioDevices() async {
    if (!mounted) return;
    audioDevices = await Audio.enumDevices(audioDeviceType) ?? <AudioDevice>[];
    __volume = await Audio.getVolume(audioDeviceType);
    defaultDevice = (await Audio.getDefaultDevice(audioDeviceType))!;

    mixerList = await Audio.enumAudioMixer() ?? <ProcessVolume>[];

    if (mounted) {
      setState(() {
        fetchStatus = "Get";
      });
    }
  }
```

--------------------------------

### Import win32audio in Dart

Source: https://pub.dev/packages/win32audio/install

Include this import statement to access the package functionality in your Dart files.

```dart
import 'package:win32audio/win32audio.dart';
```

--------------------------------

### Periodic Audio Mixer Update

Source: https://pub.dev/packages/win32audio/example

Periodically fetches the audio mixer list to display real-time volume levels for different processes. This timer should be managed appropriately, especially in `initState` and `dispose`.

```dart
Timer.periodic(const Duration(milliseconds: 150), (Timer timer) async {
      if (_stateFetchAudioMixerPeak) {
        mixerList = await Audio.enumAudioMixer() ?? <ProcessVolume>[];
        if (mounted) setState(() {});
      }
    });
```

--------------------------------

### Define Audio Data Structures

Source: https://pub.dev/packages/win32audio

Core classes and enums used for representing audio devices and process volumes.

```dart
class AudioDevice {
  String id = "";
  String name = "";
  String iconPath = "";
  int iconID = 0;
  bool isActive = false;
}

class ProcessVolume {
  int processId = 0;
  String processPath = "";
  double maxVolume = 1.0;
  double peakVolume = 0.0;
}

enum AudioDeviceType {
  output,
  input,
}
```

--------------------------------

### Build Event Log UI

Source: https://pub.dev/packages/win32audio/example

This Flutter code snippet demonstrates how to build a UI element for displaying an event log using a ListView. It includes a Divider, a Center widget with a Text, and a Flexible widget containing a ListView.builder to display log entries.

```dart
const Divider(
  thickness: 5,
  height: 10,
  color: Color.fromARGB(12, 0, 0, 0),
),
const Center(child: Text("Event Log")),
//? EVENT LOG
Flexible(
  flex: 2,
  child: Container(
    color: Colors.grey[200],
    child: ListView.builder(
        itemCount: eventLog.length,
        itemBuilder: (BuildContext context, int index) {
          return Padding(
            padding: const EdgeInsets.symmetric(horizontal: 8.0, vertical: 2.0),
            child: Text(
              eventLog[index],
              style: const TextStyle(fontSize: 10),
            ),
          );
        }),
  ),
)
```

--------------------------------

### Change Audio Sample Rate

Source: https://pub.dev/packages/win32audio/example

Allows the user to select and change the sample rate for a specific audio device. Displays a dialog with current and available sample rates. Requires administrator privileges for successful changes.

```dart
Future<void> _showSampleRateDialog(BuildContext context, AudioDevice device) async {
    // Get current sample rate
    int currentRate = await Audio.getSampleRate(device.id);

    if (!context.mounted) return;

    final int? selectedRate = await showDialog<int>(
      context: context,
      builder: (BuildContext context) {
        return StatefulBuilder(
          builder: (BuildContext context, StateSetter setState) {
            int? tempSelectedRate = currentRate;

            return AlertDialog(
              title: Text('Sample Rate - ${device.name}'),
              content: RadioGroup<int>(
                groupValue: tempSelectedRate,
                onChanged: (int? value) {
                  if (value != null) {
                    setState(() => tempSelectedRate = value);
                    Navigator.of(context).pop(value);
                  }
                },
                child: Column(
                  mainAxisSize: MainAxisSize.min,
                  crossAxisAlignment: CrossAxisAlignment.start,
                  children: <Widget>[
                    Text('Current: ${currentRate > 0 ? "$currentRate Hz" : "Unknown"}'),
                    const SizedBox(height: 20),
                    const Text('Select new sample rate:'),
                    const SizedBox(height: 10),
                    ...<int>[44100, 48000, 96000, 192000].map((int rate) {
                      return ListTile(title: Text('$rate Hz'), leading: Radio<int>(value: rate));
                    }),
                  ],
                ),
              ),
              actions: <Widget>[
                TextButton(
                  onPressed: () => Navigator.of(context).pop(),
                  child: const Text('Cancel'),
                ),
              ],
            );
          },
        );
      },
    );

    if (selectedRate != null && context.mounted) {
      bool success = await Audio.setSampleRate(device.id, selectedRate);

      if (context.mounted) {
        ScaffoldMessenger.of(context).showSnackBar(
          SnackBar(
            content: Text(
              success ? 'Sample rate changed to $selectedRate Hz' : 'Failed to change sample rate. Try running as administrator.',
            ),
            backgroundColor: success ? Colors.green : Colors.red,
          ),
        );
      }
    }
  }
```

--------------------------------

### Set Default Audio Device

Source: https://pub.dev/packages/win32audio/example

Sets the default audio device for the system. This function requires the device ID. After setting the default device, it's recommended to refresh the list of audio devices and update the UI.

```dart
await Audio.setDefaultDevice(audioDevices[index].id);
fetchAudioDevices();
setState(() {});
```

--------------------------------

### Extract Native Icons

Source: https://pub.dev/packages/win32audio

Convert native file icons into bytes for use in Flutter Image widgets.

```dart
    Map<String, Uint8List?> _audioIcons = {};
    _audioIcons = {};
    for (var audioDevice in audioDevices) {
      if (_audioIcons[audioDevice.id] == null) {
        _audioIcons[audioDevice.id] = await nativeIconToBytes(audioDevice.iconPath, iconID: audioDevice.iconID);
      }
    }
///....
widget: (_audioIcons.containsKey(audioDevices[index].id))
                            ? Image.memory(
                                _audioIcons[audioDevices[index].id] ?? Uint8List(0),
                                width: 32,
                                height: 32,
                              )
                            : const Icon(Icons.spoke_outlined),
```

--------------------------------

### Audio Change Listener Registration

Source: https://pub.dev/packages/win32audio/example

Adds a listener that is called whenever an audio-related event occurs, such as a device change or volume adjustment. The listener receives the type and ID of the event.

```dart
Audio.addChangeListener((String type, String id) async {
      if (mounted) {
        setState(() {
          eventLog.insert(0, "$type: $id");
          if (eventLog.length > 50) eventLog.removeLast();
        });
      }
    });
```

--------------------------------

### Control Audio Volume

Source: https://pub.dev/packages/win32audio

Adjust master volume or specific application volume levels using a double between 0 and 1.

```dart
    final volume = await Audio.getVolume(audioDeviceType);
```

```dart
    final volume = await Audio.setVolume(0.5,audioDeviceType);
```

```dart
    await Audio.setAudioMixerVolume(mixerList[0].processId, 0.3);
```

--------------------------------

### Control Audio Mixer Volume

Source: https://pub.dev/packages/win32audio/example

Adjusts the volume of a specific audio mixer identified by its process ID. The volume is set as a double between 0.0 and 1.0. The UI is updated to reflect the new volume and peak level.

```dart
await Audio.setAudioMixerVolume(mixerList[index].processId, e.toDouble());
mixerList[index].maxVolume = e;
setState(() {});
```
Tokens:
Raw