summaryrefslogtreecommitdiffstats
path: root/lib/libsndio/sio_open.3
diff options
context:
space:
mode:
authorratchov <ratchov@openbsd.org>2019-01-18 08:43:49 +0000
committerratchov <ratchov@openbsd.org>2019-01-18 08:43:49 +0000
commitdbc87f2bffe227bf3f9aa7ee7e807c954f1f1319 (patch)
treea17069b16a4ade14365cf536173ce0294ad1926d /lib/libsndio/sio_open.3
parentchase sounlock() api change, make bfd(4) build again (diff)
downloadwireguard-openbsd-dbc87f2bffe227bf3f9aa7ee7e807c954f1f1319.tar.xz
wireguard-openbsd-dbc87f2bffe227bf3f9aa7ee7e807c954f1f1319.zip
Sayt that using capabilities to negociate audio parameters (ie using
sio_getcap() function) is not recomended. From Paul Swanson <psw at protonmail.com>, ok jmc
Diffstat (limited to 'lib/libsndio/sio_open.3')
-rw-r--r--lib/libsndio/sio_open.314
1 files changed, 12 insertions, 2 deletions
diff --git a/lib/libsndio/sio_open.3 b/lib/libsndio/sio_open.3
index fc5b68edba0..e52d18e55d8 100644
--- a/lib/libsndio/sio_open.3
+++ b/lib/libsndio/sio_open.3
@@ -1,4 +1,4 @@
-.\" $OpenBSD: sio_open.3,v 1.47 2018/07/28 09:11:55 ratchov Exp $
+.\" $OpenBSD: sio_open.3,v 1.48 2019/01/18 08:43:49 ratchov Exp $
.\"
.\" Copyright (c) 2007 Alexandre Ratchov <alex@caoua.org>
.\"
@@ -14,7 +14,7 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
-.Dd $Mdocdate: July 28 2018 $
+.Dd $Mdocdate: January 18 2019 $
.Dt SIO_OPEN 3
.Os
.Sh NAME
@@ -284,6 +284,11 @@ Applications that need to have a set of working
parameter combinations in advance can use the
.Fn sio_getcap
function.
+However, for most new applications it's generally
+not recommended to use
+.Fn sio_getcap .
+Instead, follow the recommendations for negotiating
+device parameters (see above).
.Pp
The
.Vt sio_cap
@@ -367,6 +372,11 @@ structure, then the second element of the
array of the
.Vt sio_cap
structure is valid for this configuration.
+As such, when reading the array elements in the
+.Vt sio_cap
+structure, the corresponding
+.Vt sio_conf
+bitmasks should always be used.
.El
.Ss Starting and stopping the device
The