IltmfPlay::SaveStillBitmap

#include "ltmf.h"

C Syntax

HRESULT IltmfPlay_SaveStillBitmap(pPlay, filename, format, quality, flags, timeout)

C++ Syntax

HRESULT SaveStillBitmap(filename, format, qualty, flags, timeout)

IltmfPlay *pPlay;

pointer to an interface

BSTR filename;

file name

long format;

format

long quality;

compression quality

long flags;

flags

long timeout;

timeout

Saves a snapshot from the running stream to a file, as a bitmap.

Parameter

Description

pPlay

Pointer to an IltmfPlay interface.

filename

Character string containing the name of the file in which to save the bitmap.

format

Value that represents the output file format. For a list of possible values, refer to ltmfPlay_StillFormat Constants.

quality

Value that represents the compression quality. This is used only when the Format parameter is ltmfPlay_StillFormat_CMP.

flags

Not used. Pass 0.

timeout

The timeout period in milliseconds. The function will fail if it was not able to take a sample in the specified time. Use 1 to wait indefinitely until a sample is snapped.

Returns

S_OK

The function was successful.

<> S_OK

An error occurred. Refer to the Error Codes or the HRESULT error codes in the MediaFoundation documentation.

Comments

This method blocks (does not return) until the timeout occurs or the sample is snapped.

The following functions can also be used to obtain still images:

IltmfPlay::GetStillDIB

IltmfPlay::GetStillPicture

IltmfPlay::SaveStillDIB

Required DLLs and Libraries

LTMF

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

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

LEADTOOLS Media Foundation C API Help
Introduction
Version History
Getting Started
Copyright notice
Installation Directory
Media Foundation Files You Must Include With Your Application (Redistributables)
LEADTOOLS Media Foundation Features
Programming with LEADTOOLS Media Foundation
Appendix
LEADTOOLS Licensing