Carbon


SPBGetRecordingStatus

Header: Sound.h Carbon status: Supported

Obtains recording status information about a sound input device.

OSErr SPBGetRecordingStatus (
    SInt32 inRefNum, 
    SInt16 *recordingStatus, 
    SInt16 *meterLevel, 
    UInt32 *totalSamplesToRecord, 
    UInt32 *numberOfSamplesRecorded, 
    UInt32 *totalMsecsToRecord, 
    UInt32 *numberOfMsecsRecorded
);
Parameter descriptions
inRefNum

The device reference number of the sound input device, as obtained from the SPBOpenDevice function.

recordingStatus

On return, a pointer to a value indicating the status of the recording. While the input device is recording, this parameter is set to a number greater than 0. When a recording terminates without an error, this parameter is set to 0. When an error occurs during recording or the recording has been terminated by a call to the SPBStopRecording function, this parameter is less than 0 and contains an error code.

meterLevel

On return, a pointer to the current input signal level. This level ranges from 0 to 255.

totalSamplesToRecord

On return, a pointer to the total number of samples to record, including those samples already recorded.

numberOfSamplesRecorded

On return, a pointer to the number of samples already recorded.

totalMsecsToRecord

On return, a pointer to the total duration of recording time, including recording time already elapsed.

numberOfMsecsRecorded

On return, a pointer to the amount of recording time that has elapsed.

function result

A result code.

SPECIAL CONSIDERATIONS

You can call the SPBGetRecordingStatus function at interrupt time.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.


© 2000 Apple Computer, Inc. (Last Updated 6/30/2000)