Microsoft DirectX 8.1 (C++)

IBasicVideo2::GetPreferredAspectRatio

The GetPreferredAspectRatio method retrieves a pair of dimensionless values whose ratio defines the movie's preferred aspect ratio.

Syntax

HRESULT GetPreferredAspectRatio (
  long *plAspectX,
  long *plAspectY
);

Parameters

plAspectX

[out] Pointer to a value that indicates the movie's x-axis aspect ratio.

plAspectY

[out] Pointer to a value that indicates the movie's y-axis aspect ratio.

Return Values

Returns an HRESULT value. Possible values include the following.

Return code Description
S_OK Success.
E_INVALIDARG One or both of the parameters are invalid.
E_NOINTERFACE The renderer does not implement IBasicVideo2.

See Also