IWMEncAudienceObj::get_VideoHeight

Windows Media Encoder SDK banner art

The get_VideoHeight method retrieves the output height of the video image.

Syntax

HRESULT get_VideoHeight(
  short  iRenderSiteIndex,
  long*  plHeight
);

Parameters

iRenderSiteIndex

[in]  short containing the audience stream index. Because an audience can only contain one stream of each type, iRenderSiteIndex must be zero.

plHeight

[out]  Pointer to a long indicating the output height of the video image, ranging from 16 to 2000 pixels. A 0 value indicates that the output size matches the input size.

Return Values

If the method succeeds, it returns S_OK. If it fails, it supports the IErrorInfo interface and returns an HRESULT error code.

Return code Number Description
E_POINTER 0x80004003 The pointer to the height is NULL.

Remarks

A 0 indicates the same height as the input.

Requirements

Header: wmencode.h

Library: wmenc.exe

See Also