AudioStreamSetProperty

objc2_core_audio

Function AudioStreamSetProperty 

Source 
pub unsafe extern "C-unwind" fn AudioStreamSetProperty(
    in_stream: AudioStreamID,
    in_when: *const AudioTimeStamp,
    in_channel: u32,
    in_property_id: AudioDevicePropertyID,
    in_property_data_size: u32,
    in_property_data: NonNull<c_void>,
) -> i32
đź‘ŽDeprecated
Available on crate features AudioHardware and AudioHardwareDeprecated and objc2-core-audio-types only.
Expand description

Tells the AudioStream object to change the value of the given property using the provided data.

Note that the value of the property should not be considered changed until the HAL has called the listeners as many properties values are changed asynchronously. Also note that the same functionality is provided by the function AudioObjectSetPropertyData().

Parameter inStream: The AudioStream to change.

Parameter inWhen: A pointer to an AudioTimeStamp that says when to change the property’s value relative to the device’s time base. NULL means execute the change immediately.

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

Parameter inPropertyID: The AudioDevicePropertyID of the property to change.

Parameter inPropertyDataSize: A UInt32 indicating the size of the buffer pointed to by inData.

Parameter inPropertyData: The buffer containing the data to be used to change the property’s value.

Returns: An OSStatus indicating success or failure.

§Safety

  • in_when must be a valid pointer or null.
  • in_property_data must be a valid pointer.