In This Topic ▼

IltmmSampleTarget::GetAcceptedMediaType

Summary

Gets a copy of the media type accepted by the sample target object.

Syntax

#include "ltmm.h"

Language	Syntax
C	HRESULT IltmmSampleTarget_getAcceptedMediaType(pSampleTarget, ppMediaType)
C++	HRESULT GetAcceptedMediaType(ppMediaType)

Parameters

IltmmSampleTarget *pSampleTarget

Pointer to an IltmmSampleTarget interface that references the sample target object for which to get the accepted media type.

IltmmMediaTypeDisp **ppMediaType

Pointer to a variable that is updated with an IltmmMediaTypeDisp pointer. The IltmmMediaTypeDisp interface referenced by this pointer contains information on the accepted media type of the sample target.

Returns

Value	Meaning
S_OK	The function was successful.
<> S_OK	An error occurred. Refer to the Error Codes or the HRESULT error codes in the DirectShow documentation.

Comments

If the function succeeds, the caller must free the returned MediaType by calling the interface's Release function.

If the function succeeds, the caller must free the interface referenced by the MediaType parameter by calling the interface's Release function.

Multimedia objects negotiate the type of media data they will exchange. The accepted media type set by a sample target object indicates the type of media data that object can accept. Once a sample target object is associated with or added to a convert object for example, these two objects decide on the media type they will exchange. This is the connected media type. The connected media type can be obtained using the IltmmSampleTarget::GetConnectedMediaType.