portaudio/include/pa_jack.h

#ifndef PA_JACK_H
#define PA_JACK_H

/*
 * $Id:
 * PortAudio Portable Real-Time Audio Library
 * JACK-specific extensions
 *
 * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
 *
 * Permission is hereby granted, free of charge, to any person obtaining
 * a copy of this software and associated documentation files
 * (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge,
 * publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
 * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

/*
 * The text above constitutes the entire PortAudio license; however, 
 * the PortAudio community also makes the following non-binding requests:
 *
 * Any person wishing to distribute modifications to the Software is
 * requested to send the modifications to the original developer so that
 * they can be incorporated into the canonical version. It is also 
 * requested that these non-binding requests be included along with the 
 * license above.
 */

/** @file
 *  @ingroup public_header
 *  @brief JACK-specific PortAudio API extension header file.
 */
#include "portaudio.h"

#ifdef __cplusplus
extern "C" {
#endif

/** Set the JACK client name.
 *
 * During Pa_Initialize, When PA JACK connects as a client of the JACK server, it requests a certain
 * name, which is for instance prepended to port names. By default this name is "PortAudio". The
 * JACK server may append a suffix to the client name, in order to avoid clashes among clients that
 * try to connect with the same name (e.g., different PA JACK clients).
 *
 * This function must be called before Pa_Initialize, otherwise it won't have any effect. Note that
 * the string is not copied, but instead referenced directly, so it must not be freed for as long as
 * PA might need it.
 * @sa PaJack_GetClientName
 */
PaError PaJack_SetClientName( const char* name );

/** Get the JACK client name used by PA JACK.
 *
 * The caller is responsible for freeing the returned pointer.
 */
PaError PaJack_GetClientName(const char** clientName);

#ifdef __cplusplus
}
#endif

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