Share via


MSVidWebDVD Object

This topic applies to Windows XP Service Pack 1 or later.

The methods, properties, and events of the MSVidWebDVD object enable an application to control all aspects of DVD-Video navigation and playback, and to retrieve information from the disc. The MSVidWebDVD object does not perform the actual graph building or running; that is handled by the MSVidCtl object, which uses the DVD Navigator filter to perform the actual DVD control. Use MSVidCtl to control larger actions, such as stop, run, and pause, but use the MSVidWebDVD object to control more specific details such as the play rate, displaying menus or activating buttons. When methods overlap, check the documentation, or try using the MSVidCtl method first.

Note  Neither Windows XP nor the DirectX SDK offer an MPEG-2 decoder for writing DVD applications. Many DVD hardware providers offer hardware or software decoding options, and many DVDs come packaged with a DVD decoder.

The MSVidWebDVD methods and properties act on the current playback state. To save and retrieve persistent application-specific information in the registry, such as default language or default parental level, use the corresponding methods in the MSVidWebDVDAdm object.

The following tables list the MSVidWebDVD properties and methods, grouped by functionality. Certain methods are not implemented or should be called from the MSVidCtl, as indicated.

Controlling Playback

Method or Property Description
Eject Ejects or inserts a disc from or into the drive.
PlayAtTimeInTitle Starts playback at the specified time within the specified title.
PlayAtTime Starts playback in the current title at the specified time.
PlayChapterInTitle Plays the specified chapter in the specified title.
PlayChaptersAutoStop Starts playback at the specified chapter in the specified title, for the number of chapters specified.
PlayChapter Starts playback from the specified chapter in the current title.
PlayNextChapter Starts playback from the next chapter in the current title.
PlayPeriodInTitleAutoStop Starts playback at the specified time in the specified title until the specified stop time.
PlayPrevChapter Starts playback from the previous chapter in the current title.
PlayTitle Starts playback at the beginning of the specified title.
ReplayChapter Starts playback at the beginning of the current chapter.
Resume Resumes playback after a menu has been displayed.
StillOff Resumes playback, canceling still mode.

Menus and Buttons

Method or Property Description
ActivateAtPosition Activates the menu button at the specified position.
ActivateButton Activates the selected menu button.
ButtonsAvailable Retrieves the total number of buttons on the current menu.
CurrentButton Retrieves the number of the selected button.
DefaultMenuLanguage Retrieves the default menu language from the disc.
ButtonAtPosition Retrieves the number of the button at the specified coordinates without selecting or activating it.
ButtonRect Not implemented.
ReturnFromSubmenu Returns display from a submenu to its parent menu, or to the current title if the menu is a top-level menu.
SelectAndActivateButton Selects and activates the specified button.
SelectAtPosition Selects the menu button at the specified position.
SelectLeftButton Selects the left directional button from the displayed menu.
SelectLowerButton Selects the lower directional button from the displayed menu.
SelectRightButton Selects the right directional button from the displayed menu.
SelectUpperButton Selects the upper directional button from the displayed menu.
ShowMenu Displays the specified menu on the screen.

Audio Stream

Method or Property Description
AudioLanguage Retrieves a human-readable string indicating the language of the specified audio stream.
AudioStreamsAvailable Retrieves the number of audio streams available in the current title.
CurrentAudioStream Sets or retrieves the number of the enabled audio stream.
DefaultAudioLanguage Retrieves a number representing the default audio language set in SelectDefaultAudioLanguage.
DefaultAudioLanguageExt Retrieves a number representing the default audio language extension set in SelectDefaultAudioLanguage.
IsAudioStreamEnabled Retrieves a value indicating whether the specified audio stream is enabled in the current title.
SelectDefaultAudioLanguage Sets the current default audio language in the DVD Navigator filter.

Subpicture Stream

Method or Property Description
CurrentSubpictureStream Retrieves the selected subpicture stream.
DefaultSubpictureLanguage Retrieves the default subpicture language as a human-readable string set in SelectDefaultSubpictureLanguage.
DefaultSubpictureLanguageExt Retrieves the default subpicture language extension set in SelectDefaultSubpictureLanguage.
SubpictureLanguage Retrieves the language for the specified subpicture stream as a human-readable string.
IsSubpictureStreamEnabled Retrieves a value indicating whether the specified subpicture stream is enabled in the current title.
PreferredSubpictureStream Sets or retrieves the user's preferred subpicture stream for the current viewing session.
SelectDefaultSubpictureLanguage Sets the current default subpicture language.
SubpictureOn Sets or retrieves the current subpicture state (on or off).
SubpictureStreamsAvailable Retrieves the number of subpicture streams available in the current title.

Angle Blocks

Method or Property Description
AnglesAvailable Retrieves the number of angles available.
CurrentAngle Sets or retrieves the current angle in an angle block.

Karaoke Audio

Method or Property Description
KaraokeChannelAssignment Retrieves a value that indicates how the karaoke channels are assigned to different speakers.
KaraokeChannelContent Retrieves a value that indicates the type of content in the specified karaoke channel in the specified stream.
KaraokeAudioPresentationMode Sets or retrieves the right-left speaker mix for the auxiliary karaoke channels.

Text Strings

Method or Property Description
DVDTextLanguageLCID Retrieves the locale identifier (LCID) for the specified text language block.
DVDTextNumberOfLanguages Retrieves the number of text languages available in the current DVD directory.
DVDTextNumberOfStrings Retrieves the number of text strings available for the specified language.
DVDTextString Retrieves the specified text string from the disc.
DVDTextStringType Retrieves a value that indicates the type of information contained in the specified DVD text string.
LanguageFromLCID Retrieves a human-readable string when given a primary language identifier (ID).

Parental Management

Method or Property Description
AcceptParentalLevelChange Instructs the DVD Navigator filter to accept or reject the new temporary parental management level.
PlayerParentalCountry Retrieves the current country/region as set in the DVD Navigator filter.
PlayerParentalLevel Retrieves the parental management level set in the DVD Navigator filter.
TitleParentalLevels Retrieves the parental management level for the specified title.
NotifyParentalLevelChange Enables or disables the event handling for temporary parental management level commands.
SelectParentalCountry Sets the specified parental country/region for subsequent playback.
SelectParentalLevel Sets the specified parental level for subsequent playback.

Disc and Playback Information

Method or Property Description
CurrentChapter Retrieves the number of the chapter currently playing.
CurrentDiscSide Retrieves the current side of the DVD.
CurrentDomain Retrieves the DVD domain that the DVD Navigator filter is in.
CurrentTime Retrieves the current playback time.
CurrentTitle Retrieves the number of the title currently playing.
CurrentVolume Retrieves the volume number for the current root directory.
DVDDirectory Retrieves or sets the root directory of the current DVD volume.
DVDTimeCode2bstr Retrieves a string indicating the current time on the disc.
DVDUniqueID Retrieves a system-generated ID that uniquely identifies the current DVD.
NumberOfChapters Retrieves the number of chapters in the specified title.
TitlesAvailable Retrieves the number of titles available on the DVD.
TotalTitleTime Retrieves the total playback time for the current title.
UOPValid Retrieves a value that indicates whether the specified user operation is currently valid.
VolumesAvailable Retrieves a value specifying the number of volumes in the disc set.

Object Initialization and Control

Settings in the MSVidWebDVD typically only affect the current session. Persistent default settings are saved in the registry using the MSVidWebDVDAdm.

Method or Property Description
DVDAdm Provides access to the MSVidWebDVDAdm object containing methods and properties for saving application and user information.
RegionChange Displays a system dialog box that enables the user to change the region associated with the DVD drive.
RestorePreferredSettings Restores the registry's DVD default language and level settings.

Bookmarks

Bookmarks save the current position and setting information for later viewing. Only one bookmark may be saved at a time.

Method or Property Description
DeleteBookmark Deletes the current bookmark.
RestoreBookmark Moves the DVD Navigator filter to the point on the DVD specified in the current bookmark, with all audio, video and subpicture settings restored.
SaveBookmark Saves the current disc position and state of the DVD Navigator filter to disc so that the user can return to the same place later.

GPRMs and SPRMs

Method or Property Description
GPRM Retrieves or sets the specified general parameter register.
SPRM Retrieves the specified system parameter register.

See Also

DVD Applications in Visual Basic (Video Control)

Send comments about this topic to Microsoft

Build date: 12/4/2008