Microsoft DirectX 9.0

IDvdInfo2::IsSubpictureStreamEnabled

The IsSubpictureStreamEnabled method determines if the specified subpicture stream is enabled in the current title.

Syntax

HRESULT IsSubpictureStreamEnabled(
  ULONG ulStreamNum,
  BOOL *pbEnabled
);

Parameters

ulStreamNum

[in] Subpicture stream number to test.

pbEnabled

[out] Pointer to a variable of type BOOL that receives a value of TRUE if the audio stream is enabled, or FALSE otherwise.

Return Values

Returns one of the following HRESULT values.

Return code Description
S_OK Success.
E_INVALIDARG Invalid argument.
E_UNEXPECTED The DVD Navigator is not initialized.

Remarks

A DVD can have up to 32 separate subpicture streams, although typically not all the streams will be enabled for each title. Use IsSubpictureStreamEnabled to determine whether a particular stream is enabled for the current title, and then call IDvdControl2::SelectSubpictureStream to select one of the enabled streams.

See Also