ITAMMediaFormat::put_MediaFormat method (tapi3.h)

The put_MediaFormat method sets the media format.

Syntax

HRESULT put_MediaFormat(
  [in] const AM_MEDIA_TYPE *pmt
);

Parameters

[in] pmt

Pointer to AM_MEDIA_TYPE structure. 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.

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

Requirement Value
Target Platform Windows
Header tapi3.h (include Tapi3.h)
Library Uuid.lib
DLL Tapi3.dll

See also

ITAMMediaFormat

Terminal Object

get_MediaFormat