AudioStreamGetProperty

Function AudioStreamGetProperty 

Source
pub unsafe extern "C-unwind" fn AudioStreamGetProperty(
    in_stream: AudioStreamID,
    in_channel: u32,
    in_property_id: AudioDevicePropertyID,
    io_property_data_size: NonNull<u32>,
    out_property_data: NonNull<c_void>,
) -> i32
๐Ÿ‘ŽDeprecated
Available on crate features AudioHardware and AudioHardwareDeprecated only.
Expand description

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

Note that the same functionality is provided by the function AudioObjectGetPropertyData().

Parameter inStream: The AudioStream to query.

Parameter inChannel: The channel of the property to query where 0 is the main channel.

Parameter inPropertyID: The AudioDevicePropertyID of the property to query.

Parameter ioPropertyDataSize: 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 outPropertyData: The buffer into which the object will put the data for the given property.

Returns: An OSStatus indicating success or failure.

ยงSafety

  • io_property_data_size must be a valid pointer.
  • out_property_data must be a valid pointer.