IWMReader::GetOutputFormat method

The GetOutputFormat method retrieves the supported formats for a specified output media stream.

Syntax


HRESULT GetOutputFormat(
  [in]  DWORD               dwOutputNumber,
  [in]  DWORD               dwFormatNumber,
  [out] IWMOutputMediaProps **ppProps
);

Parameters

dwOutputNumber [in]

DWORD containing the output number.

dwFormatNumber [in]

DWORD containing the format number.

ppProps [out]

Pointer to a pointer to an IWMOutputMediaProps interface. This interface belongs to an output media properties object created by a successful call to this method. The properties exposed by this interface represent formats than can be supported by the specified output; the current properties set for the output can be obtained by calling IWMReader::GetOutputProps.

Return value

If the method succeeds, it returns S_OK. If it fails, it returns an HRESULT error code.

Remarks

The Windows Media codecs can deliver media samples for a stream in a number of formats. For example, the Windows Media Video 9 codec can deliver samples in various RGB or YUV formats. You can use this method in conjunction with IWMReader::GetOutputFormatCount to loop through the available formats and find the one you need.

To use a format returned by this method, you must call IWMReader::SetOutputProps.

This method is synchronous and does not result in any messages being sent to the status callback.

Requirements

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Version

Windows Media Format 7 SDK, or later versions of the SDK

Header

Wmsdkidl.h (include Wmsdk.h)

Library

Wmvcore.lib;
WMStubDRM.lib (if you use DRM)

See also

IWMReader Interface

 

 

Show: