Flutter音乐播放插件musicfy的使用

Flutter音乐播放插件musicfy的使用

特性

• 从设备的媒体库中检索音乐文件列表。
• 获取每首曲目的元数据：标题、艺术家、专辑和路径。
• 处理权限请求以访问媒体库。

开始使用

此项目是一个Flutter插件，它为在Android和iOS设备上访问音乐元数据提供了简单的接口。

安装

要在您的Flutter项目中使用musicfy，将其添加到pubspec.yaml文件中：

dependencies:
  musicfy: ^1.0.0

然后运行以下命令：

flutter pub get

平台设置

Android

1. 打开AndroidManifest.xml文件并添加所需的权限以访问媒体库：

<uses-permission android:name="android.permission.READ_MEDIA_AUDIO" />
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />

1. 确保使用permission_handler包处理运行时权限。

iOS

iOS的支持即将推出。请确保在Info.plist文件中添加必要的权限：

<key>NSAppleMusicUsageDescription</key>
<string>我们需要访问您的音乐库</string>

此功能尚未完全支持，但将在未来的版本中提供。

使用方法

以下是您如何在Flutter应用程序中使用musicfy插件的方法：

1. 导入musicfy包：

import 'package:musicfy/musicfy.dart';
import 'package:permission_handler/permission_handler.dart';

1. 请求访问媒体库所需的权限：

PermissionStatus status = await Permission.audio.request();
if (status.isGranted) {
  final musicList = await Musicfy().getMusicList();
  // 处理音乐列表
} else {
  // 处理权限被拒绝的情况
}

1. 显示检索到的音乐列表：

ListView.builder(
  itemCount: musicList.length,
  itemBuilder: (context, index) {
    final music = musicList[index];
    return ListTile(
      title: Text(music['title']),
      subtitle: Text('${music['artist']} - ${music['album']}'),
      leading: Icon(Icons.music_note),
    );
  },
);

API

getMusicList()

• 返回值：一个包含以下键的地图列表：
  • title：曲目的标题。
  • artist：曲目的艺术家。
  • album：曲目的专辑名称。
  • path：曲目在设备上的文件路径。

权限

该插件需要以下权限：

• Android：READ_EXTERNAL_STORAGE 和 READ_MEDIA_AUDIO
• iOS：NSAppleMusicUsageDescription（未来iOS支持）

请确保使用permission_handler包在运行时请求权限。

贡献

我们欢迎对musicfy插件的贡献！请按照以下步骤进行贡献：

1. 分叉仓库。
2. 创建一个新的分支。
3. 进行您的更改。
4. 运行测试以确保一切正常工作。
5. 提交一个拉取请求。

作者

该项目由Meysam Alizadeh维护。 邮箱：m10551691@gmail.com

许可证

该项目受MIT许可证保护 - 详情请参阅LICENSE文件。

示例代码

import 'package:flutter/material.dart';
import 'package:permission_handler/permission_handler.dart';
import 'package:musicfy/musicfy.dart';
import 'package:just_audio/just_audio.dart';

void main() {
  runApp(MyApp());
}

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

class _MyAppState extends State<MyApp> {
  final Musicfy _musicfy = Musicfy();
  final AudioPlayer _audioPlayer = AudioPlayer();
  List<dynamic> _musicList = [];
  String? _currentlyPlaying;

  [@override](/user/override)
  void initState() {
    super.initState();
    fetchMusicList();
  }

  [@override](/user/override)
  void dispose() {
    // 释放AudioPlayer以避免资源占用
    _audioPlayer.dispose();
    super.dispose();
  }

  Future<void> fetchMusicList() async {
    // 请求媒体访问权限
    PermissionStatus status = await Permission.audio.request();

    if (status.isGranted) {
      try {
        // 如果权限被授予，获取音乐列表
        final musicList = await _musicfy.getMusicList();
        setState(() {
          _musicList = musicList;
        });
      } catch (e) {
        print('Error fetching music list: $e');
      }
    } else if (status.isPermanentlyDenied) {
      // 如果权限永久被拒绝，引导用户到应用设置
      print('Permission permanently denied. Redirecting to app settings...');
      openAppSettings();
    } else {
      // 如果权限被拒绝
      print('Permission denied.');
    }
  }

  Future<void> playMusic(String path) async {
    try {
      await _audioPlayer.setFilePath(path); // 设置文件路径以播放
      await _audioPlayer.play(); // 播放音乐
      setState(() {
        _currentlyPlaying = path;
      });
    } catch (e) {
      print('Error playing music: $e');
    }
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Musicfy Plugin Example'),
        ),
        body: _musicList.isEmpty
            ? Center(
                child: Text('No music found or permission denied.'),
              )
            : ListView.builder(
                itemCount: _musicList.length,
                itemBuilder: (context, index) {
                  final music = _musicList[index];
                  final isPlaying = _currentlyPlaying == music['path'];
                  return ListTile(
                    title: Text(music['title']),
                    subtitle: Text('${music['artist']} - ${music['album']}'),
                    trailing: IconButton(
                      icon: Icon(
                        isPlaying ? Icons.pause_circle : Icons.play_circle,
                        color: isPlaying ? Colors.green : Colors.blue,
                      ),
                      onPressed: () {
                        playMusic(music['path']);
                      },
                    ),
                  );
                },
              ),
      ),
    );
  }
}