IltmmTargetFormat::put_SinkSubType

#include "ltmm.h"

C Syntax

HRESULT IltmmTargetFormat_put_SinkSubType(pTargetFormat, newVal)

C++ Syntax

HRESULT put_SinkSubType(newVal)

 

IltmmTargetFormat *pTargetFormat;

/* pointer to an interface */

BSTR newVal;

/* string */

Assigns the sink's media subtype.

Parameter

Description

pTargetFormat

Pointer to an IltmmTargetFormat interface.

newVal

Character string containing the sink's media subtype.

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

This function assigns the Sink's media subtype. The string must contain a formatted Globally Unique Identifier (GUID) of the form {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For more information on the available GUIDs, refer to the DirectShow documentation.

If the value is undefined (empty string), then no media subtype will be assigned to the Sink.

Attempting to set this value on a ReadOnly item will result in an error.

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:

IltmmTargetFormat::get_Name

Topics:

Multimedia Function Group

Example

For an example, refer to Selecting ltmmCapture Object TargetFormats for C.

For an example, refer to Selecting ltmmCapture Object TargetFormats for C++.

For an example, refer to Selecting ltmmConvert Object TargetFormats for C.

For an example, refer to Selecting ltmmConvert Object TargetFormats for C++.