Carbon


SPBStopRecording

Header: Sound.h Carbon status: Supported

Ends a recording from a sound input device.

OSErr SPBStopRecording (
    SInt32 inRefNum
);
Parameter descriptions
inRefNum

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

function result

A result code.

DISCUSSION

The SPBStopRecording function stops recording from the device specified by the inRefNum parameter. The recording must be asynchronous for SPBStopRecording to have any effect. When you call SPBStopRecording, the sound input completion function specified in the completionRoutine field of the sound input parameter block is called and the error field of that parameter block is set to abortErr. If you are writing a device driver, you will receive a KillIOStatus call.

This low-level function does not display the sound recording dialog box to the user.

SPECIAL CONSIDERATIONS

You can call the SPBStopRecording 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)