AudioObjectGetPropertyData

Function AudioObjectGetPropertyData 

Source
pub unsafe extern "C-unwind" fn AudioObjectGetPropertyData(
    in_object_id: AudioObjectID,
    in_address: NonNull<AudioObjectPropertyAddress>,
    in_qualifier_data_size: u32,
    in_qualifier_data: *const c_void,
    io_data_size: NonNull<u32>,
    out_data: NonNull<c_void>,
) -> i32
Available on crate feature AudioHardware only.
Expand description

Queries an AudioObject to get the data of the given property and places it in the provided buffer.

Parameter inObjectID: The AudioObject to query.

Parameter inAddress: An AudioObjectPropertyAddress indicating which property is being queried.

Parameter inQualifierDataSize: A UInt32 indicating the size of the buffer pointed to by inQualifierData. Note that not all properties require qualification, in which case this value will be 0.

Parameter inQualifierData: A buffer of data to be used in determining the data of the property being queried. Note that not all properties require qualification, in which case this value will be NULL.

Parameter ioDataSize: A UInt32 which on entry indicates the size of the buffer pointed to by outData and on exit indicates how much of the buffer was used.

Parameter outData: The buffer into which the AudioObject will put the data for the given property.

Returns: An OSStatus indicating success or failure.

ยงSafety

  • in_address must be a valid pointer.
  • in_qualifier_data must be a valid pointer or null.
  • io_data_size must be a valid pointer.
  • out_data must be a valid pointer.