IDvdInfo2::GetCurrentSubpicture method

The GetCurrentSubpicture method retrieves the number of available subpicture streams in the current title, the currently selected subpicture stream number, and the state of the subpicture.

Syntax


HRESULT GetCurrentSubpicture(
  [out] ULONG *pulStreamsAvailable,
  [out] ULONG *pulCurrentStream,
  [out] BOOL  *pbIsDisabled
);

Parameters

pulStreamsAvailable [out]

Receives the number of available subpicture streams.

pulCurrentStream [out]

Receives the number of the currently selected subpicture stream.

pbIsDisabled [out]

Receives a Boolean value that indicates whether the subpicture display is disabled; TRUE means it is disabled.

Return value

Returns one of the following HRESULT values.

Return codeDescription
S_OK

Success.

E_POINTER

Invalid argument.

VFW_E_DVD_INVALIDDOMAIN

The DVD Navigator is not initialized or not in the Title domain.

 

Remarks

DVD content authors can specify that any particular subpicture stream on a disc is forcedly activated, meaning that the DVD authors require this stream to display whether the viewer wants to watch it or not. The DVD Navigator complies with all such commands from the disc, meaning that forcedly activated streams are displayed even if the application has disabled subpicture display with the IDvdControl2::SetSubpictureState method.

Requirements

Minimum supported client

Windows XP [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Strmif.h (include Dshow.h)

Library

Strmiids.lib

See also

DVD Applications
EC_DVD_SUBPICTURE_STREAM_CHANGE
Error and Success Codes
IDvdInfo2 Interface

 

 

Show: