MFCreateAudioRenderer function (mfidl.h)

Creates the Streaming Audio Renderer.

Syntax

HRESULT MFCreateAudioRenderer(
  [in]  IMFAttributes *pAudioAttributes,
  [out] IMFMediaSink  **ppSink
);

Parameters

[in] pAudioAttributes

A pointer to the IMFAttributes interface, which is used to configure the audio renderer. This parameter can be NULL. See Remarks.

[out] ppSink

Receives a pointer to the audio renderer's IMFMediaSink interface. The caller must release the interface.

Return value

If this function succeeds, it returns S_OK. Otherwise, it returns an HRESULT error code.

Remarks

To configure the audio renderer, set any of the following attributes on the IMFAttributes interface specified in the pAudioAttributes parameter.

Attribute Description
MF_AUDIO_RENDERER_ATTRIBUTE_ENDPOINT_ID The audio endpoint device identifier.
MF_AUDIO_RENDERER_ATTRIBUTE_ENDPOINT_ROLE The audio endpoint role.
MF_AUDIO_RENDERER_ATTRIBUTE_FLAGS Miscellaneous configuration flags.
MF_AUDIO_RENDERER_ATTRIBUTE_SESSION_ID The audio policy class.
MF_AUDIO_RENDERER_ATTRIBUTE_STREAM_CATEGORY The audio stream category.
MF_LOW_LATENCY Enables low-latency audio streaming.

Requirements

Requirement Value
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header mfidl.h
Library Mf.lib
DLL Mf.dll

See also

Media Foundation Functions

Streaming Audio Renderer