IDvdInfo2::GetCurrentSubpicture

  • Article
 
Microsoft DirectShow 9.0

IDvdInfo2::GetCurrentSubpicture

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(
  ULONG *pulStreamsAvailable,
  ULONG *pulCurrentStream,
  BOOL *pbIsDisabled
);

Parameters

pulStreamsAvailable

[out] Pointer to a variable of type ULONG that receives the number of available subpicture streams.

pulCurrentStream

[out] Pointer to a variable of type ULONG that receives the number of the currently selected subpicture stream.

pbIsDisabled

[out] Pointer to a variable of type BOOL that receives a value indicating whether the subpicture display is disabled; TRUE means it is disabled.

Return Values

Returns one of the following HRESULT values.

Return code Description
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

Header: Declared in Strmif.h; include Dshow.h.

Library: Use Strmiids.lib.

See Also