Flutter音量控制插件scrumlab_volume的使用

scrumlab_volume 插件简介

scrumlab_volume 是一个用于在 Android 应用程序中程序化控制音量的 Flutter 插件。目前尚未实现 iOS 支持，欢迎提交 PR 实现 iOS 支持。

Streams（流）

以下是支持的音频流类型：

AudioManager.STREAM_VOICE_CALL       // 控制通话音量
AudioManager.STREAM_SYSTEM           // 控制系统音量
AudioManager.STREAM_RING             // 控制铃声音量
AudioManager.STREAM_MUSIC            // 控制媒体音量
AudioManager.STREAM_ALARM            // 控制闹钟音量
AudioManager.STREAM_NOTIFICATION     // 控制通知音量

显示和隐藏系统音量界面

以下参数用于控制是否显示系统音量界面：

ShowVolumeUI.SHOW   // 默认值，显示系统音量界面
ShowVolumeUI.HIDE   // 不显示系统音量界面

函数与 getter

控制当前应用影响的音量流

await Volume.controlVolume(AudioManager audioManager);
// 参数为 Audio 管理器类型，例如 STREAM_SYSTEM

获取最大可能音量值

await Volume.getMaxVol;
// 返回整数值，表示最大音量级别

获取当前音量级别

await Volume.getVol;
// 返回整数值，表示当前音量级别

设置音量级别

await Volume.setVol(int i, {ShowVolumeUI showVolumeUI});
// 参数 i 表示目标音量级别，最大值 <= getMaxVol
// 参数 showVolumeUI 可选，默认为 ShowVolumeUI.SHOW

使用示例

以下是一个完整的示例代码，展示如何使用 scrumlab_volume 插件来控制音量。

示例代码

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

void main() => runApp(MyApp());

class MyApp extends StatefulWidget {
  [@override](/user/override)
  _MyAppState createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  late AudioManager audioManager;
  int? maxVol, currentVol;
  ShowVolumeUI showVolumeUI = ShowVolumeUI.SHOW;

  [@override](/user/override)
  void initState() {
    super.initState();
    audioManager = AudioManager.STREAM_SYSTEM;
    initAudioStreamType();
    updateVolumes();
  }

  Future<void> initAudioStreamType() async {
    // 初始化指定的音频流类型
    await Volume.controlVolume(AudioManager.STREAM_SYSTEM);
  }

  updateVolumes() async {
    // 更新最大音量和当前音量
    maxVol = await Volume.getMaxVol;
    currentVol = await Volume.getVol;
    setState(() {});
  }

  setVol(int i) async {
    // 设置目标音量
    await Volume.setVol(i, showVolumeUI: showVolumeUI);
    updateVolumes();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: const Text('音量控制示例'),
        ),
        body: Center(
          child: Column(
            mainAxisAlignment: MainAxisAlignment.spaceEvenly,
            children: <Widget>[
              // 音频流选择下拉菜单
              DropdownButton<AudioManager>(
                value: audioManager,
                items: [
                  DropdownMenuItem(
                    child: Text("通话音量"),
                    value: AudioManager.STREAM_VOICE_CALL,
                  ),
                  DropdownMenuItem(
                    child: Text("系统音量"),
                    value: AudioManager.STREAM_SYSTEM,
                  ),
                  DropdownMenuItem(
                    child: Text("铃声音量"),
                    value: AudioManager.STREAM_RING,
                  ),
                  DropdownMenuItem(
                    child: Text("媒体音量"),
                    value: AudioManager.STREAM_MUSIC,
                  ),
                  DropdownMenuItem(
                    child: Text("闹钟音量"),
                    value: AudioManager.STREAM_ALARM,
                  ),
                  DropdownMenuItem(
                    child: Text("通知音量"),
                    value: AudioManager.STREAM_NOTIFICATION,
                  ),
                ],
                isDense: true,
                onChanged: (AudioManager? aM) async {
                  if (aM != null) {
                    setState(() {
                      audioManager = aM;
                    });
                    await Volume.controlVolume(aM);
                    updateVolumes();
                  }
                },
              ),
              // 切换是否显示系统音量界面
              ToggleButtons(
                borderRadius: BorderRadius.all(Radius.circular(10.0)),
                children: <Widget>[
                  Padding(
                    padding: const EdgeInsets.all(20.0),
                    child: Text("显示 UI"),
                  ),
                  Padding(
                    padding: const EdgeInsets.all(20.0),
                    child: Text("隐藏 UI"),
                  ),
                ],
                isSelected: [
                  showVolumeUI == ShowVolumeUI.SHOW,
                  showVolumeUI == ShowVolumeUI.HIDE
                ],
                onPressed: (int i) {
                  setState(() {
                    if (i == 0) {
                      showVolumeUI = ShowVolumeUI.SHOW;
                    } else if (i == 1) {
                      showVolumeUI = ShowVolumeUI.HIDE;
                    }
                  });
                },
              ),
              // 滑块调整音量
              if (currentVol != null && maxVol != null)
                Slider(
                  value: (currentVol ?? 0).toDouble(),
                  divisions: maxVol,
                  max: (maxVol ?? 1).toDouble(),
                  min: 0,
                  onChanged: (double d) {
                    setVol(d.toInt());
                  },
                ),
            ],
          ),
        ),
      ),
    );
  }
}