Platform SDK: TAPI

ITAMMediaFormat::put_MediaFormat

Sets the media format.

HRESULT put_MediaFormat(
  const AM_MEDIA_TYPE *pmt
);

Parameters

pmt
[in] Pointer to AM_MEDIA_TYPE structure.

Return Values

Value Meaning
S_OK Method succeeded.
E_OUTOFMEMORY Insufficient memory exists to perform the operation.

Remarks

On addresses where a variety of formats are supported (such as Wave MSP addresses, which are used on most modems and voice boards), this call is mandatory or the terminal will not be able to connect.

For other addresses, such as those implemented over IP, the format may be fixed/predetermined. In that case, this call will fail if the format is not the same as the predetermined format. To retrieve such a predetermined format, an application can use get_MediaFormat.

Requirements

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

See Also

ITAMMediaFormat, get_MediaFormat, Terminal Object, AM_MEDIA_TYPE structure