IltmmCapture::TogglePreview

#include "ltmm.h"

C Syntax

HRESULT IltmmCapture_TogglePreview(pCapture)

C++ Syntax

HRESULT TogglePreview()

 

IltmmCapture *pCapture;

/* pointer to an interface */

Toggles the state of the preview mode.

Parameter

Description

pCapture

Pointer to an IltmmCapture interface.

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 is a convenient function to toggle the preview mode on and off.

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.

See Also

Elements:

IltmmCapture::get_Preview, IltmmCapture::put_Preview

Topics:

Multimedia Function Group

Example

For a C example, refer to Advanced Capture Application for C.

For a C++ example, refer to Advanced Capture Application for C++.