cannam@162: #ifndef PA_JACK_H
cannam@162: #define PA_JACK_H
cannam@162: 
cannam@162: /*
cannam@162:  * $Id:
cannam@162:  * PortAudio Portable Real-Time Audio Library
cannam@162:  * JACK-specific extensions
cannam@162:  *
cannam@162:  * Copyright (c) 1999-2000 Ross Bencina and Phil Burk
cannam@162:  *
cannam@162:  * Permission is hereby granted, free of charge, to any person obtaining
cannam@162:  * a copy of this software and associated documentation files
cannam@162:  * (the "Software"), to deal in the Software without restriction,
cannam@162:  * including without limitation the rights to use, copy, modify, merge,
cannam@162:  * publish, distribute, sublicense, and/or sell copies of the Software,
cannam@162:  * and to permit persons to whom the Software is furnished to do so,
cannam@162:  * subject to the following conditions:
cannam@162:  *
cannam@162:  * The above copyright notice and this permission notice shall be
cannam@162:  * included in all copies or substantial portions of the Software.
cannam@162:  *
cannam@162:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
cannam@162:  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
cannam@162:  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
cannam@162:  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
cannam@162:  * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
cannam@162:  * CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
cannam@162:  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
cannam@162:  */
cannam@162: 
cannam@162: /*
cannam@162:  * The text above constitutes the entire PortAudio license; however, 
cannam@162:  * the PortAudio community also makes the following non-binding requests:
cannam@162:  *
cannam@162:  * Any person wishing to distribute modifications to the Software is
cannam@162:  * requested to send the modifications to the original developer so that
cannam@162:  * they can be incorporated into the canonical version. It is also 
cannam@162:  * requested that these non-binding requests be included along with the 
cannam@162:  * license above.
cannam@162:  */
cannam@162: 
cannam@162: /** @file
cannam@162:  *  @ingroup public_header
cannam@162:  *  @brief JACK-specific PortAudio API extension header file.
cannam@162:  */
cannam@162: 
cannam@162: #include "portaudio.h"
cannam@162: 
cannam@162: #ifdef __cplusplus
cannam@162: extern "C" {
cannam@162: #endif
cannam@162: 
cannam@162: /** Set the JACK client name.
cannam@162:  *
cannam@162:  * During Pa_Initialize, When PA JACK connects as a client of the JACK server, it requests a certain
cannam@162:  * name, which is for instance prepended to port names. By default this name is "PortAudio". The
cannam@162:  * JACK server may append a suffix to the client name, in order to avoid clashes among clients that
cannam@162:  * try to connect with the same name (e.g., different PA JACK clients).
cannam@162:  *
cannam@162:  * This function must be called before Pa_Initialize, otherwise it won't have any effect. Note that
cannam@162:  * the string is not copied, but instead referenced directly, so it must not be freed for as long as
cannam@162:  * PA might need it.
cannam@162:  * @sa PaJack_GetClientName
cannam@162:  */
cannam@162: PaError PaJack_SetClientName( const char* name );
cannam@162: 
cannam@162: /** Get the JACK client name used by PA JACK.
cannam@162:  *
cannam@162:  * The caller is responsible for freeing the returned pointer.
cannam@162:  */
cannam@162: PaError PaJack_GetClientName(const char** clientName);
cannam@162: 
cannam@162: #ifdef __cplusplus
cannam@162: }
cannam@162: #endif
cannam@162: 
cannam@162: #endif