Metadata Scripts - Revision history

Camille: /* iconv */

2024-11-15T13:41:58Z

iconv

Camille: Added MPEG-TS ID3 specifics

2024-02-28T17:05:13Z

Added MPEG-TS ID3 specifics

Camille at 11:01, 14 February 2024

2024-02-14T11:01:27Z

Camille at 11:01, 14 February 2024

2024-02-14T11:01:06Z

Camille at 10:55, 14 February 2024

2024-02-14T10:55:46Z

Camille: Added JSON parsing

2024-01-10T15:21:29Z

Added JSON parsing

Camille: /* LogInfo */

2021-05-27T08:51:21Z

LogInfo

Camille: Added DoNotSendMeta

2021-03-05T17:12:55Z

Added DoNotSendMeta

Camille: /* Metadata */

2021-01-27T13:25:30Z

Metadata

Camille: Corrections about Stream metadata

2021-01-27T11:20:10Z

Corrections about Stream metadata

@@ Line 54: / Line 54: @@
 ====iconv====
-NOTE: Since Server 4.1.75/Stream 2.4.12, the software will try guess the encoding before applying the script. It will always work for UTF8/16/32 encoding, so those are the recommended encodings. In those cases, iconv is useless.
+NOTE: Since Server 4.1.75/Stream 2.4.12, the software will try guess the encoding before applying the script. It will always work for UTF8/16/32 encoding, so those are the recommended encodings. In those cases, iconv is useless, unless to convert to ASCII for RDS.
 module has been added in Stream 2.4.4 for Linux (and boxes 1.56) and for windows version 2.4.7. You can use it like this:<syntaxhighlight lang="lua">

@@ Line 203: / Line 203: @@
 </syntaxhighlight>will add: <TCON v1="24">Subgenre</TCON>
 ===RTMP: _rtmp===
 For the '_rtmp' node, all primary level nodes will be added to the <code>onMetadata</code>, using the node name as key, and the node content as value.

← Older revision		Revision as of 11:01, 14 February 2024
Line 234:		Line 234:
	[[Category:Metadata]]		[[Category:Metadata]]
	[[Category:Streaming]]		[[Category:Streaming]]
		+	[[Category:RDS]]

← Older revision		Revision as of 11:01, 14 February 2024
Line 233:		Line 233:
	When using sharing to put a source file in Public, it can be accessed locally in <code>/public/</code>.		When using sharing to put a source file in Public, it can be accessed locally in <code>/public/</code>.
	[[Category:Metadata]]		[[Category:Metadata]]
		+	[[Category:Streaming]]

← Older revision		Revision as of 10:55, 14 February 2024
Line 232:		Line 232:
	=Standalone processors=		=Standalone processors=
	When using sharing to put a source file in Public, it can be accessed locally in <code>/public/</code>.		When using sharing to put a source file in Public, it can be accessed locally in <code>/public/</code>.
		+	[[Category:Metadata]]

@@ Line 4: / Line 4: @@
 The source data has to be coded in '''UTF-8'''. (Since Server 4.1.75/Stream 2.4.12, UTF16 and UTF32 are also accepted).
-===There are 3 modes:===
+===There are 4 modes:===
 *Char parsing: a callback is called for each char received
 *Line parsing: a callback is called for each line received
 *XML parsing: different callbacks might be called, see below.
-The script MUST call one of this function depending of the parsing method choose (outside of any function).
+The script MUST call one of this function depending on the parsing method choose (outside any function).
 *<code>UseCharParser()</code>
 *<code>UseLineParser()</code>
 *<code>UseXmlParser()</code>
 ===Tool functions===
@@ Line 101: / Line 103: @@
 UseXmlParser()
 function OnXMLParsed()
-     descr=XPath('/MyRootNode/MyList/MyElement[1]/@Description')
+     local descr=XPath('/MyRootNode/MyList/MyElement[1]/@Description')
      meta:Add("title", descr);
 end
@@ Line 111: / Line 113: @@
 So, it is possible to parse encapsulated XML.
 ===Metadata===
 Metadata is internally stored as XML.
@@ Line 118: / Line 138: @@
 The main metadata node is called 'meta'.
-The metadata is send when the source disconnects or when  <code>SendMetaNow()</code> is called.
+The metadata is sent when the source disconnects or when  <code>SendMetaNow()</code> is called.
 Functions on nodes are:
-*node:Add("name", "content") : add a node, with the specified optional content. returns the new node
+*node:Add("name", "content") : add a node, with the specified optional content. Returns the new node
-*node:AddAttribute("name", "value") : add an attribute to the node. returns the node.
+*node:AddAttribute("name", "value") : add an attribute to the node. Returns the node.
-*node:Set("name", "content") : add or replace a node, with the specified optional content. returns the new node ''(Since Stream 2.4.17/Server 4.1.82)''
+*node:Set("name", "content") : add or replace a node, with the specified optional content. Returns the new node ''(Since Stream 2.4.17/Server 4.1.82)''
 Ex: <code>meta:add("title", mytitle)</code>
@@ Line 132: / Line 152: @@
 *<code>title</code> : the title of the song
 *<code>artist</code> : the artist of the song
-*<code>compact_song</code> : a combinaison of artist and title, generated automatically if missing as <code>artist - title</code>
+*<code>compact_song</code> : a combination of artist and title, generated automatically if missing as <code>artist - title</code>
 *<code>url</code> : the album art cover

@@ Line 19: / Line 19: @@
 ====LogInfo====
-Output to the sound4stream log.
+Output to the sound4stream log for Stream metadata, or the sound4server log for RDS metadata.
        Ex: <code>LogInfo("The value is ", value,"... Continuing.")</code>
@@ Line 67: / Line 67: @@
 In Stream, before 2.4.17 it does not compute compact_song automatically.
-==== DoNotSendMeta ====
+====DoNotSendMeta====
 Since server 4.1.83 and Stream 2.4.18, you can call <code>DoNotSendMeta()</code> to cancel metadata update without error.

← Older revision		Revision as of 17:12, 5 March 2021
Line 66:		Line 66:

	In Stream, before 2.4.17 it does not compute compact_song automatically.		In Stream, before 2.4.17 it does not compute compact_song automatically.
		+
		+	==== DoNotSendMeta ====
		+	Since server 4.1.83 and Stream 2.4.18, you can call <code>DoNotSendMeta()</code> to cancel metadata update without error.
		+
		+	Before, not setting the metadata was not sending it, but reported an error.

	===Callbacks===		===Callbacks===

@@ Line 64: / Line 64: @@
 ====SendMetaNow====
 Since server 4.1.77 and Stream 2.4.14, you can call <code>SendMetaNow()</code> at any time to send the current metadata.
 ===Callbacks===
@@ Line 122: / Line 124: @@
 The usual metadata keys (handled automatically when the protocol allows it) are:
-* <code>title</code> : the title of the song
+*<code>title</code> : the title of the song
-* <code>artist</code> : the artist of the song
+*<code>artist</code> : the artist of the song
-* <code>compact_song</code> : a combinaison of artist and title, generated automatically if missing as <code>artist - title</code>
+*<code>compact_song</code> : a combinaison of artist and title, generated automatically if missing as <code>artist - title</code>
-* <code>url</code> : the album art cover
+*<code>url</code> : the album art cover
 =Streaming=
@@ Line 142: / Line 144: @@
 *"title"
 *"album"
-*<nowiki>"compact_song"    : automatically set to "[artist] - [title]" if is not specified. Used by protocols that do not allow separate title/artist</nowiki>
+*<nowiki>"compact_song"    : automatically set to "[artist] - [title]" if is not specified. Used by protocols that do not allow separate title/artist and for display in software.</nowiki>
 *"next_song" : sub-node for metadata of next playing song.
 **"artist"
 **"title"
 Example:<syntaxhighlight lang="lua">
@@ Line 163: / Line 167: @@
 </syntaxhighlight>
-===Shoutcast: _shout===
+===Shoutcast V2: _shout===
 For the '_shout' node, you can add directly tags.
@@ Line 175: / Line 179: @@
 ===RTMP: _rtmp===
 For the '_rtmp' node, all primary level nodes will be added to the <code>onMetadata</code>, using the node name as key, and the node content as value.
 Example:<syntaxhighlight lang="lua">