ITFormatControl::GetStreamCaps 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 GetStreamCaps method retrieves the capabilities associated with a given format index.

Syntax

HRESULT GetStreamCaps(
  [in]  DWORD                   dwIndex,
  [out] AM_MEDIA_TYPE           **ppMediaType,
  [out] TAPI_STREAM_CONFIG_CAPS *pStreamConfigCaps,
  [out] BOOL                    *pfEnabled
);

Parameters

dwIndex [in]

Index of the format being probed.

ppMediaType [out]

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

pStreamConfigCaps [out]

A TAPI_STREAM_CONFIG_CAPS structure that gives detailed information concerning stream capabilities.

pfEnabled [out]

Indicates whether the format associated with the current index is enabled.

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

TAPI_STREAM_CONFIG_CAPS