Edit

Share via

MFCreateAudioRendererActivate function (mfidl.h)

  • Article

Creates an activation object for the Streaming Audio Renderer.

Syntax

HRESULT MFCreateAudioRendererActivate(
  [out] IMFActivate **ppActivate
);

Parameters

[out] ppActivate

Receives a pointer to the IMFActivate interface. Use this interface to create the audio renderer. 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 create the audio renderer, call IMFActivate::ActivateObject on the retrieved IMFActivate pointer.

Note  To avoid a memory leak, call IMFActivate::ShutdownObject before releasing the final reference to the audio renderer or the audio renderer activate object.
 
To configure the audio renderer, set any of the following attributes on the IMFActivate object before calling ActivateObject. (If you are using the Media Session, the Media Session automatically calls ActivateObject when you queue the topology.)
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 | UWP apps]
Minimum supported server Windows Server 2008 [desktop apps | UWP apps]
Target Platform Windows
Header mfidl.h
Library Mf.lib
DLL Mf.dll

See also

Activation Objects

Media Foundation Functions

Streaming Audio Renderer