IltmmSampleTarget::GetAcceptedMediaType

#include "ltmm.h"

C Syntax

HRESULT IltmmSampleTarget_getAcceptedMediaType(pSampleTarget, MediaType)

C++ Syntax

HRESULT GetAcceptedMediaType(MediaType)

 

IltmmSampleTarget * pSampleTarget;

/* pointer to an interface */

IltmmMediaTypeDisp ** MediaType;

/* pointer to a pointer */

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

Parameter

Description

pSampleTarget

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

MediaType

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

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.

Required DLLs and Libraries

LTMM

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64

See Also

Elements:

IltmmSampleTarget::SetAcceptedMediaType, IltmmSampleTarget::GetConnectedMediaType, IltmmSampleTarget::GetSample

Topics:

Multimedia Function Group

 

IltmmSampleTarget Interface

 

ltmmSampleTarget Object

 

IltmmMediaTypeDisp Interface

 

ltmmMediaType Object

Example

For a C example, refer to Splitting an AVI File into Multiple Bitmaps Using ltmmSampleTarget for C.

For a C++ example, refer to Splitting an AVI File into Multiple Bitmaps Using ltmmSampleTarget for C++.