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
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>BtAudioSession: Buzztrax Bt-Core Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Buzztrax Bt-Core Reference Manual">
<link rel="up" href="ch02.html" title="Core Class Reference">
<link rel="prev" href="BtApplication.html" title="BtApplication">
<link rel="next" href="BtSettings.html" title="BtSettings">
<meta name="generator" content="GTK-Doc V1.24.1 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
<a href="#BtAudioSession.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#BtAudioSession.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#BtAudioSession.properties" class="shortcut">Properties</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="BtApplication.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="BtSettings.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="BtAudioSession"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="BtAudioSession.top_of_page"></a>BtAudioSession</span></h2>
<p>BtAudioSession — bin to be used by <a class="link" href="BtSinkMachine.html" title="BtSinkMachine"><span class="type">BtSinkMachine</span></a></p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="BtAudioSession.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody><tr>
<td class="function_type">
<a class="link" href="BtAudioSession.html" title="BtAudioSession"><span class="returnvalue">BtAudioSession</span></a> *
</td>
<td class="function_name">
<a class="link" href="BtAudioSession.html#bt-audio-session-new" title="bt_audio_session_new ()">bt_audio_session_new</a> <span class="c_punctuation">()</span>
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="BtAudioSession.properties"></a><h2>Properties</h2>
<div class="informaltable"><table border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type"><a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td>
<td class="property_name"><a class="link" href="BtAudioSession.html#BtAudioSession--audio-locked" title="The “audio-locked” property">audio-locked</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/gstreamer-1.0GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *</td>
<td class="property_name"><a class="link" href="BtAudioSession.html#BtAudioSession--audio-sink" title="The “audio-sink” property">audio-sink</a></td>
<td class="property_flags">Read</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="BtAudioSession.html#BtAudioSession--audio-sink-device" title="The “audio-sink-device” property">audio-sink-device</a></td>
<td class="property_flags">Read / Write</td>
</tr>
<tr>
<td class="property_type">
<a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="BtAudioSession.html#BtAudioSession--audio-sink-name" title="The “audio-sink-name” property">audio-sink-name</a></td>
<td class="property_flags">Read / Write</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="BtAudioSession.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="BtAudioSession.html#BtAudioSession-struct" title="struct BtAudioSession">BtAudioSession</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="BtAudioSession.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobjectgobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> BtAudioSession
</pre>
</div>
<div class="refsect1">
<a name="BtAudioSession.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libbtcore/core.h>
</pre>
</div>
<div class="refsect1">
<a name="BtAudioSession.description"></a><h2>Description</h2>
<p>The audio-session provides a persistent audio-sink for some classes. This
e.g. ensures a persistent presence in qjackctrl if jackaudiosink is used.</p>
<p>The top <a class="link" href="BtApplication.html" title="BtApplication"><span class="type">BtApplication</span></a> should create one and dispose it at the end of the
lifecycle. The audio-session is a singleton, parts in the code can just call
<a class="link" href="BtAudioSession.html#bt-audio-session-new" title="bt_audio_session_new ()"><code class="function">bt_audio_session_new()</code></a> to get the instance.</p>
</div>
<div class="refsect1">
<a name="BtAudioSession.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="bt-audio-session-new"></a><h3>bt_audio_session_new ()</h3>
<pre class="programlisting"><a class="link" href="BtAudioSession.html" title="BtAudioSession"><span class="returnvalue">BtAudioSession</span></a> *
bt_audio_session_new (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Create a new audio-session or return the existing one. The audio session
keeps the audio setup alive across songs. An application can only have one
audio-session. This method can be called several times though.</p>
<div class="refsect3">
<a name="id-1.4.3.4.9.2.5"></a><h4>Returns</h4>
<p> the audio-session, unref when done.</p>
</div>
</div>
</div>
<div class="refsect1">
<a name="BtAudioSession.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="BtAudioSession-struct"></a><h3>struct BtAudioSession</h3>
<pre class="programlisting">struct BtAudioSession;</pre>
<p>Maintains the audio connection for the life time of the application.</p>
</div>
</div>
<div class="refsect1">
<a name="BtAudioSession.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="BtAudioSession--audio-locked"></a><h3>The <code class="literal">“audio-locked”</code> property</h3>
<pre class="programlisting"> “audio-locked” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre>
<p>locked state for the audio-sink.</p>
<p>Flags: Read / Write</p>
<p>Default value: FALSE</p>
</div>
<hr>
<div class="refsect2">
<a name="BtAudioSession--audio-sink"></a><h3>The <code class="literal">“audio-sink”</code> property</h3>
<pre class="programlisting"> “audio-sink” <a href="/usr/share/gtk-doc/html/gstreamer-1.0GstElement.html#GstElement-struct"><span class="type">GstElement</span></a> *</pre>
<p>the audio-sink for the session.</p>
<p>Flags: Read</p>
</div>
<hr>
<div class="refsect2">
<a name="BtAudioSession--audio-sink-device"></a><h3>The <code class="literal">“audio-sink-device”</code> property</h3>
<pre class="programlisting"> “audio-sink-device” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The name of the audio sink device.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
<hr>
<div class="refsect2">
<a name="BtAudioSession--audio-sink-name"></a><h3>The <code class="literal">“audio-sink-name”</code> property</h3>
<pre class="programlisting"> “audio-sink-name” <a href="/usr/share/gtk-doc/html/glibglib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The name of the audio sink factory.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24.1</div>
</body>
</html>
|
