← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/oss4/oneiric-proposed

« back to all changes in this revision

Viewing changes to misc/man9ossddk/ossddk_adev_set_rates.9ossddk

  • Committer: Bazaar Package Importer
  • Author(s): Stefano Rivera
  • Date: 2011-06-16 20:37:48 UTC
  • mfrom: (5.1.3 sid)
  • Revision ID: james.westby@ubuntu.com-20110616203748-jbrxik6ql33z54co
Tags: 4.2-build2004-1ubuntu1
https://launchpad.net/bugs/746048
https://launchpad.net/bugs/770972
* Merge from Debian unstable.
  - Supports our current kernel (LP: #746048)
  Remaining changes:
  - debian/oss4-dkms.dkms.in: s/source/build/ in Kernel headers paths.
* ld-as-needed.patch: Re-order CC arguments to enable building with ld
  --as-needed (LP: #770972)

Show diffs side-by-side

added added

removed removed

Lines of Context:
misc/man9ossddk/ossddk_adev_set_rates.9ossddk
 
1
'\" te
 
2
.\"  Copyright (c) 2005, 4Front Technologies 2005\&.
 
3
.TH ossddk_adev_set_rates 9ossddk "12 Sep 2005" "SunOS 5.10" "OSS DDK Services"
 
4
.SH "NAME"
 
5
ossddk_adev_set_rates \- Set the supported sampling rates
 
6
.PP
 
7
.SH "SYNOPSIS"
 
8
.nf
 
9
#include <sys/soundcard.h>
 
10
.LP
 
11
#include <sys/ossddk/ossddk.h>
 
12
.fi
 
13
.LP
 
14
\fBvoid\fR ossddk_adev_set_rates(\fBint \fIdev\fP, \fBint \fImin_rate\fP, \fBint \fImax_rate\fP, \fBint \fInrates\fP, \fBint \fIrates[20]\fP);
 
15
.PP
 
16
.SH "INTERFACE LEVEL"
 
17
.PP
 
18
Open Sound System specific (OSS 4.0 DDK)\&.
 
19
.PP
 
20
.SH "ARGUMENTS"
 
21
.PP
 
22
.sp
 
23
.ne 2
 
24
.mk
 
25
\fB\fIdev\fR
 
26
.in +16n
 
27
.rt
 
28
OSS audio device number.
 
29
.in -16n
 
30
.sp
 
31
.ne 2
 
32
.mk
 
33
\fB\fImin_rate\fR
 
34
.in +16n
 
35
.rt
 
36
The minimum sampling rate supported by the device.
 
37
.in -16n
 
38
.sp
 
39
.ne 2
 
40
.mk
 
41
\fB\fImax_rate\fR
 
42
.in +16n
 
43
.rt
 
44
The maximum sampling rate supported by the device.
 
45
.in -16n
 
46
.sp
 
47
.ne 2
 
48
.mk
 
49
\fB\fInrates\fR
 
50
.in +16n
 
51
.rt
 
52
Number of discrete rates (0 to 20).
 
53
.in -16n
 
54
.sp
 
55
.ne 2
 
56
.mk
 
57
\fB\fIrates[20]\fR
 
58
.in +16n
 
59
.rt
 
60
Pointer to an array containing up to 20 sampling rates (in ascending order).
 
61
.in -16n
 
62
.PP
 
63
.SH "DESCRIPTION"
 
64
.PP
 
65
This function sets meta information that applications may obtain using the
 
66
\fISNDCTL_AUDIOINFO(2oss)\fR ioctl call. There are three ways how this function can be
 
67
called. In both cases the min_rate and max_rate parameters must be set properly.
 
68
.PP
 
69
1) If the device supports any rates between the minimum and maximum the nrates parameter
 
70
must be set to 0. The rates parameter can be null.
 
71
.LP
 
72
2) If the device supports just few rates (up to 20) you should pass the number of 
 
73
supported rates in \fInrates\fR and pointer to an array (of int) in the \fIrates\fR
 
74
parameter. Rates stoored in the array must be in increasing order.
 
75
.LP
 
76
3) If there are more than 20 possible rates you should set nrates=0 and rates=NULL.
 
77
.PP
 
78
The driver can change the supported rate information whenever necessary. For example if
 
79
a change in device's operating mode changes the supported rates too.
 
80
.PP
 
81
.SH "SEE ALSO"
 
82
.PP
 
83
\fISNDCTL_AUDIOINFO(2oss)\fR
 
84
.LP
 
85
\fIWriting Sound Device Drivers with OSS DDK\fR
 
86
.LP
 
87
\fIOpen Sound System Programmer's Guide\fR