From: rossb Date: Sat, 11 Dec 2010 03:11:35 +0000 (+0000) Subject: doc tweaks X-Git-Tag: pa_stable_v19_20110326_r1647~74 X-Git-Url: https://andrewgundersen.net/repos?a=commitdiff_plain;h=5b6dcbe59b195a146ca4e41af34aac90d4e85377;p=portaudio doc tweaks --- diff --git a/doc/src/api_overview.dox b/doc/src/api_overview.dox index 40673b5..4e4f7d2 100644 --- a/doc/src/api_overview.dox +++ b/doc/src/api_overview.dox @@ -14,11 +14,11 @@ PortAudio provides a uniform interface to native audio APIs. However, it doesn't The PortAudio processing model includes three main abstractions: Host APIs, audio Devices and audio Streams. -Host APIs represent platform-specific native audio APIs. Some examples of Host APIs are Core Audio on Mac OS, WMME and DirectSound on Windows and OSS and ALSA on Linux. The diagram in the previous section shows many of the supported native APIs. Sometimes it's useful to know which Host APIs you're dealing with, but it is easy to use PortAudio without ever interacting directly with the Host API abstraction. +Host APIs represent platform-specific native audio APIs. Some examples of Host APIs are Core Audio on Mac OS, WMME and DirectSound on Windows and OSS and ALSA on Linux. The diagram in the previous section shows many of the supported native APIs. Sometimes it's useful to know which Host APIs you're dealing with, but it is easy to use PortAudio without ever interacting directly with the Host API abstraction. -Devices represent individual hardware audio interfaces or audio ports on the host platform. Devices have names and certain capabilities such as supported sample rates and the number of supported input and output channels. PortAudio provides functions to enumerate available Devices and to query for Device capabilities. +Devices represent individual hardware audio interfaces or audio ports on the host platform. Devices have names and certain capabilities such as supported sample rates and the number of supported input and output channels. PortAudio provides functions to enumerate available Devices and to query for Device capabilities. -Streams manage active audio input and output from and to Devices. Streams may be half duplex (input or output) or full duplex (simultaneous input and output). Streams operate at a specific sample rate with particular sample formats, buffer sizes and internal buffering latencies. You specify these parameters when you open the Stream. Audio data is communicated between a Stream and your application via a user provided asynchronous callback function or by invoking synchronous read and write functions. +Streams manage active audio input and output from and to Devices. Streams may be half duplex (input or output) or full duplex (simultaneous input and output). Streams operate at a specific sample rate with particular sample formats, buffer sizes and internal buffering latencies. You specify these parameters when you open the Stream. Audio data is communicated between a Stream and your application via a user provided asynchronous callback function or by invoking synchronous read and write functions. PortAudio supports audio input and output in a variety of sample formats: 8, 16, 24 and 32 bit integer formats and 32 bit floating point, irrespective of the formats supported by the native audio API. PortAudio also supports multichannel buffers in both interleaved and non-interleaved (separate buffer per channel) formats and automatically performs conversion when necessary. If requested, PortAudio can clamp out-of range samples and/or dither to a native format. @@ -148,7 +148,7 @@ Host API-specific extensions are provided in the form of additional functions an The @ref PaStreamParameters structure passed to Pa_IsFormatSupported() and Pa_OpenStream() has a field named @ref PaStreamParameters::hostApiSpecificStreamInfo that is sometimes used to pass low level information when opening a Stream. -See the documentation for the individual Host API-specific header files for details of the functionality they expose: +See the documentation for the individual Host API-specific header files for details of the extended functionality they expose: - pa_asio.h - pa_jack.h