ref: 07a813ed87eda4d20745f4960d71c6a7805d982d
parent: e96c5aa859f8ec04283a113d6b232fbd1ae0548f
author: Timothy B. Terriberry <tterribe@xiph.org>
date: Mon Aug 26 07:37:01 EDT 2013
Document that we don't support IRIs.
--- a/include/opusfile.h
+++ b/include/opusfile.h
@@ -957,6 +957,10 @@
schemes are supported.
Both <http:> and <https:> may be disabled at compile
time, in which case opening such URLs will always fail.
+ Currently this only supports URIs.
+ IRIs should be converted to UTF-8 and URL-escaped, with
+ internationalized domain names encoded in punycode,
+ before passing them to this function.
\param[in,out] _ap A list of the \ref url_options "optional flags" to use.
This is a variable-length list of options terminated
with <code>NULL</code>.
@@ -975,6 +979,10 @@
are supported.
Both <http:> and <https:> may be disabled at compile time,
in which case opening such URLs will always fail.
+ Currently this only supports URIs.
+ IRIs should be converted to UTF-8 and URL-escaped, with
+ internationalized domain names encoded in punycode, before
+ passing them to this function.
\param ... The \ref url_options "optional flags" to use.
This is a variable-length list of options terminated with
<code>NULL</code>.
@@ -1064,6 +1072,10 @@
Both <http:> and <https:> may be disabled at compile
time, in which case opening such URLs will always
fail.
+ Currently this only supports URIs.
+ IRIs should be converted to UTF-8 and URL-escaped,
+ with internationalized domain names encoded in
+ punycode, before passing them to this function.
\param[out] _error Returns 0 on success, or a failure code on error.
You may pass in <code>NULL</code> if you don't want
the failure code.
@@ -1084,6 +1096,10 @@
are supported.
Both <http:> and <https:> may be disabled at compile
time, in which case opening such URLs will always fail.
+ Currently this only supports URIs.
+ IRIs should be converted to UTF-8 and URL-escaped, with
+ internationalized domain names encoded in punycode,
+ before passing them to this function.
\param[out] _error Returns 0 on success, or a failure code on error.
You may pass in <code>NULL</code> if you don't want the
failure code.
@@ -1215,6 +1231,10 @@
Both <http:> and <https:> may be disabled at compile
time, in which case opening such URLs will always
fail.
+ Currently this only supports URIs.
+ IRIs should be converted to UTF-8 and URL-escaped,
+ with internationalized domain names encoded in
+ punycode, before passing them to this function.
\param[out] _error Returns 0 on success, or a failure code on error.
You may pass in <code>NULL</code> if you don't want
the failure code.
@@ -1236,6 +1256,10 @@
schemes are supported.
Both <http:> and <https:> may be disabled at compile
time, in which case opening such URLs will always fail.
+ Currently this only supports URIs.
+ IRIs should be converted to UTF-8 and URL-escaped, with
+ internationalized domain names encoded in punycode,
+ before passing them to this function.
\param[out] _error Returns 0 on success, or a failure code on error.
You may pass in <code>NULL</code> if you don't want the
failure code.