Platforms to show: All Mac Windows Linux Cross-Platform

PortAudioStreamBaseMBS.CPULoad as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Audio MBS Audio Plugin 7.4 Yes Yes Yes Yes No
Function: Retrieve CPU usage information for the specified stream.
Notes:
The "CPU Load" is a fraction of total CPU time consumed by a callback stream's audio processing routines including, but not limited to the client supplied stream callback. This function does not work with blocking read/write streams.

This function may be called from the stream callback function or the application.

Returns a floating point value, typically between 0.0 and 1.0, where 1.0 indicates that the stream event is consuming the maximum number of CPU cycles possible to maintain real-time operation. A value of 0.5 would imply that PortAudio and the stream event was consuming roughly 50% of the available CPU time. The return value may exceed 1.0. A value of 0.0 will always be returned for a blocking read/write stream, or if an error occurrs.
(Read only property)

Feedback, Comments & Corrections

PortAudioStreamBaseMBS.IsStreamActive as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Audio MBS Audio Plugin 7.4 Yes Yes Yes Yes No
Function: Determine whether the stream is active.
Notes:
A stream is active after a successful call to Start(), until it becomes inactive either as a result of a call to Stop() or Abort(), or as a result of a return value other than paContinue from the stream callback. In the latter case, the stream is considered inactive after the last buffer has finished playing.

Returns one (1) when the stream is active (ie playing or recording audio), zero (0) when not playing or, a PaErrorCode (which are always negative) if PortAudio is not initialized or an error is encountered.
(Read only property)

Feedback, Comments & Corrections

PortAudioStreamBaseMBS.IsStreamStopped as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Audio MBS Audio Plugin 7.4 Yes Yes Yes Yes No
Function: Determine whether the stream is stopped.
Notes:
A stream is considered to be stopped prior to a successful call to Start and after a successful call to Stop or Abort.
If a stream value returns a value other than paContinue (0) the stream is NOT considered to be stopped.

Returns one (1) when the stream is stopped, zero (0) when the stream is running or, a PaErrorCode (which are always negative) if PortAudio is not initialized or an error is encountered.
(Read only property)

Feedback, Comments & Corrections

PortAudioStreamBaseMBS.MacCoreAudioStreamInputDevice as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Audio MBS Audio Plugin 20.0 Yes Yes Yes Yes No
Function: Retrieve the AudioDeviceID of the input device assigned to an open stream.
Notes:
Returns a valid AudioDeviceID, or 0 if an error occurred.
(Read only property)

Feedback, Comments & Corrections

PortAudioStreamBaseMBS.MacCoreAudioStreamOutputDevice as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Audio MBS Audio Plugin 20.0 Yes Yes Yes Yes No
Function: Retrieve the AudioDeviceID of the output device assigned to an open stream.
Notes:
Returns a valid AudioDeviceID, or 0 if an error occurred.
(Read only property)

Feedback, Comments & Corrections

PortAudioStreamBaseMBS.ReadAvailable as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Audio MBS Audio Plugin 20.1 Yes Yes Yes Yes No
Function: Retrieve the number of frames that can be read from the stream without waiting.
Notes:
Returns a non-negative value representing the maximum number of frames that can be read from the stream without blocking or busy waiting or, a PaErrorCode (which are always negative) if PortAudio is not initialized or an error is encountered.
(Read only property)

Feedback, Comments & Corrections

PortAudioStreamBaseMBS.Time as Double
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Audio MBS Audio Plugin 7.4 Yes Yes Yes Yes No
Function: Determine the current time for the stream according to the same clock used to generate buffer timestamps.
Notes:
This time may be used for syncronising other events to the audio stream, for example synchronizing audio to MIDI.

Returns the stream's current time in seconds, or 0 if an error occurred.
(Read only property)

Feedback, Comments & Corrections

PortAudioStreamBaseMBS.WriteAvailable as Integer
Type Topic Plugin Version macOS Windows Linux Console & Web iOS
property Audio MBS Audio Plugin 20.1 Yes Yes Yes Yes No
Function: Retrieve the number of frames that can be written to the stream without waiting.
Notes:
Returns a non-negative value representing the maximum number of frames that can be written to the stream without blocking or busy waiting or, a PaErrorCode (which are always negative) if PortAudio is not initialized or an error is encountered.
(Read only property)

Feedback, Comments & Corrections

The items on this page are in the following plugins: MBS Audio Plugin.

The biggest plugin in space...




Links
MBS Xojo blog