File: ao_device.html

package info (click to toggle)
libao 0.8.6-4
  • links: PTS
  • area: main
  • in suites: etch, etch-m68k
  • size: 2,144 kB
  • ctags: 468
  • sloc: sh: 8,423; ansic: 3,148; makefile: 295
file content (88 lines) | stat: -rw-r--r-- 2,545 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
<html>

<head>
<title>libao - datatype - ao_device</title>
<link rel=stylesheet href="style.css" type="text/css">
</head>

<body bgcolor=white text=black link="#5555ff" alink="#5555ff" vlink="#5555ff">
<table border=0 width=100%>
<tr>
<td><p class=tiny>libao documentation</p></td>
<td align=right><p class=tiny>libao version 0.8.5 - 20040312</p></td>
</tr>
</table>

<h1>ao_device</h1>

<p><i>declared in "ao/ao.h";</i></p>

<p>This structure holds all of the data for an open device.

<br><br>
<table border=0 width=100% color=black cellspacing=0 cellpadding=7>
<tr bgcolor=#cccccc>
        <td>
<pre><b>typedef struct {
  int  type; /* live output or file output? */
  int  driver_id;
  ao_functions *funcs;
  FILE *file; /* File for output if this is a file driver */
  int  client_byte_format;
  int  machine_byte_format;
  int  driver_byte_format;
  char *swap_buffer;
  int  swap_buffer_size; /* Bytes allocated to swap_buffer */
  void *internal; /* Pointer to driver-specific data */
} ao_device;</b></pre>
        </td>
</tr>
</table>

<h3>Relevant Struct Members</h3>
<dl>
<dt><i>type</i></dt>
<dd>The output type of the driver:
<ul>
<li>AO_TYPE_LIVE - Live output.</li>
<li>AO_TYPE_FILE - File output.</li>
</ul>
</dd>
<dt><i>driver_id</i></dt>
<dd>The ID number for the driver used with this device.</dd>
<dt><i>funcs</i></dt>
<dd>Function table for the driver associated with this device.</dd>
<dt><i>client_byte_format</i></dt>
<dd>The byte format (use constants from 
<a href="ao_sample_format.html">ao_sample_format</a>) of samples provided by
the client to <a href="ao_sample_format.html">ao_play()</a>.
</dd>
<dt><i>machine_byte_format</i></dt>
<dd>The native byte format of the computer.  Will be either
<tt>AO_FMT_BIG</tt> or <tt>AO_FMT_LITTLE</tt>.
</dd>
<dt><i>driver_byte_format</i></dt>
<dd>The byte format of samples requested by
the driver.
</dd>
<dt><i>swap_buffer</i></dt>
<dd>Scratch buffer used to swap the byte order of samples.  Only allocated
if <tt>client_byte_format</tt> and <tt>driver_byte_format</tt> correspond to
different byte orders, otherwise set to NULL</dd>
</dl>

<br><br>
<hr noshade>
<table border=0 width=100%>
<tr valign=top>
<td><p class=tiny>copyright &copy; 2001-2003 Stan Seibert</p></td>
<td align=right><p class=tiny><a href="http://www.xiph.org/">xiph.org</a><br><a href="mailto:volsung@xiph.org">volsung@xiph.org</a></p></td>
</tr><tr>
<td><p class=tiny>libao documentation</p></td>
<td align=right><p class=tiny>libao version 0.8.5 - 20040312</p></td>
</tr>
</table>

</body>

</html>