Interface Song

Represents a song entity in the system

interface Song {
    _id: string;
    album?: Album;
    artists?: Artist[];
    bitrate?: number;
    codec?: string;
    container?: string;
    date?: string;
    date_added?: number;
    deviceno?: string;
    duration: number;
    genre?: string[];
    hash?: string;
    icon?: string;
    inode?: string;
    lyrics?: string;
    path?: string;
    playbackUrl?: string;
    playCount?: number;
    providerExtension?: string;
    releaseType?: string[];
    sampleRate?: number;
    showInLibrary?: boolean;
    size?: number;
    song_coverPath_high?: string;
    song_coverPath_low?: string;
    title: string;
    track_no?: number;
    type: PlayerTypes;
    url?: string;
    year?: string | number;
}

Properties

_id album? artists? bitrate? codec? container? date? date_added? deviceno? duration genre? hash? icon? inode? lyrics? path? playbackUrl? playCount? providerExtension? releaseType? sampleRate? showInLibrary? size? song_coverPath_high? song_coverPath_low? title track_no? type url? year?

Properties

_id

_id: string

Unique identifier for the song

Optionalalbum

album?: Album

Album information

Optionalartists

artists?: Artist[]

Artists associated with the song

Optionalbitrate

bitrate?: number

Bitrate of the song in kbps

Optionalcodec

codec?: string

Audio codec used

Optionalcontainer

container?: string

Container format

Optionaldate

date?: string

Release date of the song

Optionaldate_added

date_added?: number

Date when the song was added to the library

Optionaldeviceno

deviceno?: string

Device number (for local files)

duration

duration: number

Duration of the song in seconds

Optionalgenre

genre?: string[]

Genres associated with the song

Optionalhash

hash?: string

MD5 hash of the file

Optionalicon

icon?: string

Icon representing the song or its source

Optionalinode

inode?: string

Inode number (for local files)

Optionallyrics

lyrics?: string

Lyrics of the song

Optionalpath

path?: string

File path of the song

OptionalplaybackUrl

playbackUrl?: string

URL specifically for playback

OptionalplayCount

playCount?: number

Number of times the song has been played

OptionalproviderExtension

providerExtension?: string

Extension providing this song

OptionalreleaseType

releaseType?: string[]

Type of release (e.g., single, album)

OptionalsampleRate

sampleRate?: number

Sample rate in Hz

OptionalshowInLibrary

showInLibrary?: boolean

Whether the song should be shown in the library

Optionalsize

size?: number

File size in bytes

Optionalsong_coverPath_high

song_coverPath_high?: string

High resolution cover art path

Optionalsong_coverPath_low

song_coverPath_low?: string

Low resolution cover art path

title

title: string

Title of the song

Optionaltrack_no

track_no?: number

Track number in its album

type

type: PlayerTypes

Type of player required for this song

Optionalurl

url?: string

URL for streaming the song

Optionalyear

year?: string | number

Release year of the song

Settings

Member Visibility

On This Page

Properties