In This Topic ▼

IltmmSampleTarget::get_TargetFormat

Summary

Gets the target format accepted by the sample target object.

Syntax

#include "ltmm.h"

Language	Syntax
C	HRESULT IltmmSampleTarget_get_TargetFormat(pSampleTarget, pVal);
C++	HRESULT get_TargetFormat(pVal);

Parameters

IltmmSampleTarget *pSampleTarget

Pointer to an IltmmSampleTarget interface.

long *pVal

Pointer to a variable that will receive the target format. Can be any value from the ltmmSampleTarget_TargetFormat enumeration.

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

By default, the value of this property is ltmmSampleTarget_TargetFormat_Undefined. If you assign a value to the TargetFormat property that matches your expected final output format, then only media types that are accepted by the assigned format will be allowed. The AcceptedMediaType values are still honored, however, only the parts of the AcceptedMediaType that are not specified (GUID_NULL) are compared with the TargetFormat. So, you can still force a pin to only accept a major type of Video, and have the rest depend on the target format, by simply assigning an AcceptedMediaType with only the major type of video defined.