pa_jack.h (2805B)
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 47 #include "portaudio.h" 48 49 #ifdef __cplusplus 50 extern "C" { 51 #endif 52 53 /** Set the JACK client name. 54 * 55 * During Pa_Initialize, When PA JACK connects as a client of the JACK server, it requests a certain 56 * name, which is for instance prepended to port names. By default this name is "PortAudio". The 57 * JACK server may append a suffix to the client name, in order to avoid clashes among clients that 58 * try to connect with the same name (e.g., different PA JACK clients). 59 * 60 * This function must be called before Pa_Initialize, otherwise it won't have any effect. Note that 61 * the string is not copied, but instead referenced directly, so it must not be freed for as long as 62 * PA might need it. 63 * @sa PaJack_GetClientName 64 */ 65 PaError PaJack_SetClientName( const char* name ); 66 67 /** Get the JACK client name used by PA JACK. 68 * 69 * The caller is responsible for freeing the returned pointer. 70 */ 71 PaError PaJack_GetClientName(const char** clientName); 72 73 #ifdef __cplusplus 74 } 75 #endif 76 77 #endif