|
cannam@89
|
1 #ifndef PA_JACK_H
|
|
cannam@89
|
2 #define PA_JACK_H
|
|
cannam@89
|
3
|
|
cannam@89
|
4 /*
|
|
cannam@89
|
5 * $Id:
|
|
cannam@89
|
6 * PortAudio Portable Real-Time Audio Library
|
|
cannam@89
|
7 * JACK-specific extensions
|
|
cannam@89
|
8 *
|
|
cannam@89
|
9 * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
|
|
cannam@89
|
10 *
|
|
cannam@89
|
11 * Permission is hereby granted, free of charge, to any person obtaining
|
|
cannam@89
|
12 * a copy of this software and associated documentation files
|
|
cannam@89
|
13 * (the "Software"), to deal in the Software without restriction,
|
|
cannam@89
|
14 * including without limitation the rights to use, copy, modify, merge,
|
|
cannam@89
|
15 * publish, distribute, sublicense, and/or sell copies of the Software,
|
|
cannam@89
|
16 * and to permit persons to whom the Software is furnished to do so,
|
|
cannam@89
|
17 * subject to the following conditions:
|
|
cannam@89
|
18 *
|
|
cannam@89
|
19 * The above copyright notice and this permission notice shall be
|
|
cannam@89
|
20 * included in all copies or substantial portions of the Software.
|
|
cannam@89
|
21 *
|
|
cannam@89
|
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
cannam@89
|
23 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
cannam@89
|
24 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
|
|
cannam@89
|
25 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
|
|
cannam@89
|
26 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
|
|
cannam@89
|
27 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
cannam@89
|
28 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
cannam@89
|
29 */
|
|
cannam@89
|
30
|
|
cannam@89
|
31 /*
|
|
cannam@89
|
32 * The text above constitutes the entire PortAudio license; however,
|
|
cannam@89
|
33 * the PortAudio community also makes the following non-binding requests:
|
|
cannam@89
|
34 *
|
|
cannam@89
|
35 * Any person wishing to distribute modifications to the Software is
|
|
cannam@89
|
36 * requested to send the modifications to the original developer so that
|
|
cannam@89
|
37 * they can be incorporated into the canonical version. It is also
|
|
cannam@89
|
38 * requested that these non-binding requests be included along with the
|
|
cannam@89
|
39 * license above.
|
|
cannam@89
|
40 */
|
|
cannam@89
|
41
|
|
cannam@89
|
42 /** @file
|
|
cannam@89
|
43 * @ingroup public_header
|
|
cannam@89
|
44 * @brief JACK-specific PortAudio API extension header file.
|
|
cannam@89
|
45 */
|
|
cannam@89
|
46
|
|
cannam@89
|
47 #include "portaudio.h"
|
|
cannam@89
|
48
|
|
cannam@89
|
49 #ifdef __cplusplus
|
|
cannam@89
|
50 extern "C" {
|
|
cannam@89
|
51 #endif
|
|
cannam@89
|
52
|
|
cannam@89
|
53 /** Set the JACK client name.
|
|
cannam@89
|
54 *
|
|
cannam@89
|
55 * During Pa_Initialize, When PA JACK connects as a client of the JACK server, it requests a certain
|
|
cannam@89
|
56 * name, which is for instance prepended to port names. By default this name is "PortAudio". The
|
|
cannam@89
|
57 * JACK server may append a suffix to the client name, in order to avoid clashes among clients that
|
|
cannam@89
|
58 * try to connect with the same name (e.g., different PA JACK clients).
|
|
cannam@89
|
59 *
|
|
cannam@89
|
60 * This function must be called before Pa_Initialize, otherwise it won't have any effect. Note that
|
|
cannam@89
|
61 * the string is not copied, but instead referenced directly, so it must not be freed for as long as
|
|
cannam@89
|
62 * PA might need it.
|
|
cannam@89
|
63 * @sa PaJack_GetClientName
|
|
cannam@89
|
64 */
|
|
cannam@89
|
65 PaError PaJack_SetClientName( const char* name );
|
|
cannam@89
|
66
|
|
cannam@89
|
67 /** Get the JACK client name used by PA JACK.
|
|
cannam@89
|
68 *
|
|
cannam@89
|
69 * The caller is responsible for freeing the returned pointer.
|
|
cannam@89
|
70 */
|
|
cannam@89
|
71 PaError PaJack_GetClientName(const char** clientName);
|
|
cannam@89
|
72
|
|
cannam@89
|
73 #ifdef __cplusplus
|
|
cannam@89
|
74 }
|
|
cannam@89
|
75 #endif
|
|
cannam@89
|
76
|
|
cannam@89
|
77 #endif
|
