Share via

ICaptionServiceDescriptor::GetWideAspectRatio method (atscpsipparser.h)

  • Article

[The feature associated with this page, Microsoft TV Technologies, is a legacy feature. Microsoft strongly recommends that new code does not use this feature.]

This topic applies to Update Rollup 2 for Microsoft Windows XP Media Center Edition 2005 and later.

The GetWideAspectRatio method queries whether a caption service is formatted for wide-screen displays.

Syntax

HRESULT GetWideAspectRatio(
  [in]  BYTE bIndex,
  [out] BYTE *pbVal
);

Parameters

[in] bIndex

Zero-based index of the caption service. To get the number of caption services, call ICaptionServiceDescriptor::GetNumberOfServices.

[out] pbVal

Receives the wide_aspect_ratio:

Value Description
0 The caption service is formatted for a 4:3 aspect ratio.
1 The caption service is formatted for a 16:9 aspect ratio.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
 The method succeeded.
MPEG2_E_INCORRECT_DESCRIPTOR_TAG
 The table descriptor tag is incorrect.
MPEG2_E_MALFORMED_TABLE
 The PSIP table is not well formed.
MPEG2_E_OUT_OF_BOUNDS
 The bIndex parameter is out of range.

Requirements

Requirement Value
Target Platform Windows
Header atscpsipparser.h

See also

ICaptionServiceDescriptor Interface