OpenTTD Source 20241224-master-gf74b0cf984
MusicSongInfo Struct Reference

Metadata about a music track. More...

#include <base_media_base.h>

Inheritance diagram for MusicSongInfo:
MusicSystem::PlaylistEntry

Data Fields

std::string songname
 name of song displayed in UI
 
uint8_t tracknr
 track number of song displayed in UI
 
std::string filename
 file on disk containing song (when used in MusicSet class)
 
MusicTrackType filetype
 decoder required for song file
 
int cat_index
 entry index in CAT file, for filetype==MTT_MPSMIDI
 
bool loop
 song should play in a tight loop if possible, never ending
 
int override_start
 MIDI ticks to skip over in beginning.
 
int override_end
 MIDI tick to end the song at (0 if no override)
 

Detailed Description

Metadata about a music track.

Definition at line 325 of file base_media_base.h.

Field Documentation

◆ cat_index

int MusicSongInfo::cat_index

entry index in CAT file, for filetype==MTT_MPSMIDI

Definition at line 330 of file base_media_base.h.

Referenced by MidiFile::GetSMFFile(), and MusicSystem::PlaylistRemove().

◆ filename

std::string MusicSongInfo::filename

file on disk containing song (when used in MusicSet class)

Definition at line 328 of file base_media_base.h.

Referenced by MidiFile::GetSMFFile(), and MusicSystem::PlaylistRemove().

◆ filetype

MusicTrackType MusicSongInfo::filetype

decoder required for song file

Definition at line 329 of file base_media_base.h.

Referenced by MidiFile::GetSMFFile().

◆ loop

bool MusicSongInfo::loop

song should play in a tight loop if possible, never ending

Definition at line 331 of file base_media_base.h.

Referenced by MusicSystem::Play(), MusicDriver_DMusic::PlaySong(), and MusicDriver_Win32::PlaySong().

◆ override_end

int MusicSongInfo::override_end

MIDI tick to end the song at (0 if no override)

Definition at line 333 of file base_media_base.h.

Referenced by MusicDriver_DMusic::PlaySong(), and MusicDriver_Win32::PlaySong().

◆ override_start

int MusicSongInfo::override_start

MIDI ticks to skip over in beginning.

Definition at line 332 of file base_media_base.h.

Referenced by MusicDriver_DMusic::PlaySong(), and MusicDriver_Win32::PlaySong().

◆ songname

std::string MusicSongInfo::songname

name of song displayed in UI

Definition at line 326 of file base_media_base.h.

◆ tracknr

uint8_t MusicSongInfo::tracknr

track number of song displayed in UI

Definition at line 327 of file base_media_base.h.

Referenced by MusicWindow::DrawWidget().


The documentation for this struct was generated from the following file: