aboutsummaryrefslogtreecommitdiffstats
path: root/libavformat/avformat.h
diff options
context:
space:
mode:
authorMichael Niedermayer <michael@niedermayer.cc>2016-01-23 00:35:46 +0100
committerMichael Niedermayer <michael@niedermayer.cc>2016-02-01 02:12:22 +0100
commit106e0fff2e885db845f8d47d53e2f5c1152c1dab (patch)
treec51c8b4533b92a9c2c6953ce5f96aa1d43b9d994 /libavformat/avformat.h
parent53f5efcae11764e1232e0bb91cf53129ad8da2d2 (diff)
downloadffmpeg-106e0fff2e885db845f8d47d53e2f5c1152c1dab.tar.gz
avformat: Document urls a bit
Spell-checked-by: Moritz Barsnick <barsnick@gmx.net> Signed-off-by: Michael Niedermayer <michael@niedermayer.cc> (cherry picked from commit 3130556c0eb09f3da3c9de6473a97937a4648d62) Signed-off-by: Michael Niedermayer <michael@niedermayer.cc>
Diffstat (limited to 'libavformat/avformat.h')
-rw-r--r--libavformat/avformat.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/libavformat/avformat.h b/libavformat/avformat.h
index 4362afda20..c6fd395724 100644
--- a/libavformat/avformat.h
+++ b/libavformat/avformat.h
@@ -78,6 +78,18 @@
* if its AVClass is non-NULL, and the protocols layer. See the discussion on
* nesting in @ref avoptions documentation to learn how to access those.
*
+ * @section urls
+ * URL strings in libavformat are made of a scheme/protocol, a ':', and a
+ * scheme specific string. URLs without a scheme and ':' used for local files
+ * are supported but deprecated. "file:" should be used for local files.
+ *
+ * It is important that the scheme string is not taken from untrusted
+ * sources without checks.
+ *
+ * Note that some schemes/protocols are quite powerful, allowing access to
+ * both local and remote files, parts of them, concatenations of them, local
+ * audio and video devices and so on.
+ *
* @defgroup lavf_decoding Demuxing
* @{
* Demuxers read a media file and split it into chunks of data (@em packets). A