Flutter音频标签编辑插件audiotagger的使用

audiotagger

此库允许你读取和写入MP3文件的ID3标签。
基于JAudiotagger库。

注意：该库目前仅在Android上有效。

添加依赖

dependencies:
  audiotagger: ^2.2.1

Audiotagger需要访问读取和写入存储权限。
你可以使用权限处理库来实现这一点。

目录

• 基本用法
• 读取操作
  • 读取标签作为Tag对象
  • 读取标签作为Map
  • 读取封面艺术
  • 读取音频文件作为AudioFile对象
  • 读取音频文件作为Map
• 写入操作
  • 从Map写入标签
  • 从Tag对象写入标签
  • 写入单个标签字段
• 模型
  • Tag类
  • AudioFile类

基本用法

初始化一个新的标记器实例；

final tagger = new Audiotagger();

读取操作

读取标签作为Tag对象

获取文件的ID3标签作为Tag对象。

void getTags() async {
    final String filePath = "/storage/emulated/0/file.mp3";
    final Tag tag = await tagger.readTags(
        path: filePath
    );
}

注意：这种方法不会读取歌曲的封面艺术。为此，请使用readArtwork方法。

Tag对象具有以下模式：Tag对象模式。

读取标签作为Map

获取文件的ID3标签作为Map。

void getTagsAsMap() async {
    final String filePath = "/storage/emulated/0/file.mp3";
    final Map map = await tagger.readTagsAsMap(
        path: filePath
    );
}

注意：这种方法不会读取歌曲的封面艺术。为此，请使用readArtwork方法。

该Map具有以下模式：Map of Tag模式。

读取封面艺术

获取歌曲的封面艺术作为Uint8List。

void getArtwork() async {
    final String filePath = "/storage/emulated/0/file.mp3";
    final Uint8List bytes = await tagger.readArtwork(
        path: filePath
    );
}

读取音频文件作为AudioFile对象

获取MP3文件的信息作为AudioFile对象。

void getAudioFile() async {
    final String filePath = "/storage/emulated/0/file.mp3";
    final AudioFile audioFile = await tagger.readAudioFile(
        path: filePath
    );
}

AudioFile对象具有以下模式：AudioFile对象模式。

读取音频文件作为Map

获取MP3文件的信息作为Map。

void getAudioFileAsMap() async {
    final String filePath = "/storage/emulated/0/file.mp3";
    final Map map = await tagger.readAudioFileAsMap(
        path: filePath
    );
}

该Map具有以下模式：Map of AudioFile模式。

写入操作

从Map写入标签

你可以从一个Map写入ID3标签。
要重置一个字段，请传递一个空字符串（""）。
如果值为null，则该字段将被忽略且不会写入。

void setTagsFromMap() async {
    final path = "storage/emulated/0/Music/test.mp3";
    final tags = <String, String>{
        "title": "Title of the song",
        "artist": "A fake artist",
        "album": "",    //This field will be reset
        "genre": null,  //This field will not be written
    };

    final result = await tagger.writeTagsFromMap(
        path: path,
        tags: tags
    );
}

该Map具有以下模式：Map of Tag模式。

从Tag对象写入标签

你可以从一个Tag对象写入ID3标签。
要重置一个字段，请传递一个空字符串（""）。
如果值为null，则该字段将被忽略且不会写入。

void setTags() async {
    final path = "storage/emulated/0/Music/test.mp3";
    final tag = Tag(
        title: "Title of the song",
        artist: "A fake artist",
        album: "",    //This field will be reset
        genre: null,  //This field will not be written
    );

    final result = await tagger.writeTags(
        path: path,
        tag: tag,
    );
}

Tag对象具有以下模式：Tag对象模式。

写入单个标签字段

你可以通过指定字段名写入单个标签字段。
要重置该字段，请传递一个空字符串（""）。
如果值为null，则该字段将被忽略且不会写入。

void setTags() async {
    final path = "storage/emulated/0/Music/test.mp3";

    final result = await tagger.writeTag(
        path: path,
        tagField: "title",
        value: "Title of the song"
    );
}

有关字段名称，请参阅Map of Tag模式。

模型

这些是Audiotagger请求和返回的Map和类的模式。

Tag类

String? title;
String? artist;
String? genre;
String? trackNumber;
String? trackTotal;
String? discNumber;
String? discTotal;
String? lyrics;
String? comment;
String? album;
String? albumArtist;
String? year;
String? artwork; // 表示歌曲封面的艺术路径。

Map of Tag

<String, String>{
    "title": value,
    "artist": value,
    "genre": value,
    "trackNumber": value,
    "trackTotal": value,
    "discNumber": value,
    "discTotal": value,
    "lyrics": value,
    "comment": value,
    "album": value,
    "albumArtist": value,
    "year": value,
    "artwork": value, // 如果是从readTags或readTagsAsMap获取，则为null；
};

AudioFile类

int? length;
int? bitRate;
String? channels;
String? encodingType;
String? format;
int? sampleRate;
bool? isVariableBitRate;

Map of AudioFile

<String, dynamic?>{
    "length": length,
    "bitRate": bitRate,
    "channels": channels,
    "encodingType": encodingType,
    "format": format,
    "sampleRate": sampleRate,
    "isVariableBitRate": isVariableBitRate,
};