IDvdControl2::PlayChapter method (strmif.h)

Article
07/27/2023

[The feature associated with this page, DirectShow, is a legacy feature. It has been superseded by MediaPlayer, IMFMediaEngine, and Audio/Video Capture in Media Foundation. Those features have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use MediaPlayer, IMFMediaEngine and Audio/Video Capture in Media Foundation instead of DirectShow, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The PlayChapter method starts playback from the specified chapter in the current title.

Syntax

HRESULT PlayChapter(
  [in]  ULONG   ulChapter,
  [in]  DWORD   dwFlags,
  [out] IDvdCmd **ppCmd
);

Parameters

[in] ulChapter

Value that specifies the chapter in the current title where the DVD Navigator will start playback; this value must be from 1 through 999.

[in] dwFlags

Bitwise OR of one or more flags from the DVD_CMD_FLAGS enumeration, specifying how to synchronize the command.

[out] ppCmd

Receives a pointer to an IDvdCmd object that can be used to synchronize DVD commands. The caller must release the interface. This parameter can be NULL. For more information, see Synchronizing DVD Commands.

Return value

Returns one of the following values.

Return code	Description
S_OK	Success.
VFW_E_DVD_OPERATION_INHIBITED	UOP control prohibits the operation.
E_INVALIDARG	Invalid argument.

Remarks

The DVD Navigator begins playback at the specified chapter and continues to the subsequent chapters. Use IDvdControl2::PlayChaptersAutoStop to play the current chapter only.

The following table shows the Annex J command name to which this method name corresponds, and the domains in which this method is valid.

This method is demonstrated in the DVDSample application in CDvdCore::PlayChapter.

Annex J Command Name	Valid Domains
PTT_Search	DVD_DOMAIN_Title

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	strmif.h (include Dshow.h)
Library	Strmiids.lib