Crate rtaudio_sys

Structs

rtaudio

rtaudio_device_info

! The public device information structure for returning queried values. ! See \ref RtAudio::DeviceInfo.

rtaudio_stream_options

! The structure for specifying stream options. ! See \ref RtAudio::StreamOptions.

rtaudio_stream_parameters

! The structure for specifying input or output stream parameters. ! See \ref RtAudio::StreamParameters.

Constants

MAX_NAME_LENGTH

NUM_SAMPLE_RATES

RTAUDIO_API_DUMMY

< A compilable but non-functional API.

RTAUDIO_API_LINUX_ALSA

< The Advanced Linux Sound Architecture API.

RTAUDIO_API_LINUX_OSS

< The Linux Open Sound System API.

RTAUDIO_API_LINUX_PULSE

< The Linux PulseAudio API.

RTAUDIO_API_MACOSX_CORE

< Macintosh OS-X Core Audio API.

RTAUDIO_API_NUM

< Number of values in this enum.

RTAUDIO_API_UNIX_JACK

< The Jack Low-Latency Audio Server API.

RTAUDIO_API_UNSPECIFIED

< Search for a working compiled API.

RTAUDIO_API_WINDOWS_ASIO

< The Steinberg Audio Stream I/O API.

RTAUDIO_API_WINDOWS_DS

< The Microsoft DirectSound API.

RTAUDIO_API_WINDOWS_WASAPI

< The Microsoft WASAPI API.

RTAUDIO_ERROR_DEVICE_DISCONNECT

< A device in use was disconnected.

RTAUDIO_ERROR_DRIVER_ERROR

< A system driver error occurred.

RTAUDIO_ERROR_INVALID_DEVICE

< An invalid device ID was specified.

RTAUDIO_ERROR_INVALID_PARAMETER

< An invalid parameter was specified to a function.

RTAUDIO_ERROR_INVALID_USE

< The function was called incorrectly.

RTAUDIO_ERROR_MEMORY_ERROR

< An error occurred during memory allocation.

RTAUDIO_ERROR_NONE

< No error.

RTAUDIO_ERROR_NO_DEVICES_FOUND

< No devices found on system.

RTAUDIO_ERROR_SYSTEM_ERROR

< A system error occurred.

RTAUDIO_ERROR_THREAD_ERROR

< A thread error occurred.

RTAUDIO_ERROR_UNKNOWN

< An unspecified error type.

RTAUDIO_ERROR_WARNING

< A non-critical error.

RTAUDIO_FLAGS_ALSA_USE_DEFAULT

RTAUDIO_FLAGS_HOG_DEVICE

RTAUDIO_FLAGS_JACK_DONT_CONNECT

RTAUDIO_FLAGS_MINIMIZE_LATENCY

RTAUDIO_FLAGS_NONINTERLEAVED

RTAUDIO_FLAGS_SCHEDULE_REALTIME

RTAUDIO_FORMAT_FLOAT32

RTAUDIO_FORMAT_FLOAT64

RTAUDIO_FORMAT_SINT8

RTAUDIO_FORMAT_SINT16

RTAUDIO_FORMAT_SINT24

RTAUDIO_FORMAT_SINT32

RTAUDIO_STATUS_INPUT_OVERFLOW

RTAUDIO_STATUS_OUTPUT_UNDERFLOW

Functions

rtaudio_abort_stream^⚠

! Stop a stream, discarding any samples remaining in the ! input/output queue. See \ref RtAudio::abortStream().

rtaudio_api_display_name^⚠

! Return the display name of a specified rtaudio_api_t. See \ref ! RtAudio::getApiDisplayName().

rtaudio_api_name^⚠

! Return the name of a specified rtaudio_api_t. This string can be ! used to look up an API by rtaudio_compiled_api_by_name(). See ! \ref RtAudio::getApiName().

rtaudio_close_stream^⚠

! Closes a stream and frees any associated stream memory. See \ref RtAudio::closeStream().

rtaudio_compiled_api^⚠

! Return an array of rtaudio_api_t compiled into this instance of ! RtAudio. This array is static (do not free it) and has the length ! returned by rtaudio_get_num_compiled_apis(). See \ref ! RtAudio::getCompiledApi().

rtaudio_compiled_api_by_name^⚠

! Return the rtaudio_api_t having the given name. See \ref ! RtAudio::getCompiledApiByName().

rtaudio_create^⚠

! Create an instance of struct rtaudio.

rtaudio_current_api^⚠

! Returns the audio API specifier for the current instance of ! RtAudio. See RtAudio::getCurrentApi().

rtaudio_destroy^⚠

! Free an instance of struct rtaudio.

rtaudio_device_count^⚠

! Queries for the number of audio devices available. See \ref ! RtAudio::getDeviceCount().

rtaudio_error^⚠

rtaudio_error_type^⚠

rtaudio_get_default_input_device^⚠

! Returns the device id of the default input device. See \ref ! RtAudio::getDefaultInputDevice().

rtaudio_get_default_output_device^⚠

! Returns the device id of the default output device. See \ref ! RtAudio::getDefaultOutputDevice().

rtaudio_get_device_id^⚠

! Returns the audio device ID corresponding to a given index ! value (valid index values are between 0 and rtaudio_device_count()-1). ! Note that a return value of 0 is invalid, which will occur if the ! index value is out of bounds or no devices are found. See \ref ! RtAudio::getDeviceIds().

rtaudio_get_device_info^⚠

! Return a struct rtaudio_device_info for a specified device ID. ! See \ref RtAudio::getDeviceInfo().

rtaudio_get_num_compiled_apis^⚠

! Determine the number of available compiled audio APIs, the length ! of the array returned by rtaudio_compiled_api(). See \ref ! RtAudio::getCompiledApi().

rtaudio_get_stream_latency^⚠

! Returns the internal stream latency in sample frames. See \ref ! RtAudio::getStreamLatency().

rtaudio_get_stream_sample_rate^⚠

! Returns actual sample rate in use by the stream. See \ref ! RtAudio::getStreamSampleRate().

rtaudio_get_stream_time^⚠

! Returns the number of elapsed seconds since the stream was ! started. See \ref RtAudio::getStreamTime().

rtaudio_is_stream_open^⚠

! Returns 1 if a stream is open and false if not. See \ref RtAudio::isStreamOpen().

rtaudio_is_stream_running^⚠

! Returns 1 if a stream is running and false if it is stopped or not ! open. See \ref RtAudio::isStreamRunning().

rtaudio_open_stream^⚠

! Opens a stream with the specified parameters. See \ref RtAudio::openStream(). ! \return an \ref rtaudio_error.

rtaudio_set_stream_time^⚠

! Set the stream time to a time in seconds greater than or equal to ! 0.0. See \ref RtAudio::setStreamTime().

rtaudio_show_warnings^⚠

! Specify whether warning messages should be printed to stderr. See ! \ref RtAudio::showWarnings().

rtaudio_start_stream^⚠

! Starts a stream. See \ref RtAudio::startStream().

rtaudio_stop_stream^⚠

! Stop a stream, allowing any samples remaining in the output queue ! to be played. See \ref RtAudio::stopStream().

rtaudio_version^⚠

! Determine the current RtAudio version. See \ref RtAudio::getVersion().

Type Aliases

rtaudio_api_t

! Audio API specifier. See \ref RtAudio::Api.

rtaudio_cb_t

! RtAudio callback function prototype. *! All RtAudio clients must create a function of this type to read and/or write data from/to the audio stream. When the underlying audio system is ready for new input or output data, this function will be invoked.

rtaudio_device_info_t

! The public device information structure for returning queried values. ! See \ref RtAudio::DeviceInfo.

rtaudio_error_cb_t

! RtAudio error callback function prototype. *! \param err Type of error. \param msg Error description.

rtaudio_error_t

\brief Error codes for RtAudio.

rtaudio_format_t

\typedef typedef unsigned long rtaudio_format_t; \brief RtAudio data format type.

rtaudio_stream_flags_t

\typedef typedef unsigned long rtaudio_stream_flags_t; \brief RtAudio stream option flags.

rtaudio_stream_options_t

! The structure for specifying stream options. ! See \ref RtAudio::StreamOptions.

rtaudio_stream_parameters_t

! The structure for specifying input or output stream parameters. ! See \ref RtAudio::StreamParameters.

rtaudio_stream_status_t

\typedef typedef unsigned long rtaudio_stream_status_t; \brief RtAudio stream status (over- or underflow) flags.

rtaudio_t