React Native wrapper for Android's unstable MetadataRetriever API, which fallback to the old MediaMetadataRetriever API if no metadata was found (ie: ID3v1 tags aren't detected).
Unlike @missingcore/audio-metadata which this is a successor to, this uses Android's native metadata reader via AndroidX's MetadataRetriever API. With that in mind, we can support a wider range of formats which would have costed a lot of time and energy to develop with pure TypeScript.
View the full list of supported audio formats on Android's documentation on Supported media formats.
npm install @missingcore/react-native-metadata-retrieverimport {
MetadataPresets,
getArtwork,
getMetadata,
} from '@missingcore/react-native-metadata-retriever';
const uri = 'file:///storage/emulated/0/Music/Silence.mp3';
// Of course with `await`, use this inside an async function or use `Promise.then()`.
const metadata = await getMetadata(uri, MetadataPresets.standard);
const base64Artwork = await getArtwork(uri);const MediaMetadataPublicFields: string[];An array containing the keys of supported metadata fields.
const MetadataPresets: Record<string, MediaMetadataPublicField[]>;An object containing several metadata presets we can use to retrieve metadata.
function getArtwork(uri: string): Promise<string | null>;Returns the base64 image string for the media file of the provided uri.
Note: Has a
5MBreturn limit (so a3.75MBimage size limit as converting it to base64 increases its size by 33-37%).
function getMetadata<TOptions extends MediaMetadataPublicFields>(
uri: string,
options: TOptions
): Promise<MediaMetadataExcerpt<TOptions>>;Returns the specified metadata of the provided uri based on the options argument.
Note: The "complicated" typing is to make the resulting promise type-safe and be based off the provided
options.
type MediaMetadata = {
/* List of fields available on `Format`. */
bitrate: number | null;
channelCount: number | null;
codecs: string | null;
sampleMimeType: string | null;
sampleRate: number | null; // in `Hz`
/* List of fields available on `MediaMetadata`. */
albumArtist: string | null;
albumTitle: string | null;
artist: string | null;
artworkData: string | null;
artworkDataType: string | null;
artworkUri: string | null;
compilation: string | null;
composer: string | null;
conductor: string | null;
description: string | null;
discNumber: number | null;
displayTitle: string | null;
// extras: unknown
genre: string | null;
isBrowsable: boolean | null;
isPlayable: boolean | null;
mediaType: string | null;
overallRating: number | null;
recordingDay: number | null;
recordingMonth: number | null;
recordingYear: number | null;
releaseDay: number | null;
releaseMonth: number | null;
releaseYear: number | null;
station: string | null;
subtitle: string | null;
title: string | null;
totalDiscCount: number | null;
totalTrackCount: number | null;
trackNumber: number | null;
userRating: number | null;
writer: string | null;
/* List of custom fields derived from other fields. */
year: number | null;
};The types of all the possible metadata we can return.
type MediaMetadataExcerpt<TKeys extends MediaMetadataPublicFields> = Prettify<
Pick<MediaMetadata, TKeys[number]>
>;Narrow down the returned types in MediaMetadata based on the MediaMetadataPublicFields provided.
type MediaMetadataPublicField = (typeof MediaMetadataPublicFields)[number];All the constant strings in the MediaMetadataPublicFields array as a type.
type MediaMetadataPublicFields = ReadonlyArray<MediaMetadataPublicField>;MediaMetadataPublicFields array in the form of a type.