Edit

Share via

IAudioEndpoint::GetFrameFormat method (audioengineendpoint.h)

  • Article

The GetFrameFormat method retrieves the format of the audio endpoint.

Syntax

HRESULT GetFrameFormat(
  [out] WAVEFORMATEX **ppFormat
);

Parameters

[out] ppFormat

Receives a pointer to a WAVEFORMATEX structure that contains the format information for the device that the audio endpoint represents. The implementation must allocate memory for the structure by using CoTaskMemAlloc. The caller must free the buffer by using CoTaskMemFree. For information about CoTaskMemAlloc and CoTaskMemFree, see the Windows SDK documentation.

Return value

If the method succeeds, it returns S_OK.

Remarks

This method must not be called from a real-time processing thread.

The Remote Desktop Services AudioEndpoint API is for use in Remote Desktop scenarios; it is not for client applications.

Requirements

Requirement Value
Minimum supported client Windows 7
Minimum supported server Windows Server 2008 R2
Target Platform Windows
Header audioengineendpoint.h

See also

IAudioEndpoint