IltmmPlay::get_AutoScrub

Include

#include "ltmm.h"

Syntax

C Syntax

HRESULT IltmmPlay_get_AutoScrub(pPlay, pVal)

C++ Syntax

HRESULT get_AutoScrub(pVal)

 

IltmmPlay *pPlay;

pointer to an interface

VARIANT_BOOL *pVal;

pointer to a variable

Summary

Retrieves a setting (the current automatic scrub setting) that indicates whether a frame is forced to the renderer while stopped.

Parameters

Parameter

Description

pPlay

Pointer to an IltmmPlay interface.

pVal

Pointer to a variable that determines the current automatic scrub setting. Possible values are:

Values

Meaning

VARIANT_TRUE

The current automatic scrub is set. The play module will attempt to force a frame to the renderer when stopped.

VARIANT_FALSE

The current automatic scrub is not set. The play module will not force a frame to the renderer when stopped.

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.

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

IltmmPlay::put_AutoScrub

Multimedia Function Groups

Example

For a C example, refer to the Set Player Source with Callbacks for C.

For a C++ example, refer to the Set Player Source with Callbacks for C++.

Help Version 20.0.2020.4.2
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2020 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Multimedia C API Help