pa_jack.h 2.7 KB

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