CreateAudioMediaTypeFromUncompressedAudioFormat function (audiomediatype.h)

The CreateAudioMediaTypeFromUncompressedAudioFormat function uses the information provided in the UNCOMPRESSEDAUDIOFORMAT structure to create a media type object that describes the audio format.

Syntax

HRESULT CreateAudioMediaTypeFromUncompressedAudioFormat(
  const UNCOMPRESSEDAUDIOFORMAT *pUncompressedAudioFormat,
  IAudioMediaType               **ppIAudioMediaType
);

Parameters

pUncompressedAudioFormat

Specifies a pointer to an UNCOMPRESSEDAUDIOFORMAT structure.

ppIAudioMediaType

Specifies a pointer to an IAudioMediaType interface.

Return value

The CreateAudioMediaTypeFromUncompressedAudioFormat function returns S_OK if the call to the function is successful. Otherwise, it returns an appropriate HRESULT error code.

Remarks

When you implement custom audio system effects, the CreateAudioMediaTypeFromUncompressedAudioFormat function works with IAudioSystemEffectsCustomFormats::GetFormat to represent a custom audio data format and to provide information about the custom format.

Requirements

   
Minimum supported client Available in Windows Vista and later versions of Windows.
Target Platform Desktop
Header audiomediatype.h (include Audiomediatype.h)
IRQL N/A

See also

IAudioMediaType

IAudioSystemEffectsCustomFormats::GetFormat

UNCOMPRESSEDAUDIOFORMAT