IltmmVideoFormat::get_Compression

#include "ltmm.h"

C Syntax

HRESULT IltmmVideoFormat__get_Compression(pVideoFormat, pVal)

C++ Syntax

HRESULT get_Compression(pVal)

 

IltmmVideoFormat *pVideoFormat;

/* pointer to an interface */

long *pVal;

/* pointer to a variable */

Retrieves the video compression.

Parameter

Description

pVideoFormat

Pointer to an IltmmVideoFormat Interface.

pVal

Pointer to a variable that receives the video compression information, contained in the biCompression field of the BITMAPINFOHEADER structure. For more information on the BITMAPINFOHEADER structure, refer to the Raster API help file (Ltdlln.hlp).

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

Call IltmmVideoFormat::get_Height and IltmmVideoFormat::get_Width to get the height and width of the video format.

To get the bit count for the video format, call IltmmVideoFormat::get_BitCount.

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:

IltmmVideoFormat Interface, IltmmVideoFormat::get_Height, IltmmVideoFormat::get_Width, IltmmVideoFormat::get_BitCount

Topics:

Multimedia Function Group

Example

For a C example, refer to IltmmVideoFormats::get_Count Example for C.

For a C++ example, refer to IltmmVideoFormats::get_Count Example for C++.