Previous Book Contents Book Index Next

Inside Macintosh: Sound /
Chapter 6 - Audio Components / Audio Components Reference
Audio Component-Defined Routines / Managing the Mute State


Legacy Documentclose button

Important: Inside Macintosh: Sound is deprecated as of Mac OS X v10.5. For new audio development in Mac OS X, use Core Audio. See the Audio page in the ADC Reference Library.

AudioSetMute

An audio component can implement the AudioSetMute function. The Sound Manager calls this function to set the current mute state of an audio port.

pascal ComponentResult AudioSetMute (ComponentInstance ac, 
                                       short whichChannel, 
                                       short mute);
ac
A component instance that identifies your audio component.
whichChannel
The channel or channels whose mute state you should set.
mute
The desired mute state of the specified channel.
DESCRIPTION
Your AudioSetMute function is called by the Sound Manager to set the mute state of one or more channels of an audio port. See the description of the AudioGetMute function for the values of the whichChannel and mute parameters.

RESULT CODES
Your AudioSetMute function should return noErr if successful or an appropriate result code otherwise. In particular, if your audio component doesn't support software control of mute states, AudioSetMute should return unImpErr.


Previous Book Contents Book Index Next

© Apple Computer, Inc.
2 JUL 1996