IltmmPlay::put_AutoScrub

Summary

Specifies whether to automatically scrub the play object (force a frame to the renderer when stopped).

Syntax

#include "ltmm.h"

Language Syntax
C HRESULT IltmmPlay_put_AutoScrub(pPlay, newVal)
C++ HRESULT put_AutoScrub(newVal)

Parameters

IltmmPlay *pPlay

Pointer to an IltmmPlay interface.

VARIANT_BOOL newVal

Flag that determines whether to automatically scrub:

Value Meaning
VARIANT_TRUE Enable scrubbing and force a frame to the renderer when stopped.
VARIANT_FALSE Disable scrubbing and prevent forcing a frame to the renderer when stopped.

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

The default value is VARIANT_TRUE. Setting this property to VARIANT_FALSE prevents any data processing when the source is assigned. This is useful for assigning callbacks without missing any data. You can call IltmmPlay::Scrub to manually force a frame to the renderer.

Required DLLs and Libraries

Platforms

Win32, x64.

See Also

Functions

Topics

Example

Language Example
C Set Player Source with Callbacks
C++ Set Player Source with Callbacks
Help Version 23.0.2024.2.29
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2024 LEAD Technologies, Inc. All Rights Reserved.

LEADTOOLS Multimedia C API Help

Products | Support | Contact Us | Intellectual Property Notices
© 1991-2023 LEAD Technologies, Inc. All Rights Reserved.