Contents

SetAvailableStreamFormats

Sets the available stream formats to an array of audio stream basic descriptions.

Declaration

kern_return_t SetAvailableStreamFormats(const IOUserAudioStreamBasicDescription *in_formats, uint32_t in_num_formats);

Parameters

  • in_formats:

    A pointer to a buffer of IOUserAudioStreamBasicDescription instances, with a size of in_num_formats.

  • in_num_formats:

    The number of stream descriptions in in_formats.

Return Value

kIOReturnSuccess on success, or another value if an error occurs. For a list of error codes, see Error Codes.

Discussion

If successful, changing the available formats sends a notification to the host to update the object state.

This method synchronizes by using the work queue created by the object.

See Also

Working with Stream Formats