← Back to branch summary

~n3npq/lsb/t2c-alsa-tests

« back to all changes in this revision

Viewing changes to spec/pcm__shm_8c.html

  • Committer: Jeff Licquia
  • Date: 2009-12-01 02:17:33 UTC
  • Revision ID: jeff@licquia.org-20091201021733-3wwc7cdytdzz7hwo
Initial version.

This contains the spec, as mirrored from the ALSA site, and as run
through KompoZer (so its gratuitous format changes are already there).

Show diffs side-by-side

added added

removed removed

Lines of Context:
spec/pcm__shm_8c.html
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html><head>
 
3
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"><title>ALSA project - the C library reference: /home/alsa/tmp/cvs/alsa-lib/src/pcm/pcm_shm.c File Reference</title>
 
4
 
 
5
<link href="doxygen.css" rel="stylesheet" type="text/css">
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"></head><body>
 
7
<!-- Generated by Doxygen 1.5.0 -->
 
8
<div class="tabs">
 
9
  <ul>
 
10
    <li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
 
11
    <li><a href="modules.html"><span>Modules</span></a></li>
 
12
    <li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
 
13
    <li id="current"><a href="files.html"><span>Files</span></a></li>
 
14
    <li><a href="pages.html"><span>Related&nbsp;Pages</span></a></li>
 
15
    <li><a href="examples.html"><span>Examples</span></a></li>
 
16
  </ul></div>
 
17
<div class="tabs">
 
18
  <ul>
 
19
    <li><a href="files.html"><span>File&nbsp;List</span></a></li>
 
20
    <li><a href="globals.html"><span>Globals</span></a></li>
 
21
  </ul></div>
 
22
<h1>/home/alsa/tmp/cvs/alsa-lib/src/pcm/pcm_shm.c File Reference</h1>PCM Shared Memory Plugin Interface. <a href="#_details">More...</a>
 
23
<p>
 
24
<table border="0" cellpadding="0" cellspacing="0">
 
25
<tbody><tr><td><br>
 
26
</td></tr>
 
27
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
 
28
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pcm__shm_8c.html#fb300179c53db52f3ec4036589afabc0">snd_pcm_shm_open</a> (<a class="el" href="group___p_c_m.html#gb5676348e7618b444e28907607660cef">snd_pcm_t</a> **pcmp, const char *name, const char *sockname, const char *sname, <a class="el" href="group___p_c_m.html#g854f0966bd0d7248ed3d9e5c293136ed">snd_pcm_stream_t</a> stream, int mode)</td></tr>
 
29
 
 
30
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new shared memory PCM.  <a href="#fb300179c53db52f3ec4036589afabc0"></a><br></td></tr>
 
31
<tr><td class="memItemLeft" align="right" nowrap="nowrap" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="pcm__shm_8c.html#bc25b8b667178ab0528a39b12e631537">_snd_pcm_shm_open</a> (<a class="el" href="group___p_c_m.html#gb5676348e7618b444e28907607660cef">snd_pcm_t</a> **pcmp, const char *name, <a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> *root, <a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> *conf, <a class="el" href="group___p_c_m.html#g854f0966bd0d7248ed3d9e5c293136ed">snd_pcm_stream_t</a> stream, int mode)</td></tr>
 
32
 
 
33
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Creates a new shm PCM.  <a href="#bc25b8b667178ab0528a39b12e631537"></a><br></td></tr>
 
34
</tbody></table>
 
35
</p><hr><a name="_details"></a><h2>Detailed Description</h2>
 
36
PCM Shared Memory Plugin Interface. 
 
37
<p>
 
38
</p><dl class="author" compact="compact"><dt><b>Author:</b></dt><dd>Abramo Bagnara &lt;<a href="mailto:abramo@alsa-project.org">abramo@alsa-project.org</a>&gt; </dd></dl>
 
39
<dl class="date" compact="compact"><dt><b>Date:</b></dt><dd>2000-2001 </dd></dl>
 
40
<hr><h2>Function Documentation</h2>
 
41
<a class="anchor" name="bc25b8b667178ab0528a39b12e631537"></a><!-- doxytag: member="pcm_shm.c::_snd_pcm_shm_open" ref="bc25b8b667178ab0528a39b12e631537" args="(snd_pcm_t **pcmp, const char *name, snd_config_t *root, snd_config_t *conf, snd_pcm_stream_t stream, int mode)" -->
 
42
<div class="memitem">
 
43
<div class="memproto">
 
44
      <table class="memname">
 
45
        <tbody><tr>
 
46
          <td class="memname">int _snd_pcm_shm_open           </td>
 
47
          <td>(</td>
 
48
          <td class="paramtype"><a class="el" href="group___p_c_m.html#gb5676348e7618b444e28907607660cef">snd_pcm_t</a> **&nbsp;</td>
 
49
          <td class="paramname"> <em>pcmp</em>, </td>
 
50
        </tr>
 
51
        <tr>
 
52
          <td class="paramkey"><br>
 
53
</td>
 
54
          <td><br>
 
55
</td>
 
56
          <td class="paramtype">const char *&nbsp;</td>
 
57
          <td class="paramname"> <em>name</em>, </td>
 
58
        </tr>
 
59
        <tr>
 
60
          <td class="paramkey"><br>
 
61
</td>
 
62
          <td><br>
 
63
</td>
 
64
          <td class="paramtype"><a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> *&nbsp;</td>
 
65
          <td class="paramname"> <em>root</em>, </td>
 
66
        </tr>
 
67
        <tr>
 
68
          <td class="paramkey"><br>
 
69
</td>
 
70
          <td><br>
 
71
</td>
 
72
          <td class="paramtype"><a class="el" href="group___config.html#gb7dc173feea5bedcd999bba678eb53a7">snd_config_t</a> *&nbsp;</td>
 
73
          <td class="paramname"> <em>conf</em>, </td>
 
74
        </tr>
 
75
        <tr>
 
76
          <td class="paramkey"><br>
 
77
</td>
 
78
          <td><br>
 
79
</td>
 
80
          <td class="paramtype"><a class="el" href="group___p_c_m.html#g854f0966bd0d7248ed3d9e5c293136ed">snd_pcm_stream_t</a>&nbsp;</td>
 
81
          <td class="paramname"> <em>stream</em>, </td>
 
82
        </tr>
 
83
        <tr>
 
84
          <td class="paramkey"><br>
 
85
</td>
 
86
          <td><br>
 
87
</td>
 
88
          <td class="paramtype">int&nbsp;</td>
 
89
          <td class="paramname"> <em>mode</em></td><td>&nbsp;</td>
 
90
        </tr>
 
91
        <tr>
 
92
          <td><br>
 
93
</td>
 
94
          <td>)</td>
 
95
          <td><br>
 
96
</td><td><br>
 
97
</td><td width="100%"><br>
 
98
</td>
 
99
        </tr>
 
100
      </tbody></table>
 
101
</div>
 
102
<div class="memdoc">
 
103
 
 
104
<p>
 
105
Creates a new shm PCM. 
 
106
</p><p>
 
107
</p><dl compact="compact"><dt><b>Parameters:</b></dt><dd>
 
108
  <table border="0" cellpadding="0" cellspacing="2">
 
109
    <tbody><tr><td valign="top"><br>
 
110
</td><td valign="top"><em>pcmp</em>&nbsp;</td><td>Returns created PCM handle </td></tr>
 
111
    <tr><td valign="top"><br>
 
112
</td><td valign="top"><em>name</em>&nbsp;</td><td>Name of PCM </td></tr>
 
113
    <tr><td valign="top"><br>
 
114
</td><td valign="top"><em>root</em>&nbsp;</td><td>Root configuration node </td></tr>
 
115
    <tr><td valign="top"><br>
 
116
</td><td valign="top"><em>conf</em>&nbsp;</td><td>Configuration node with hw PCM description </td></tr>
 
117
    <tr><td valign="top"><br>
 
118
</td><td valign="top"><em>stream</em>&nbsp;</td><td>PCM Stream </td></tr>
 
119
    <tr><td valign="top"><br>
 
120
</td><td valign="top"><em>mode</em>&nbsp;</td><td>PCM Mode </td></tr>
 
121
  </tbody></table>
 
122
</dd></dl>
 
123
<dl class="warning" compact="compact"><dt><b>Warning:</b></dt><dd>Using
 
124
of this function might be dangerous in the sense of compatibility
 
125
reasons. The prototype might be freely changed in future. </dd></dl>
 
126
 
 
127
</div>
 
128
</div><p>
 
129
<a class="anchor" name="fb300179c53db52f3ec4036589afabc0"></a><!-- doxytag: member="pcm_shm.c::snd_pcm_shm_open" ref="fb300179c53db52f3ec4036589afabc0" args="(snd_pcm_t **pcmp, const char *name, const char *sockname, const char *sname, snd_pcm_stream_t stream, int mode)" -->
 
130
</p><div class="memitem">
 
131
<div class="memproto">
 
132
      <table class="memname">
 
133
        <tbody><tr>
 
134
          <td class="memname">int snd_pcm_shm_open           </td>
 
135
          <td>(</td>
 
136
          <td class="paramtype"><a class="el" href="group___p_c_m.html#gb5676348e7618b444e28907607660cef">snd_pcm_t</a> **&nbsp;</td>
 
137
          <td class="paramname"> <em>pcmp</em>, </td>
 
138
        </tr>
 
139
        <tr>
 
140
          <td class="paramkey"><br>
 
141
</td>
 
142
          <td><br>
 
143
</td>
 
144
          <td class="paramtype">const char *&nbsp;</td>
 
145
          <td class="paramname"> <em>name</em>, </td>
 
146
        </tr>
 
147
        <tr>
 
148
          <td class="paramkey"><br>
 
149
</td>
 
150
          <td><br>
 
151
</td>
 
152
          <td class="paramtype">const char *&nbsp;</td>
 
153
          <td class="paramname"> <em>sockname</em>, </td>
 
154
        </tr>
 
155
        <tr>
 
156
          <td class="paramkey"><br>
 
157
</td>
 
158
          <td><br>
 
159
</td>
 
160
          <td class="paramtype">const char *&nbsp;</td>
 
161
          <td class="paramname"> <em>sname</em>, </td>
 
162
        </tr>
 
163
        <tr>
 
164
          <td class="paramkey"><br>
 
165
</td>
 
166
          <td><br>
 
167
</td>
 
168
          <td class="paramtype"><a class="el" href="group___p_c_m.html#g854f0966bd0d7248ed3d9e5c293136ed">snd_pcm_stream_t</a>&nbsp;</td>
 
169
          <td class="paramname"> <em>stream</em>, </td>
 
170
        </tr>
 
171
        <tr>
 
172
          <td class="paramkey"><br>
 
173
</td>
 
174
          <td><br>
 
175
</td>
 
176
          <td class="paramtype">int&nbsp;</td>
 
177
          <td class="paramname"> <em>mode</em></td><td>&nbsp;</td>
 
178
        </tr>
 
179
        <tr>
 
180
          <td><br>
 
181
</td>
 
182
          <td>)</td>
 
183
          <td><br>
 
184
</td><td><br>
 
185
</td><td width="100%"><br>
 
186
</td>
 
187
        </tr>
 
188
      </tbody></table>
 
189
</div>
 
190
<div class="memdoc">
 
191
 
 
192
<p>
 
193
Creates a new shared memory PCM. 
 
194
</p><p>
 
195
</p><dl compact="compact"><dt><b>Parameters:</b></dt><dd>
 
196
  <table border="0" cellpadding="0" cellspacing="2">
 
197
    <tbody><tr><td valign="top"><br>
 
198
</td><td valign="top"><em>pcmp</em>&nbsp;</td><td>Returns created PCM handle </td></tr>
 
199
    <tr><td valign="top"><br>
 
200
</td><td valign="top"><em>name</em>&nbsp;</td><td>Name of PCM </td></tr>
 
201
    <tr><td valign="top"><br>
 
202
</td><td valign="top"><em>sockname</em>&nbsp;</td><td>Unix socket name </td></tr>
 
203
    <tr><td valign="top"><br>
 
204
</td><td valign="top"><em>sname</em>&nbsp;</td><td>Server name </td></tr>
 
205
    <tr><td valign="top"><br>
 
206
</td><td valign="top"><em>stream</em>&nbsp;</td><td>PCM Stream </td></tr>
 
207
    <tr><td valign="top"><br>
 
208
</td><td valign="top"><em>mode</em>&nbsp;</td><td>PCM Mode </td></tr>
 
209
  </tbody></table>
 
210
</dd></dl>
 
211
<dl compact="compact"><dt><b>Return values:</b></dt><dd>
 
212
  <table border="0" cellpadding="0" cellspacing="2">
 
213
    <tbody><tr><td valign="top"><br>
 
214
</td><td valign="top"><em>zero</em>&nbsp;</td><td>on success otherwise a negative error code </td></tr>
 
215
  </tbody></table>
 
216
</dd></dl>
 
217
<dl class="warning" compact="compact"><dt><b>Warning:</b></dt><dd>Using
 
218
of this function might be dangerous in the sense of compatibility
 
219
reasons. The prototype might be freely changed in future. </dd></dl>
 
220
 
 
221
</div>
 
222
</div><p>
 
223
</p><hr size="1"><address style=""><small>Generated on Wed Sep 9 14:37:08 2009 for ALSA project - the C library reference by&nbsp;
 
224
<a href="http://www.doxygen.org/index.html">
 
225
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.0 </small></address>
 
226
</body></html>
 
 
b'\\ No newline at end of file'