Microsoft DirectX 9.0

ITuningSpace::get_DefaultPreferredComponentTypes

The get_DefaultPreferredComponentTypes method returns an list of the default preferred component types for this tuning space.

Syntax

HRESULT get_DefaultPreferredComponentTypes(
    IComponentTypes** ppComponentTypes
    );

Parameters

ppComponentTypes

[out] Address of a variable that receives an IComponentTypes interface pointer. Use this interface to enumerate the component types. The caller must release the interface.

Return Values

Returns S_OK if successful. If the method fails, error information can be retrieved using the standard COM IErrorInfo interface.

Remarks

A component is a stream within the program. An example of a preferred component type would be an audio stream in English. When multiple components are available, the Tuner attempts to play the preferred ones first.

If the tuning space does not have any default preferred types, this method succeeds but returns the value NULL in the ppComponentTypes parameter. Check for a NULL value before attempting to dereference the pointer.

See Also