Jumpvalley.Music.SongInfoFile Class Reference

Reads the associated "info.txt" file for a song.
The contents of such types of files should be formatted like this:
property name: property value
where each property is specified on its own line.
Currently, the properties read for an song's info.txt file are:

• name: The name of the song
• artists: The artists that made the song
• album: The album the song belongs to
• audio_path: The file path to the audio file, including its file name and extension

This text formatting is inspired by the way that the content of .osu files are formatted in Osu (the rhythm game). More...

Inheritance diagram for Jumpvalley.Music.SongInfoFile:

Public Member Functions
	SongInfoFile (string text)
	Creates an instance of SongInfoFile from raw formatted text.
Public Member Functions inherited from Jumpvalley.IO.InfoFile
	InfoFile (string text)
	Reads an info file from its raw text and stores such data in the Data field.

Public Attributes
string	Name = null
	The name of the song.
string	Artists = null
	The artists that made the song.
string	Album = null
	The album the song belongs to.
string	AudioPath = null
	The file path to the audio file, including its file name and extension.
Public Attributes inherited from Jumpvalley.IO.InfoFile
Dictionary< string, string >	Data = new Dictionary<string, string>()
	The content of the info file. The keys of this dictionary are property names, and each key's value is the corresponding property value.

Additional Inherited Members
Static Public Attributes inherited from Jumpvalley.IO.InfoFile
static readonly string	FILE_NAME = "info.txt"
	The full file name of an info file stored somewhere on a filesystem, including the file extension.
static readonly string	PROPERTY_SEPARATOR = "\n"
	The string that separates two properties with the info file's text.
static readonly string	NAME_VALUE_SEPARATOR = ": "
	The string that separates a property's name from its value.

Detailed Description

Reads the associated "info.txt" file for a song.
The contents of such types of files should be formatted like this:
property name: property value
where each property is specified on its own line.
Currently, the properties read for an song's info.txt file are:

• name: The name of the song
• artists: The artists that made the song
• album: The album the song belongs to
• audio_path: The file path to the audio file, including its file name and extension

This text formatting is inspired by the way that the content of .osu files are formatted in Osu (the rhythm game).

Constructor & Destructor Documentation

SongInfoFile()

Jumpvalley.Music.SongInfoFile.SongInfoFile ( string text )

inline

Creates an instance of SongInfoFile from raw formatted text.

Parameters

text	The raw formatted text

---

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

• SongInfoFile.cs