IceCast2 supports the following channel metadata fields:

Name

Description

URL

Genre

IceCast2 provides one field of text, called StreamTitle, which can be dynamically updated to reflect the content currently playing on the stream. By convention, this is usually formatted as 'Artist - Title' on streams containing musical content.

For example, to set the StreamTitle field to The Beatles - Hey Jude, the following JSON could be used:

{
	"Metadata": {
		"StreamTitle": "The Beatles - Hey Jude"
	}
}

In addition to the primary JSON interface, the StreamTitle can be set by sending an HTTP GET request to a running glasscoder(1) instance, using the TCP port specified in the --metadata-port=port option. The request must be in the following format:

http://hostname:tcp-port/admin/metadata?mount=mount-point&mode=updinfo&song=string

Where:

hostname - The hostname or IP address of the system running glasscoder(1)

tcp-port - The TCP port number specified in the --metadata-port option to glasscoder(1)

mount-point - The mountpoint of the stream

string - The string to set, encoded as specified in Section 2 of RFC3986

For example, to set a string of "The Beatles - Hey Jude" via a glasscoder(1) instance running at encoder.example.com with a --metadata-port value of 1234 for a mountpoint of MyStream, the URL would be:

http://encoder.example.com:1234/admin/metadata?mount=MyStream&mode=updinfo&song=The%20Beatles%20-%20Hey%20Jude

ShoutCast supports the following channel metadata fields:

Name

URL

Genre

ICQ ID

AOL Instant Messenger ID

IRC ID

ShoutCast provides two fields of text which can be dynamically updated to reflect the content currently playing on the stream, called StreamTitle and StreamUrl. By convention, the StreamTitle is usually formatted as 'Artist - Title' on streams containing musical content, while StreamUrl is used to provide a URL whence stream specific content --e.g. album cover art -- can be retrieved.

For example, to set the StreamTitle field to The Beatles - Hey Jude and the StreamUrl field to http://images.example.com/1234.png, the following JSON could be used:

{
	"Metadata": {
		"StreamTitle": "The Beatles - Hey Jude",
		"StreamUrl": "http://images.example.com/1234.png"
	}
}

In addition to the primary JSON interface, the StreamTitle and StreamUrl fields can be set by sending an HTTP GET request to a running glasscoder(1) instance, using the TCP port specified in the --metadata-port=port option. The request must be in the following format:

http://hostname:tcp-port/admin.cgi?pass=password&mode=updinfo&song=stream-title&url=stream-url

Where:

hostname - The hostname or IP address of the system running glasscoder(1)

tcp-port - The TCP port number specified in the --metadata-port option to glasscoder(1)

password - The ShoutCast password, encoded as specified in Section 2 of RFC3986

stream-title - The string to set for StreamTitle, encoded as specified in Section 2 of RFC3986

stream-url - The string to set for StreamUrl, encoded as specified in Section 2 of RFC3986

For example, to set a StreamTitle of "The Beatles - Hey Jude" and a StreamUrl of "http://image.example.com/1234.png" with a password of "MyPassword" via a glasscoder(1) instance running at encoder.example.com with a --metadata-port value of 1234, the URL would be:

http://encoder.example.com:1234/admin.cgi?pass=MyPassword&mode=updinfo&song=The%20Beatles%20-%20Hey%20Jude&url=http://image.example.com/1234.png

HLS supports timed metadata in the form of embedded ID3v2.4 tags. Available fields thus include the entire set of text tags defined in the ID3v2.4 frame specification (available at http://id3.org/id3v2.4.0-frames).

For example, a typical metadata update could use the following JSON:

{
	"Metadata": {
		"TIT2": "Hey Jude",
		"TPE1": "The Beatles",
		"TALB": "The White Album",
		"TRSO": "WXYZ Radio"
	}
}

A user defined text information frame (TXXX) can be sent by using the following special notation for the field identifier:

TXXXdesc

Where:

desc - The TXXX Description string (see Section 4.2.6 of the ID3v2.4 Frame Specification)

For example:

{
	"Metadata": {
		"TIT2": "Hey Jude",
		"TPE1": "The Beatles",
		"TALB": "The White Album",
		"TRSO": "WXYZ Radio",
		"TXXXxyz": "TXXX frame with a description string of \"xyz\""
	}
}