MSWebDVD Object
[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.]
Note
This component is available for use in the Microsoft Windows 2000, Windows XP, and Windows Server 2003 operating systems. It may be altered or unavailable in subsequent versions.
Note
This API is deprecated. For information about DVD playback and navigation in DirectShow, see DVD Applications.
The methods, properties, and events of the MSWebDVD object enable an application to control all aspects of DVD-Video navigation and playback, and to retrieve information from the disc. The MSWebDVD object does not perform the actual navigation work; rather, it passes the commands to the DVD Navigator filter, a Microsoft® DirectShow® component that reads DVD-Video discs.
The MSWebDVD methods and properties act on the current state of the DVD Navigator or the information on a disc, or both. To store and retrieve various types of application-specific information in the registry, such as user preferences for parental levels and default language, use the methods of the MSDVDAdm object. Use the DVDAdm property to access this object.
Note
As of DirectX 9.0b, the object loads only in trusted zones. It will not load in non-trusted zones.
Methods and Properties by Category
| Playback | |
|---|---|
| CanStep | Determines whether the MPEG-2 decoder on the local system can perform frame stepping in a specified direction. |
| Eject | Ejects or inserts a disc from or into the drive. |
| FramesPerSecond | Retrieves the video frame rate for the current DVD title. |
| Pause | Pauses playback at the current location. |
| Play | Plays the current DVD title. |
| PlayAtTime | Starts playback in the current title at the specified time. |
| PlayAtTimeInTitle | Starts playback at the specified time within the specified title. |
| PlayBackwards | Starts backward playback from the current location at the specified speed. |
| PlayChapter | Starts playback from the specified chapter in the current title. |
| 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. |
| PlayForwards | Starts forward playback from the current location at the specified speed. |
| 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. |
| Step | Advances the DVD-Video stream by the specified number of frames. |
| Stop | Stops playback. |
| Menus | |
| 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. |
| GetButtonAtPosition | Retrieves the number of the button at the specified coordinates without selecting or activating it. |
| GetButtonRect | Retrieves the rectangle for the specified button, in window coordinates. |
| 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 | |
| AudioStreamsAvailable | Retrieves the number of audio streams available in the current title. |
| Balance | Sets or retrieves the speaker balance for the audio stream output. |
| CurrentAudioStream | Sets or retrieves the number of the enabled audio stream. |
| DefaultAudioLanguage | Retrieves the default audio language from the disc. |
| DefaultAudioLanguageExt | Retrieves the default audio language extension from the disc. |
| GetAudioLanguage | Retrieves a string indicating which language is available on the specified audio stream. |
| IsAudioStreamEnabled | Retrieves a value indicating whether the specified audio stream is enabled in the current title. |
| Mute | Turns the audio stream output on or off. |
| SelectDefaultAudioLanguage | Sets the current default audio language in the DVD Navigator. |
| Volume | Sets or retrieves the audio volume level. |
| Subpicture Stream | |
| CurrentSubpictureStream | Retrieves the selected subpicture stream. |
| DefaultSubpictureLanguage | Retrieves the default subpicture language from the disc. |
| DefaultSubpictureLanguageExt | Retrieves the default subpicture language extension from the disc. |
| GetSubpictureLanguage | Retrieves the language for the specified subpicture stream. |
| 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 in the DVD Navigator. |
| SubpictureOn | Sets or retrieves the current subpicture state (on or off). |
| SubpictureStreamsAvailable | Retrieves the number of subpicture streams available in the current title. |
| Video Rectangle | |
| AspectRatio | Retrieves the aspect ratio of the current video stream as authored on the disc. |
| BackColor | Sets or retrieves the color of the bars that appear around the edges of the video rectangle when the aspect ratio of the native video is not the same as that of the object's display area. |
| Capture | Captures a still image from the video frame when the MSWebDVD object is in windowless mode. |
| FullScreenMode | Sets or retrieves a value indicating whether the display is in full-screen mode. |
| GetClipVideoRect | Retrieves the clipping rectangle defined for the video display. |
| GetVideoSize | Retrieves the native video dimensions. |
| SetClipVideoRect | Sets the clipping rectangle occupied by the video display. |
| Zoom | Zooms the video display in or out, centered on a given set of screen coordinates. |
| Closed Captioning | |
| CCActive | Sets or retrieves the current status of closed captioning. |
| ColorKey | Sets or retrieves the color key used in closed captioning. |
| CurrentCCService | Sets or retrieves the current closed-captioned service. |
| Angle Blocks | |
| AnglesAvailable | Retrieves the number of angles available. |
| CurrentAngle | Sets or retrieves the current angle in an angle block. |
| Karaoke Audio | |
| GetKaraokeChannelAssignment | Retrieves a value that indicates how the karaoke channels are assigned to the left and right speakers. |
| GetKaraokeChannelContent | 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 | |
| GetDVDTextLanguageLCID | Retrieves the locale identifier (LCID) for the specified text string block. |
| GetDVDTextNumberOfLanguages | Retrieves the number of text languages available in the current DVD directory. |
| GetDVDTextNumberOfStrings | Retrieves the number of text strings available for the specified language. |
| GetDVDTextString | Retrieves the specified text string from the disc. |
| GetDVDTextStringType | Retrieves a value that indicates the type of information contained in the specified DVD text string. |
| GetLangFromLangID | Retrieves a human-readable string when given a primary language identifier (ID). |
| Parental Management | |
| AcceptParentalLevelChange | Instructs the DVD Navigator to accept or reject the new temporary parental management level. |
| GetPlayerParentalCountry | Retrieves the current country/region as set in the DVD Navigator. |
| GetPlayerParentalLevel | Retrieves the parental management level set in the DVD Navigator. |
| GetTitleParentalLevels | Retrieves the parental management levels 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 Information | |
| 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 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 number that uniquely identifies the current DVD. |
| GetNumberOfChapters | 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 | |
| DisableAutoMouseProcessing | Enables or disables the object's mouse-processing functionality. |
| DVDAdm | Provides access to the MSDVDAdm object containing methods and properties for saving application and user information. |
| EnableResetOnStop | Sets or retrieves a value that determines how play will resume when the filter graph transitions out of a stopped state. |
| PlayState | Retrieves the current play state. |
| ReadyState | Retrieves the ReadyState of the MSWebDVD object. |
| RegionChange | Displays a system dialog box that enables the user to change the region associated with the DVD drive. |
| Render | Initializes the DVD filter graph. |
| WindowlessActivation | Initializes the MSWebDVD object at design time for either windowed or windowless mode. |
| Bookmarks | |
| DeleteBookmark | Deletes the current bookmark. |
| RestoreBookmark | Moves the DVD Navigator to the point on the DVD as 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 to disc so that the user can return to the same place later. |
| Cursors and ToolTips | |
| CursorType | Sets or retrieves the current cursor type. |
| GetDelayTime | Retrieves the delay time for the ToolTip associated with the MSWebDVD object. |
| SetDelayTime | Sets the delay time for the ToolTip associated with the MSWebDVD object. |
| ShowCursor | Makes the mouse pointer visible when the DVD Navigator is in full-screen mode. |
| ToolTip | Sets the text for the ToolTip that will appear when the mouse pointer is over the MSWebDVD video rectangle. |
| ToolTipMaxWidth | Sets or retrieves the maximum width for the ToolTip associated with the MSWebDVD object. |
| GPRMs and SPRMs | |
| GetGPRM | Retrieves the specified general parameter register. |
| GetSPRM | Retrieves the specified system parameter register. |
| SetGPRM | Sets the specified general parameter register to the specified value. |
Related topics