Method SetBoxPropertyData

proxyAudioDevice/ProxyAudioDevice.cpp:2147–2327

}

OSStatus ProxyAudioDevice::SetBoxPropertyData(AudioServerPlugInDriverRef inDriver,
                                              AudioObjectID inObjectID,
                                              pid_t inClientProcessID,
                                              const AudioObjectPropertyAddress *inAddress,
                                              UInt32 inQualifierDataSize,
                                              const void *inQualifierData,
                                              UInt32 inDataSize,
                                              const void *inData,
                                              UInt32 *outNumberPropertiesChanged,
                                              AudioObjectPropertyAddress outChangedAddresses[2]) {
#pragma unused(inClientProcessID, inQualifierDataSize, inQualifierData, inDataSize, inData)

    //    declare the local variables
    OSStatus theAnswer = 0;

    //    check the arguments
    FailWithAction(inDriver != gAudioServerPlugInDriverRef,
                   theAnswer = kAudioHardwareBadObjectError,
                   Done,
                   "SetBoxPropertyData: bad driver reference");
    FailWithAction(
        inAddress == NULL, theAnswer = kAudioHardwareIllegalOperationError, Done, "SetBoxPropertyData: no address");
    FailWithAction(outNumberPropertiesChanged == NULL,
                   theAnswer = kAudioHardwareIllegalOperationError,
                   Done,
                   "SetBoxPropertyData: no place to return the number of properties that changed");
    FailWithAction(outChangedAddresses == NULL,
                   theAnswer = kAudioHardwareIllegalOperationError,
                   Done,
                   "SetBoxPropertyData: no place to return the properties that changed");
    FailWithAction(inObjectID != kObjectID_Box,
                   theAnswer = kAudioHardwareBadObjectError,
                   Done,
                   "SetBoxPropertyData: not the box object");

    //    initialize the returned number of changed properties
    *outNumberPropertiesChanged = 0;

    //    Note that for each object, this driver implements all the required properties plus a few
    //    extras that are useful but not required. There is more detailed commentary about each
    //    property in the GetPlugInPropertyData() method.
    switch (inAddress->mSelector) {
        case kAudioObjectPropertyName:
            //    Boxes should allow their name to be editable
            {
                FailWithAction(inDataSize != sizeof(CFStringRef),
                               theAnswer = kAudioHardwareBadPropertySizeError,
                               Done,
                               "SetBoxPropertyData: wrong size for the data for kAudioObjectPropertyName");
                CFStringRef *newValue = (CFStringRef *)inData;

                FailWithAction((newValue == NULL || *newValue == NULL || CFGetTypeID(*newValue) != CFStringGetTypeID()),
                               theAnswer = kAudioHardwareIllegalOperationError,
                               Done,
                               "SetBoxPropertyData: bad value for kAudioObjectPropertyName");

                // See the comment in the switch case for 'kAudioObjectPropertyIdentify' to get a description of the
                // crazy hackery that is going on here.