ITFormatControl::GetCurrentFormat method

[ This method is not available for use in Windows Vista, Windows Server 2008, and subsequent versions of the operating system. The RTC Client API provides similar functionality.]

The GetCurrentFormat method retrieves the media format of the current stream.

Syntax

HRESULT GetCurrentFormat(
  [out] AM_MEDIA_TYPE **ppMediaType
);

Parameters

ppMediaType [out]

Pointer to an AM_MEDIA_TYPE descriptor of the terminal format. For more information on AM_MEDIA_TYPE, see the DirectX documentation.

Return value

This method can return one of these values.

Return code Description
S_OK
Method succeeded.
E_OUTOFMEMORY
Insufficient memory exists to perform the operation.

Requirements

Requirement Value
TAPI version
Requires TAPI 3.1
Header
Ipmsp.h
Library
Uuid.lib
DLL
Tapi3.dll

See also

ITFormatControl