summaryrefslogtreecommitdiff
path: root/doc/protocols.texi
diff options
context:
space:
mode:
authorLuca Barbato <lu_zero@gentoo.org>2014-03-10 21:11:35 +0100
committerLuca Barbato <lu_zero@gentoo.org>2014-03-11 22:08:57 +0100
commit8075c3d8bb1f6aade0cc7c5c40db9bc1bcd84cab (patch)
treeb092db08059ea0abb00e6fabfdc1ccba30e3e927 /doc/protocols.texi
parent4ff99ab3d7d5576e99e6b8a411b4a44500ed88fa (diff)
http: Add support reading ICY metadata
Export the metadata as a icy_metadata_packet avoption. Based on the work of wm4 and Alessandro Ghedini. Bug-Id: https://bugs.debian.org/739936 Signed-off-by: Luca Barbato <lu_zero@gentoo.org>
Diffstat (limited to 'doc/protocols.texi')
-rw-r--r--doc/protocols.texi20
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/protocols.texi b/doc/protocols.texi
index 1a9f5755a0..5d7a1a6d3e 100644
--- a/doc/protocols.texi
+++ b/doc/protocols.texi
@@ -89,6 +89,26 @@ m3u8 files.
HTTP (Hyper Text Transfer Protocol).
+This protocol accepts the following options:
+
+@table @option
+@item icy
+If set to 1 request ICY (SHOUTcast) metadata from the server. If the server
+supports this, the metadata has to be retrieved by the application by reading
+the @option{icy_metadata_headers} and @option{icy_metadata_packet} options.
+The default is 0.
+
+@item icy_metadata_headers
+If the server supports ICY metadata, this contains the ICY-specific HTTP reply
+headers, separated by newline characters.
+
+@item icy_metadata_packet
+If the server supports ICY metadata, and @option{icy} was set to 1, this
+contains the last non-empty metadata packet sent by the server. It should be
+polled in regular intervals by applications interested in mid-stream metadata
+updates.
+@end table
+
@section mmst
MMS (Microsoft Media Server) protocol over TCP.