CSIAsio Class Reference
CSIAsio. More...
Public Member Functions | |
| virtual SSIError | SSInBegin () |
| begins sample stream input | |
| virtual SSIError | SSInEnd () |
| ends sample stream input | |
| virtual SSIError | SSInRead () |
| requests a buffer of input | |
| virtual char * | SSInPtr () |
| returns a pointer to the current input sample buffer | |
| virtual long | SSInBytes () |
| returns the size of the SSInPtr() buffer in bytes | |
| virtual StreamType | SSInStreamType () |
| returns the CSSI subclass's stream type | |
| virtual bool | SSInContinuous () |
| returns true if the stream is continuous | |
Detailed Description
CSIAsio detail
- See also:
- CSOS
Library: slabw
Member Function Documentation
| virtual SSIError CSIAsio::SSInBegin | ( | ) | [virtual] |
SSInBegin() begins sample stream input. Subclasses should call the base class function to init the Sample interface and reset the overflow counter.
Reimplemented from CSSI.
| virtual SSIError CSIAsio::SSInEnd | ( | ) | [virtual] |
| virtual SSIError CSIAsio::SSInRead | ( | ) | [virtual] |
SSInRead() requests a buffer of input. For continuous streams, this function can suspend, waiting for input samples. Subclasses should call the base class function to reset the Sample interface for the new buffer. After SSInRead() returns, SSInPtr() will point to the new sample data and SSInBytes() will indicate the number of bytes read.
Reimplemented from CSSI.
| virtual char* CSIAsio::SSInPtr | ( | ) | [inline, virtual] |
SSInPtr() returns a pointer to the current input sample buffer. The buffer samples are channel-interleaved and in their native format (e.g., 8 or 16-bit int, float). The Sample interface provides a slightly higher-level of buffer access, retrieving samples one at a time in float format. Some SSIs might choose to only support one type of sample access.
Reimplemented from CSSI.
| virtual long CSIAsio::SSInBytes | ( | ) | [inline, virtual] |
SSInBytes() returns the size of the SSInPtr() buffer in bytes.
Reimplemented from CSSI.
| virtual bool CSIAsio::SSInContinuous | ( | ) | [inline, virtual] |
SSInContinuous() returns true if the stream is continuous. A continuous stream is a stream such as a device that must be pumped continuously (i.e., buffers must by cycled). When a continuous stream is paused, samples are discarded.
By default, this function returns false. Subclasses should override this function and return true if the stream is continuous.
Reimplemented from CSSI.