Carbon


SPBSignInDevice

Header: Sound.h Carbon status: Supported

Registers a sound input device.

OSErr SPBSignInDevice (
    SInt16 deviceRefNum, 
    ConstStr255Param deviceName
);
Parameter descriptions
deviceRefNum

The device driver reference number of the sound input device to register with the Sound Input Manager.

deviceName

The device’s name as it is to appear to the user in the Sound In control panel (which is not the name of the driver used by the Device Manager).

function result

A result code.

DISCUSSION

The SPBSignInDevice function registers with the Sound Input Manager the device whose driver reference number is deviceRefNum.

The deviceName parameter specifies this device’s name as it is to appear to the user in the Sound In control panel (which is not the name of the driver itself). Accordingly, the name should be as descriptive as possible. You should call SPBSignInDevice after you have already opened your driver by calling normal Device Manager functions.

Sound input device drivers must call the SPBSignInDevice function to register with the Sound Input Manager before they can use its sound input services. You might call this function at system startup time from within an extension to install a sound input device driver.

SPECIAL CONSIDERATIONS

Because the SPBSignInDevice function moves or purges memory, you should not call it at interrupt time. You can, however, call it at system startup 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)