Platform SDK: TAPI

ITMedia::get_FormatCodes

Gets the list of media payload format codes. The variant returns a SAFEARRAY of BSTRs. Each BSTR within that array is a format code string.

HRESULT get_FormatCodes(
  VARIANT *pVal
);

Parameters

pVal
[out] Array of media payload format codes.

Return Values

Value Meaning
S_OK Method succeeded.
E_POINTER The pVal parameter is not a valid pointer.
E_OUTOFMEMORY Insufficient memory exists to perform the operation.
E_FAIL Unspecified error.
E_NOTIMPL This method is not yet implemented.

Remarks

When a list of payload formats is given, this implies that all of these formats may be used in the session, but the first of these formats is the default format for the session. When the transport protocol is RTP, the format codes are RTP payload types.

Requirements

  Windows NT/2000: Requires Windows 2000.
  Version: Requires TAPI 3.0 or later.
  Header: Declared in Sdpblb.h.
  Library: Use Sdpblbid.lib.

See Also

ITMedia, ITMedia::put_FormatCodes