MF_AUDIO_RENDERER_ATTRIBUTE_ENDPOINT_ROLE attribute

Specifies the audio endpoint role for the audio renderer.

Data type

UINT32

Remarks

You can use this attribute to configure the audio renderer. The usage depends on which function you call to create the audio renderer:

• MFCreateAudioRenderer: Set this attribute using the IMFAttributes interface pointer specified in the pAudioAttributes parameter.
• MFCreateAudioRendererActivate: Set this attribute using the IMFActivate interface pointer retrieved in the ppActivate parameter. Set the attribute before calling IMFActivate::ActivateObject.

An audio endpoint device is a hardware device that lies at one end of an audio data path, such as a headphone or a speaker.

If this attribute is set, the audio renderer uses the default audio device for the specified role. The value of this attribute is a member of the ERole enumeration, which is defined in the header file mmdeviceapi.h. For more information, see the Core Audio API documentation. If this attribute is not set, the audio renderer uses the default endpoint device.

If this attribute is set, do not set the MF_AUDIO_RENDERER_ATTRIBUTE_ENDPOINT_ID attribute. If both attributes are set, a failure will occur when the audio renderer is created.

The GUID constant for this attribute is exported from mfuuid.lib.

Requirements

See also

Alphabetical List of Media Foundation Attributes

Audio Renderer Attributes

IMFAttributes::GetUINT32

IMFAttributes::SetUINT32

Streaming Audio Renderer