Skip to main content

Interface: CommonMetadata

Defined in: packages/player/src/common-metadata.ts:14

The tags a now-playing screen needs, normalised across tag formats.

Every field is optional, because every field genuinely is: a bare MP3 with no tags produces {}, and a live stream produces a station and a streamTitle and nothing else.

Properties​

album?​

readonly optional album?: string;

Defined in: packages/player/src/common-metadata.ts:20

Album / release name (album).

albumArtist?​

readonly optional albumArtist?: string;

Defined in: packages/player/src/common-metadata.ts:22

Album artist (album_artist, albumartist, ID3's TPE2).

artist?​

readonly optional artist?: string;

Defined in: packages/player/src/common-metadata.ts:18

Performing artist (artist, author, icy-name is not used here).

bitrateKbps?​

readonly optional bitrateKbps?: number;

Defined in: packages/player/src/common-metadata.ts:51

Advertised stream bitrate in kbit/s (icy-br).

comment?​

readonly optional comment?: string;

Defined in: packages/player/src/common-metadata.ts:38

Free-text comment (comment, description).

composer?​

readonly optional composer?: string;

Defined in: packages/player/src/common-metadata.ts:36

Composer (composer).

discCount?​

readonly optional discCount?: number;

Defined in: packages/player/src/common-metadata.ts:30

Total discs, when the tag carried the 1/2 form.

discNumber?​

readonly optional discNumber?: number;

Defined in: packages/player/src/common-metadata.ts:28

Disc number (disc, discnumber, ID3's TPOS).

genre?​

readonly optional genre?: string;

Defined in: packages/player/src/common-metadata.ts:34

Genre (genre, or a stream's icy-genre).

station?​

readonly optional station?: string;

Defined in: packages/player/src/common-metadata.ts:40

Station name of an Icecast/Shoutcast stream (icy-name).

streamTitle?​

readonly optional streamTitle?: string;

Defined in: packages/player/src/common-metadata.ts:49

The stream's current now-playing line (icy-title), verbatim.

Kept separate from title even though it also feeds it: stations conventionally send Artist - Title in one string, and an app that wants to split it needs the original rather than this library's guess. This library never splits it.

title?​

readonly optional title?: string;

Defined in: packages/player/src/common-metadata.ts:16

Track title (title, or a live stream's icy-title).

trackCount?​

readonly optional trackCount?: number;

Defined in: packages/player/src/common-metadata.ts:26

Total tracks, when the tag carried the 3/12 form.

trackNumber?​

readonly optional trackNumber?: number;

Defined in: packages/player/src/common-metadata.ts:24

Track number within the disc, as a number (track, tracknumber).

year?​

readonly optional year?: number;

Defined in: packages/player/src/common-metadata.ts:32

Release year, extracted from date / year / originaldate.