summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorwm4 <nfxjfg@googlemail.com>2013-06-26 00:53:26 +0200
committerStefano Sabatini <stefasab@gmail.com>2013-07-02 02:00:56 +0200
commita92fbe16f2dc118c0d3adc222484268831388648 (patch)
tree92c2b4034d7b1a0e28bdcdaa43a372e741cde7ef /doc
parentbf87908cd8da31e8f8fe75c06577170928ea70a8 (diff)
lavf/http: add support for reading streamcast metadata
Allow applications to request reading streamcast metadata. This uses AVOptions as API, and requires the application to explicitly request and read metadata. Metadata can be updated mid-stream; if an application is interested in that, it has to poll for the data by reading the "icy_metadata_packet" option in regular intervals. There doesn't seem to be a nice way to transfer the metadata in a nicer way. Converting the metadata to ID3v2 tags might be a nice idea, but the libavformat mp3 demuxer doesn't seem to read these tags mid-stream, and even then we couldn't guarantee that tags are not inserted in the middle of mp3 packet data. This commit provides the minimum to enable applications to retrieve this information at all. Signed-off-by: Stefano Sabatini <stefasab@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/protocols.texi14
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/protocols.texi b/doc/protocols.texi
index 97ff62d9e1..e8427aa277 100644
--- a/doc/protocols.texi
+++ b/doc/protocols.texi
@@ -228,6 +228,20 @@ not specified.
@item mime_type
Set MIME type.
+@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 with 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.
+
@item cookies
Set the cookies to be sent in future requests. The format of each cookie is the
same as the value of a Set-Cookie HTTP response field. Multiple cookies can be