Microsoft DirectX 8.0 |
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.
See Also
MSWebDVD EventsMethods and Properties by Category
Playback CanStep Determines whether the MPEG-2 decoder on the local system can perform frame stepping. 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 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 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.
Accepts or rejects the new temporary parental management level.
Syntax
MSWebDVD.AcceptParentalLevelChange(bAccept);
Parameters
bAccept Boolean value specifying whether to accept or reject the new parental level; (true means to accept it.
Return Value
No return value.
Remarks
Call this method in response to an EC_DVD_PARENTAL_LEVEL_CHANGE event notification to specify whether the DVD Navigator should play the content with the new parental level, or branch to where the disc specifies if the new level is rejected.
See Also
Enforcing Parental Management Levels, GetPlayerParentalCountry, GetPlayerParentalLevel, GetTitleParentalLevels, NotifyParentalLevelChange, SelectParentalCountry, SelectParentalLevel
Activates the menu button under the current mouse pointer position.
Syntax
MSWebDVD.ActivateAtPosition(xPos, yPos);
Parameters
xPos Integer value specifying the mouse pointer's x-coordinate. xPos Integer value specifying the mouse pointer's y-coordinate.
Return Value
No return value.
Remarks
Use this method when implementing custom mouse handling after setting DisableAutoMouseProcessing to true.
See Also
ButtonsAvailable, CurrentButton, GetButtonAtPosition, GetButtonRect, SelectAndActivateButton, SelectAtPosition
Activates the selected menu button.
Syntax
MSWebDVD.ActivateButton();
Return Value
No return value.
Remarks
Use this method when implementing custom mouse handling after setting DisableAutoMouseProcessing to true.
Use this method to activate a button that has been selected through the SelectLeftButton, SelectLowerButton, SelectUpperButton, or SelectRightButton method.
Retrieves the number of angles currently available.
Syntax
[ iAngles = ] MSWebDVD.AnglesAvailable
Possible Values
iAngles Integer value from 1 through 9 representing the number of angles currently available. If iAngles = 1, there is no angle block at the current location. This property is read-only with no default value.
Remarks
An angle block is a video segment that was shot from more than one camera angle. There can be up to nine angles in an angle block, numbered from 1 through 9. When the DVD Navigator first enters an angle block, it sends your application an EC_DVD_ANGLES_AVAILABLE event notification with the number of angles in lParam1. A disc can be authored to automatically show a menu for available angles when it enters an angle block, but generally an application must determine the number of angles available and offer the user a way to select one.
See Also
Retrieves the aspect ratio of the current video stream as authored on the disc.
Syntax
[ nAspectRatio = ] MSWebDVD.AspectRatio
Possible Values
nAspectRatio Number value representing the aspect ratio of the current video stream as authored on the disc (1.33 for a 4:3 aspect ratio or 1.78 for a 16:9 aspect ratio). This property is read-only with no default value.
Retrieves the number of audio streams available in the current title.
Syntax
[ iStreams = ] MSWebDVD.AudioStreamsAvailable
Possible Values
This property is read-only with no default value.
iStreams Integer value from 1 through 8 representing the number of audio streams available in the current title.
Remarks
The primary use of multiple audio streams is to provide movie soundtracks in more than one language. Typically, not every title on a disc has all audio streams enabled. For example, the feature movie might have soundtracks in three different languages, but the trailers might have only an English soundtrack. Before a user can select a stream, the application must determine which streams are available within the current title. Note that particular streams are identified by an index from zero through 7.
Discs generally present a menu showing the available soundtracks, enabling the user to select the audio stream to enable.
See Also
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.
Syntax
[ iBackColor = ] MSWebDVD.BackColor
Possible Values
iBackColor Integer value representing the RGB values of the back color. This property is read/write with a default value of off-black (0x100010).
Sets or retrieves the speaker balance for the audio stream output.
Syntax
[ iBalance = ] MSWebDVD.Balance
Possible Values
iBalance Integer value representing the balance levels. The allowable input range is -10,000 to 10,000. A value of 0 sets a neutral balance, that is both left and right speakers are given the same amplitude audio signal. This property is read/write with a default value of 0, meaning that both speakers receive equivalent audio signals. As with the Volume property, units correspond to .01 decibels (multiplied by 1 when iBalance is a positive value). For example, a value of 1000 indicates 10 dB on the right channel and 90 dB on the left channel.
Retrieves the total number of buttons on the current menu.
Syntax
[ iButtons = ] MSWebDVD.ButtonsAvailable
Possible Values
iButtons Integer value representing the number of buttons. This property is read-only with no default value.
Remarks
Use this method when implementing custom mouse handling after setting DisableAutoMouseProcessing to true.
Call this method to retrieve the upper limit for the range of valid button numbers.
See Also
CurrentButton, GetButtonAtPosition, GetButtonRect, SelectAndActivateButton, SelectAtPosition
Determines whether the MPEG-2 decoder on the local system can perform frame stepping.
Syntax
[ bCanStep = ] MSWebDVD.CanStep(bBackwards);
Parameters
bBackwards Boolean value specifying whether we are asking if the decoder can step backward. Default is false, meaning forward frame stepping.
Return Value
Returns a Boolean value indicating whether the decoder can step in the specified direction; true means it can.
Remarks
Not all hardware MPEG-2 decoders support the new frame stepping capabilities in DirectShow® 8.0. This method queries the decoder for its frame stepping capabilities. If the decoder can perform frame stepping, an application can use the Step method to step through frames. This method will always return true if a software decoder is being used.
Captures a still image from the video frame when the MSWebDVD object is in windowless mode.
Syntax
MSWebDVD.Capture();
Remarks
This method captures the current frame from the DVD-Video image and pastes it into a window from which the user can save or edit the image. The MSWebDVD object must be in windowless mode for this method to succeed.
Sets or retrieves the current status of closed captioning.
Syntax
[ bCCActive = ] MSWebDVD.CCActive
Possible Values
bCCActive Boolean value indicating whether closed captioning is turned on. This property is read/write with a default value of false.
See Also
Sets or retrieves the color key used in closed captioning.
Syntax
[ iColorKey = ] MSWebDVD.ColorKey
Possible Values
iColorKey Integer value representing the color to use as a transparent background for closed-captioned text. The default value in 256 colors is magenta, and off-black in any other color depth. This property is read/write.
Remarks
This property applies only to the closed-captions, if any exist, not to the subpicture stream.
Sets or retrieves the current angle in an angle block.
Syntax
[ iCurAngle = ] MSWebDVD.CurrentAngle
Possible Values
iCurAngle Integer value representing the angle. Must be a value from 1 through 9. This property is read/write with no default value.
See Also
Sets or retrieves the number of the enabled audio stream.
Syntax
[ iStream = ] MSWebDVD.CurrentAudioStream
Possible Values
iStream Integer value from 0 through 7 indicating the current audio stream. This property is read/write with no default value.
Remarks
Before attempting to set a new audio stream, call IsAudioStreamEnabled to verify that the stream is available.
See Also
Retrieves the number of the selected menu button.
Syntax
[ iButton = ] MSWebDVD.CurrentButton
Possible Values
iButton Integer value representing the button. This property is read-only with no default value.
Remarks
Use this method when implementing custom mouse handling after setting DisableAutoMouseProcessing to true.
See Also
ActivateButton, ButtonsAvailable, CurrentButton, GetButtonAtPosition, GetButtonRect, SelectAndActivateButton, SelectAtPosition
Sets or retrieves the current closed captioning service.
Syntax
[ iService = ] MSWebDVD.CurrentCCService
Possible Values
iService Integer value indicating the type of closed captioning service enabled. This property is read/write with a default value of 0x0.
This table lists the possible values for iService.
CC service type Value No current service. 0x0 True captioning, first field. Default service. 0x1 Captioning for secondary language, second field. Generally not used. 0x2
See Also
Retrieves the number of the chapter currently playing.
Syntax
[ iCurChapter = ] MSWebDVD.CurrentChapter
Possible Values
iCurChapter Integer value representing the current chapter in the current title. This property is read-only with no default value.
Retrieves the current side of the disc.
Syntax
[ iCurSide = ] MSWebDVD.CurrentDiscSide
Possible Values
iCurSide Integer value representing the current side; Side A = 1 and Side B = 2. This property is read-only with no default value.
Retrieves the DVD domain that the MSWebDVD object is in.
Syntax
[ iDomain = ] MSWebDVD.CurrentDomain
Possible Values
iDomain Integer value from 1 through 5 representing the current domain. The possible values for iDomain are:
First Play 1 Video Manager Menu 2 Video Title Set Menu 3 Title 4 Stop 5 This property is read-only with no default value.
Remarks
Call this method to ensure that the DVD Navigator is in a valid domain for the method you are about to call. For example, before calling PlayTitle, check the CurrentDomain property to make sure that the DVD Navigator is not in the Stop or First Play domain.
Sets or retrieves the current subpicture stream.
Syntax
[ iSPStream = ] MSWebDVD.CurrentSubpictureStream
Possible Values
iSPStream Integer value from 0 through 31 representing the subpicture stream. May also be 63, indicating a muted low-bitrate stream. This property is read/write with no default value.
Remarks
Before setting a new subpicture stream, call IsSubpictureStreamEnabled to verify that the stream is available.
See Also
Retrieves the current playback time.
Syntax
[ sCurTime = ] MSWebDVD.CurrentTime
Possible Values
sCurTime An 11-character string representing the current playback time in the format "hh:mm:ss:ff" (hours, minutes, seconds, frames). This property is read-only with no default value.
See Also
Retrieves the number of the title currently playing.
Syntax
[ iCurTitle = ] MSWebDVD.CurrentTitle
Possible Values
iCurTitle Integer value from 1 through 99 representing the current disc title. This property is read-only with no default value.
See Also
Retrieves the volume number for the current root directory.
Syntax
[ iCurVolume = ] DVD.CurrentVolume
Possible Values
iCurVolume Integer value representing the current DVD volume. If a disc is part of a multivolume set, then iCurVolume should be greater than zero. This property is read-only with no default value.
See Also
Sets or retrieves the current cursor type.
Syntax
[ iCursorType = ] MSWebDVD.CursorType
Possible Values
iCursorType Integer value representing the cursor type. The possible values for this property are:
Arrow 0 Zoom In 1 Zoom Out 2 Hand 3 None -1 This property is read/write with a default value of zero.
Remarks
When the picture is zoomed in, setting CursorType to Hand (0x3) puts the application into drag mode, enabling the user to move the image inside the video display area.
Retrieves the default audio language.
Syntax
[ iLang = ] MSWebDVD.DefaultAudioLanguage
Possible Values
iLang LCID value containing the primary language ID for the default audio language. See Working with LCIDs for a table of some possible values and sample code showing how to extract the primary language ID from an LCID. This property is read-only with no default value.
See Also
SelectDefaultAudioLanguage
Retrieves the default DVD audio language extension.
Syntax
[ iLangExt = ] MSWebDVD.DefaultAudioLanguageExt
Possible Values
iLangExt Integer value indicating the default audio language extension. See Remarks for the possible values.
Remarks
This property is read-only with no default value. The following table shows the possible values for DVD audio language extensions.
Extension Value NotSpecified 0 Captions 1 VisuallyImpaired 2 DirectorComments1 3 DirectorComments2 4
See Also
SelectDefaultAudioLanguage
Retrieves the default menu language.
Syntax
[ iLang = ] MSWebDVD.DefaultMenuLanguage
Possible Values
iLang LCID value containing the primary language ID for the default audio language. See Working with LCIDs for a table of some possible values and sample code showing how to extract the primary language ID from an LCID.
Remarks
This property is read-write with no default value.
Retrieves the default subpicture language.
Syntax
[ iLang = ] MSWebDVD.DefaultSubpictureLanguage
Possible Values
iLang LCID value containing the primary language ID for the default audio language. See Working with LCIDs for a table of some possible values and sample code showing how to extract the primary language ID from an LCID. This property is read-only with no default value.
See Also
SelectDefaultSubpictureLanguage
Retrieves the default DVD subpicture language extension.
Syntax
[ iLangExt = ] MSWebDVD.DefaultSubpictureLanguageExt
Possible Values
iLangExt Integer value indicating the default DVD subpicture language extension.
Remarks
This property is read-only with no default value. The following table shows the possible values.
Extension Value Extension Not Specified 0 Normal Captions 1 Big Captions 2 Children's Captions 3 Normal Closed Captions 5 Big Closed Captions 6 Children's Closed Captions 7 Forced 9 Normal Director's Comments 13 Big Director's Comments 14 Children's Director's Comments 15
See Also
SelectDefaultSubpictureLanguage
Deletes the saved bookmark.
Syntax
MSWebDVD.DeleteBookmark();
Return Value
No return value.
Remarks
There can only be one bookmark at a time.
Enables or disables the MSWebDVD object's mouse-processing functionality.
Syntax
[ bMouseProcessing = ] MSWebDVD.DisableAutoMouseProcessing
Possible Values
bMouseProcessing Boolean value indicating whether to disable the default mouse processing.
Remarks
This property is read/write with a default value of false.
The MSWebDVD object automatically handles mouse actions for DVD on-screen menus by default; users can highlight and activate menu buttons without special programming by the application. An application can turn off this default mouse-handling functionality by setting this property to true. When the automatic mouse processing is turned off, an application must use the various button-related methods and properties to handle mouse moves and mouse clicks on the on-screen menus. Also, an application can use the button-related methods to override the automatic mouse handling even when when DisableAutoMouseProcessing is set to false.
Provides access to the MSDVDAdm object that contains methods and properties for saving application and user information.
Syntax
MSWebDVD.DVDAdm
Remarks
This property is read-only with no default value. There is no need to create a separate reference to the MSDVDAdm object. To access the methods and properties of the object, use the DVDAdm property as shown in the following example.
DVD.DVDAdm.DisableScreenSaver = true;
Sets or retrieves the current directory of the current DVD volume.
Syntax
[ sDirPath = ] MSWebDVD.DVDDirectory
Possible Values
sDirPath String value indicating the path to the DVD root directory.
Remarks
This property is read/write with no default value. Use this method to set the root path when there is more than one DVD drive on a system. When there is only one drive on the system and its drive letter is higher than "C", the MSWebDVD object finds it automatically. For a standard DVD-Video disc, the root path should include the ts_video directory, for example:
MSWebDVD.DVDDirectory = "e:\\video_ts";Some DVD volumes may have their video in a directory named something other than "video_ts." The general idea is that an additional "DVD volume" (the set of .IFO. VOB, and .BUP files that would normally be stored in the VIDEO_TS directory) can be placed in a subdirectory on the disc. By changing the root to point to this directory, MSWebDVD will operate on this separate DVD volume. A new set of menus, titles, etc. will be available, independent of the titles in the VIDEO_TS root, which will no longer be accessible. Such directories are called "hidden directories." The following example shows how to set a hidden directory as the root, where "hidden" is a placeholder for whatever name the disc authors have given to the directory.
MSWebDVD.DVDDirectory = "d:\\webdvd\\hidden";
Retrieves a String indicating the current time on the disc.
Syntax
[ sTimeCode = ] MSWebDVD.DVDTimeCode2bstr(nTimeCode);
Parameters
nTimeCode A Number obtained through the EC_DVD_CURRENT_HMSF_TIME event representing the current time on the disc relative to the start of the title.
Return Value
Returns an 11-character String in the format "hh:mm:ss:ff" representing the hours, minutes, seconds and frames that define the current time.
Remarks
This property is read only.
See Also
Retrieves a system-generated number that uniquely identifies the current disc.
Syntax
[ iDiscID = ] MSWebDVD.DVDUniqueID
Possible Values
iDiscID Integer value that uniquely identifies the current disc. This property is read-only with no default value.
Remarks
The identifier (ID) number is not absolutely unique, but it is unique for all practical purposes. The ID applies to all replicated copies of a disc. In other words, all copies of a specific movie have the same ID. The ID is based on file sizes, dates, and other information, and not the BCA value.
Ejects or inserts a disc from or into the DVD drive.
Syntax
MSWebDVD.Eject();
Return Value
No return value.
Remarks
On some DVD drives, this method acts as a toggle, ejecting and inserting on alternate calls. This is hardware-dependent.
Sets or retrieves a value that determines how play will resume when the filter graph makes a transition from a stopped state.
Syntax
[ bEnableReset = ] MSWebDVD.EnableResetOnStop
Possible Values
bEnableReset Boolean value indicating where the MSWebDVD object will start playing again after the filter graph is stopped. True means the DVD Navigator will reset and start play from the beginning of the disc. False means it will start play where it left off.
Remarks
This property is read/write with a default value of true.
Retrieves the video frame rate for the current DVD title.
Syntax
[ iFramesPerSec = ] MSWebDVD.FramesPerSecond
Possible Values
iFramesPerSec Integer value representing the video frame rate; either 25 or 30 frames per second.
Remarks
This property is read-only with no default value. NTSC video signals are displayed at 30 frames per second. PAL is displayed at 25 frames per second. A disc is encoded to play on either NTSC or PAL, but cannot play on both.
Sets or retrieves a value indicating whether the display is in full-screen mode.
Syntax
[ bFullScreen = ] MSWebDVD.FullScreenMode
Possible Values
bFullScreen Boolean value indicating whether to enable or disable full-screen playback; true means to enable full-screen mode.
Remarks
This property is read/write with a default value of false.
Retrieves a string indicating which language is available on the specified audio stream.
Syntax
[ slang = ] MSWebDVD.GetAudioLanguage(iStream);
Parameters
iStream Integer value specifying the audio stream number in the current title.
Return Value
Returns a human-readable string identifying the language of the audio stream in the current title.
Retrieves the number of the button at the specified coordinates without selecting or activating it.
Syntax
[ iButton = ] MSWebDVD.GetButtonAtPosition(xPos, yPos);
Parameters
xPos Integer value specifying the x-coordinate of the mouse pointer. yPos Integer value specifying the y-coordinate of the mouse pointer.
Return Value
Returns an integer value specifying the button, if any, at the specified position.
Remarks
This method returns zero if no button is present at the given coordinates. Use this method when implementing custom mouse handling after setting DisableAutoMouseProcessing to true.
See Also
ActivateButton, ButtonsAvailable, CurrentButton, GetButtonRect, SelectAndActivateButton, SelectAtPosition
Retrieves the rectangle for the specified button, in window coordinates.
Syntax
[ oButton = ] MSWebDVD.GetButtonRect(iButton);
Parameters
iButton Integer value specifying the button number.
Return Value
Returns a DVDRect object that defines the rectangle.
Remarks
Use this method when implementing custom mouse handling after setting DisableAutoMouseProcessing to true.
See Also
ButtonsAvailable, CurrentButton, ActivateButton, SelectAndActivateButton, SelectAtPosition
Retrieves the clipping rectangle currently defined for the video display.
Syntax
[ oClipRect = ] MSWebDVD.GetClipVideoRect();
Return Value
Returns a DVDRect object that defines the rectangle.
See Also
Retrieves the delay time for the ToolTip associated with the MSWebDVD object.
Syntax
[ iDelay = ] MSWebDVD.GetDelayTime();
Return Value
Returns an integer value indicating the ToolTip delay time, in milliseconds.
See Also
Retrieves the locale identifier (LCID) for the specified text string block.
Syntax
[ iLCID = ] MSWebDVD.GetDVDTextLanguageLCID(iLangIndex);
Parameters
iLangIndex Integer value that identifies the text language block on the disc.
Return Value
Returns an LCID value that contains information specifying the language the strings are written in. See Working With LCIDs for information on extracting the primary language code from an LCID.
Remarks
Supplemental text strings are stored in contiguous blocks on the disc. Each language has one block of strings. An application specifies these blocks by an index, which must be less than the value returned by GetDVDTextNumberOfLanguages.
See Also
Retrieves the number of text languages available on the disc.
Syntax
[ iLanguages = ] MSWebDVD.GetDVDTextNumberOfLanguages();
Return Value
Returns an integer value specifying the number of text languages available.
See Also
Working With DVD Text Strings
Retrieves the number of text strings available for the specified language.
Syntax
[ iStrings = ] MSWebDVD.GetDVDTextNumberOfStrings(iLangIndex);
Parameters
iLangIndex Integer value that identifies the language; must be a value from zero through one less than the value returned by GetDVDTextNumberOfLanguages.
Return Value
Returns an integer value specifying how many strings the disc contains in the specified language.
See Also
Working With DVD Text Strings
Retrieves the specified text string.
Syntax
[ sText = ] MSWebDVD.GetDVDTextString(iLangIndex, iStringIndex);
Parameters
iLangIndex Integer value specifying the index of the language. iStringIndex Integer value specifying the index number of the text string.
Return Value
Returns the String specified by iStringIndex.
See Also
Retrieves a value that indicates the type of information contained in the specified DVD text string.
Syntax
[ iStringType = ] MSWebDVD.GetDVDTextStringType(iLangIndex, iStringIndex);
Parameters
iLangIndex Integer value specifying the language of the text string. iStringIndex Integer value specifying the index number of the text string.
Return Value
Returns an integer value that indicates the type of information contained in the string.
Remarks
See Working With DVD Text Strings for a table of text string types and their meanings.
Retrieves the specified general parameter register.
Syntax
[ iGPRM = ] MSWebDVD.GetGPRM(iIndex);
Parameters
iIndex Integer value in the range from 0 through 15 indicating which register to retrieve.
Return Value
Returns an Integer value for the specified register.
Remarks
This method is not required for any DVD navigation or playback functionality using the MSWebDVD object. It is provided for those with a thorough understanding of the DVD specification who want to implement advanced features. GPRMs can be used to hold any values, so they can be freely set and read. But since GPRMs are used to store disc commands as well, changing their values using SetGPRM can result in unpredictable behavior.
See Also
Retrieves a value that indicates how the karaoke channels are assigned to the speakers.
Syntax
[ iAssignment = ] MSWebDVD.GetKaraokeChannelAssignment(iStream , iChannel);
Parameters
iStream Integer value specifying the audio stream. iChannel Integer value specifying the channel.
Return Value
Returns an integer indicating the speaker assignment for the specified channel. The possible values for iAssignment are:
2 The channel is assigned to the left and right speakers. 3 The channel is assigned to the left, right, and middle speakers. 4 The channel is assigned to the left, right, and audio1 speakers. 5 the channel is assigned to the left, right, middle, and audio1 speakers. 6 The channel is assigned to the left, right, and audio2 speakers. 7 The channel is assigned to the left, right, middle, and audio2 speakers.
See Also
Retrieves a value that indicates the type of content in the specified karaoke channel in the specified stream.
Syntax
[ iContent = ] MSWebDVD.GetKaraokeChannelContent(iStream, iChannel);
Parameters
iStream Integer value from zero through seven specifying the audio stream. iChannel Integer value specifying the karaoke channel within iStream. The possible values for each channel are:
Guide Vocal 1 0x0001 Guide Vocal 2 0x0002 Guide Melody 1 0x0004 Guide Melody 2 0x0008 Guide Melody A 0x0010 Guide Melody B 0x0020 Sound Effect A 0x0040 Sound Effect B 0x0080
Return Value
Returns an integer value whose individual bits specify the contents of the karaoke channel.
Remarks
DVD audio channel numbering is zero-based, so channels 2, 3, and 4 are the auxiliary karaoke channels. After the method returns, perform a bitwise AND operation on iContent to determine the contents of each channel. Because a single channel might have more than one type of content recorded on it, you should test for all the possible values even after a match is found.
The following code example demonstrates how to test iContents against each possible value.
if(iContent & 0x0001) { // Set a check box or another UI control to // indicate this channel has the Guide Vocal 1. } if(iContent & 0x0002) { // Set a check box or another UI control to // indicate this channel has the Guide Vocal 2. } if(iContent & 0x0004) { // Set a check box or another UI control to // indicate this channel has the Guide Melody 1. } // Repeat for each possible value for each channel.After the user knows the contents of each channel, he or she must be able to adjust the volume or turn the individual channels on or off as needed. Implement this functionality in your application by using the KaraokeAudioPresentationMode property.
Note: To play karaoke discs, the audio decoder on the user's system must be compatible with the DirectShow 8 karaoke implementation.
Retrieves a human-readable string when given a primary language ID.
Syntax
[ sLanguage = ] MSWebDVD.GetLangFromLangID(iPrimaryLangID)
Parameters
iPrimaryLangID Integer specifying the primary language ID. See Working with LCIDs for a table of some possible values.
Return Value
If iPrimaryLangID is valid, returns a String representation of the language that can be displayed in the application's user interface. If iPrimaryLangID is invalid, an error code is returned.
Remarks
Although this method is named GetLangFromLangID, the parameter that you pass is actually the primary language ID, not the language ID.
See Also
Working with LCIDs, GetAudioLanguage, , GetDVDTextLanguageLCID
Retrieves the number of chapters in the specified title.
Syntax
iChapters = MSWebDVD.GetNumberOfChapters(iTitle);
Parameters
iTitle Integer value specifying the title.
Return Value
Returns an integer value from 1 through 999 indicating the number of chapters.
Retrieves the current country as set in the MSWebDVD object.
Syntax
iCountryCode = MSWebDVD.GetPlayerParentalCountry();
Return Value
Returns an integer value with the country code.
See Also
Enforcing Parental Management Levels, GetPlayerParentalLevel, GetTitleParentalLevels, SelectParentalCountry, SelectParentalLevel
Retrieves the parental management level set in the MSWebDVD object.
Syntax
[ iLevel = ] MSWebDVD.GetPlayerParentalLevel();
Return Value
Returns an integer value specifying the current parental level in the DVD Navigator, or -1 if parental management is disabled.
Remarks
A player application is responsible for enforcing parental controls. The player parental level is a value set by an application than can be used to indicate the highest parental level the current user can view. When the DVD Navigator encounters a new parental level, use this method to determine whether the new level is greater than the level that was set by the application through SelectParentalLevel.
See Also
Enforcing Parental Management Levels, GetTitleParentalLevels, GetPlayerParentalCountry, SelectParentalCountry, SelectParentalLevel
Retrieves the specified system parameter register.
Syntax
[ iSPRM = ] MSWebDVD.GetSPRM(iIndex);
Parameters
iIndex Integer value from 0 through 23 specifying the register whose value you want to retrieve.
Return Value
Returns an integer value representing the contents of the specified register.
Remarks
The disc controls system parameter registers (SPRMs). A player application doesn't need to access these registers for any standard navigation functionality. SPRMs represent the status of the player. Each one has a meaning, set by user preferences, disc commands, and other occurrences that an application has no direct control over. An application can read these registers but cannot write to them. To use these registers effectively, you will probably need a more detailed knowledge of the DVD navigation commands than is provided in this documentation. The following table shows the contents of each register. For more detailed information on the register contents, see IDVDInfo2::GetAllSPRMs
Register Contents Register Contents Register Contents 0 Menu lang. code 1 Audio stream number 2 Subpicture stream number 3 Current angle number 4 Current title number 5 Title number 6 PGC number 7 Current chapter number (PTT) 8 Highlighted button number 9 Navigation timer 10 PGC jump for nav. timer 11 Karaoke audio presentation mode 12 PML country code 13 PML 14 Video setting 15 Audio capability 16 Audio lang. 17 Audio lang. ext. 18 Subpicture lang. 19 Subpicture lang. ext. 20 Player region code 21 Reserved 22 Reserved 23 Reserved
See Also
Retrieves the language for the specified subpicture stream.
Syntax
[ sLang = ] MSWebDVD.GetSubpictureLanguage(iStream);
Parameters
iStream Integer value specifying the subpicture stream number whose text language you want to retrieve.
Return Value
Returns a human-readable string identifying the language of the audio stream in the current title.
Retrieves the parental management levels for the specified title.
Syntax
[ iLevels = ] MSWebDVD.GetTitleParentalLevels(iTitle);
Parameters
iTitle Integer value specifying the title.
Return Value
Returns an integer value whose individual bits indicate which parental management levels (PML) are set in the specified title.
Remarks
The following code snippet shows how to test for PMLs on Title 1. One use for this information is to compare the highest PML defined for the title to the PML assigned to the current user and determine whether to play the specified title or not.A title may have chapters or even short segments that have a PML different from the overall PML for the title. Use this method to determine all the PMLs that will be encountered when playing a specified title. The returned integer is a set of bit flags that are defined as shown in the table below. Perform a bitwise AND operation on iLevels and each possible value. If the operation returns true, it means that PML will be encountered at some point in this title.
Possible Levels Hexadecimal value DVD Parental Level 1 0x100 DVD Parental Level 2 0x200 DVD Parental Level 3 0x400 DVD Parental Level 4 0x800 DVD Parental Level 5 0x1000 DVD Parental Level 6 0x2000 DVD Parental Level 7 0x4000 DVD Parental Level 8 0x8000
iLevels = oDVD.GetTitleParentalLevels(1); if(iLevels & 0x100) // PML 1 is defined for this title if(iLvels & 0x200) // PML 2 is defined for this title if(iLevels & 0x400) // PML 3 is defined for this title ... // and so on for all eight levels
See Also
Enforcing Parental Management Levels, SelectParentalLevel, GetPlayerParentalCountry, GetPlayerParentalLevel, SelectParentalCountry
Retrieves a value indicating whether the specified audio stream is enabled in the current title.
Syntax
[ bEnabled = ] MSWebDVD.IsAudioStreamEnabled(iStream)
Parameters
iStream Integer value from 0 through 7 specifying the audio stream.
Return Value
Returns a Boolean value indicating whether the specified audio stream is available for the current title. True means it is available.
Remarks
Although a disc can contain up to eight independent audio streams, each stream is not necessarily available for each title. For example, a main movie title might have three audio streams for English, Spanish, and Japanese, but the "Coming Attractions" title might have only one audio stream in English. Always verify that a stream is available for a title before setting the CurrentAudioStream property.
Retrieves a value indicating whether the specified subpicture stream is enabled in the current title.
Syntax
[ bEnabled = ] MSWebDVD.IsSubpictureStreamEnabled(iStream)
Parameters
iStream Integer value from 0 through 31 (or 63 for muted low-bitrate stream) specifying the subpicture stream.
Return Value
Returns a Boolean value indicating whether the specified audio stream is available in the current title. True means it is available.
Remarks
Although a disc can contain up to 32 subpicture streams, each stream is not necessarily available for each title. Always verify that a stream is available for a title before setting the CurrentSubpictureStream property.
Retrieves the native video dimensions.
Syntax
[ oSizeRect = ] MSWebDVD.GetVideoSize();
Return Value
Returns a DVDRect object containing four read/write properties: (top left) x; (top left) y, Width, and Height. The x and y properties are set to zero and the other two properties reflect the width and height of the video rectangle as authored on the disc.
Sets or retrieves the right-left speaker mix for the auxiliary karaoke channels.
Syntax
[iMode ] = MSWebDVD.KaraokeAudioPresentationMode
Possible Values
iMode Integer value containing a set of bit flags specifying how the auxiliary karaoke channels are downmixed to the left and right speakers. See Remarks.
Remarks
This property is read/write with a default value of zero.
Audio channels are zero-based, so channels 0 and 1 generally represent the right and left speaker channels and channels 2 through 4 are the three auxiliary karaoke channels. When the MSWebDVD object enters karaoke mode, it automatically mutes channels 2 and higher. Use bitwise OR operations to set the appropriate bit in order to send an auxiliary channel to the left speaker, right speaker, both speakers (both bits on), or to no speakers (both bits off). These bits are all off by default whenever the DVD Navigator enters karaoke mode. The value of the bits and their corresponding action is given in the following table.
Action Value Downmix Channel 2 to the left speaker 0x0004 Downmix Channel 3 to the left speaker 0x0008 Downmix Channel 4 to the left speaker 0x0010 Downmix Channel 2 to the right speaker 0x0400 Downmix Channel 3 to the right speaker 0x0800 Downmix Channel 4 to the right speaker 0x1000 The following code example shows how to send channel 2 to the left speaker and channels 3 and 4 to the right channel by using a bitwise OR operation.
var iMode = 0; iMode = 0x0004 | 0x0800 | 0x1000 ; DVD.KaraokeAudioPresentationMode = iMode;To retrieve the value of KaraokeAudioPresentationMode, use a bitwise AND operation against the possible values, as shown in the following code example.
if (DVD.KaraokeAudioPresentationMode & 0x0004) { // Channel 2 is being sent to the left speaker } if (DVD.KaraokeAudioPresentationMode & 0x0008) { // Channel 3 is being sent to the left speaker } // And so on for all possible values
Turns the audio stream output on or off.
Syntax
[ bMute = ] MSWebDVD.Mute
Possible Values
bMute Boolean value indicating whether the audio stream should be muted.
Remarks
This property is read/write with a default value of false.
Enables or disables the event handling for temporary parental management level commands.
Syntax
MSWebDVD.NotifyParentalLevelChange(bNotify);
Parameters
bNotify Boolean value specifying whether the application is notified when the MSWebDVD object encounters video segments with a rating more restrictive than the overall rating for the disc.
Return Value
No return value.
Remarks
Parental management notifications are disabled by default. This means that temporary parental commands from the disc are allowed but ignored and disc will play without interruption. Call this method during initialization of your application if you need to handle temporary parental management level commands from the disc. To disable parental management after it is enabled, call this method with an argument of false. For more details on parental management, see AcceptParentalLevelChange.
See Also
Enforcing Parental Management Levels, SelectParentalLevel, GetTitleParentalLevels, GetPlayerParentalCountry, GetPlayerParentalLevel, SelectParentalCountry
Pauses playback at the current location.
Syntax
MSWebDVD.Pause();
Return Value
No return value.
Remarks
If playback is already paused, this method does nothing.
Plays the current DVD title.
Syntax
MSWebDVD.Play();
Return Value
No return value.
Remarks
If playback is paused or stopped and EnableResetOnStop is true, then calling Play will resume playback at normal speed at the current location. If playback is stopped and EnableResetOnStop is false, then calling Play will cause the disc to start playing at the beginning of the first title.
See Also
Starts playback in the current title at the specified time.
Syntax
MSWebDVD.PlayAtTime(sTime);
Parameters
sTime String value specifying the time at which to start playing; must be in the format "hh:mm:ss:ff" (specifying hours, minutes, seconds, frames).
Return Value
No return value.
See Also
Starts playback at the specified time within the specified title.
Syntax
MSWebDVD.PlayAtTimeInTitle(sTime, iTitle);
Parameters
sTime String value specifying the time at which to start playback; must be in the format "hh:mm:ss:ff" (specifying hours, minutes, seconds, frames). iTitle Integer specifying the index of the title.
Return Value
No return value.
See Also
Starts backward playback from the current location at the specified speed.
Syntax
MSWebDVD.PlayBackwards(nSpeed);
Parameters
nSpeed Number value specifying the speed at which to play. This value is a multiplier1.0 is normal playback speed; 2.0 is double speed, 0.5 is half speed, and so on. When nSpeed does not equal 1.0, audio is muted and the subpicture is turned off.
Return Value
No return value.
See Also
Starts playback from the specified chapter within the current title.
Syntax
MSWebDVD.PlayChapter(iChapter);
Parameters
iChapter Integer value specifying the chapter index in the current title.
Return Value
No return value.
Remarks
When the end of the specified chapter is reached, this method continues playing subsequent chapters, if any exist. If you want to play only a specified chapter, use PlayChaptersAutoStop.
See Also
Starts playback at the specified chapter in the specified title and for the number of chapters specified.
Syntax
MSWebDVD.PlayChaptersAutoStop(iTitle, iChapter, iChapterCount);
Parameters
iTitle Integer value specifying the title. iChapter Integer value specifying the start chapter. iChapterCount Integer value specifying the number of chapters to play.
Return Value
No return value.
Remarks
When the last chapter has played, this method causes an EC_DVD_CHAPTER_AUTOSTOP event notification to be sent to the application.
Plays the specified chapter in the specified title.
Syntax
MSWebDVD.PlayChapterInTitle(iTitle, iChapter);
Parameters
iTitle Integer value specifying the title. iChapter Integer value specifying the chapter.
Remarks
This method starts playback at the specified chapter and then continues playing indefinitely. If you want to play only a particular chapter, use PlayChaptersAutoStop.
Return Value
No return value.
Starts forward playback from the current location at the specified speed.
Syntax
MSWebDVD.PlayForwards(nSpeed);
Parameters
nSpeed Number value specifying the speed at which to play. This value is a multiplier1.0 is normal playback speed; 2.0 is double speed, 0.5 is half speed, and so on. When nSpeed does not equal 1.0, audio is muted and the subpicture is turned off.
Return Value
No return value.
See Also
Starts playback from the next chapter in the current title.
Syntax
MSWebDVD.PlayNextChapter();
Return Value
No return value.
See Also
Starts playback at the specified time in the specified title until the specified stop time.
Syntax
MSWebDVD.PlayPeriodInTitleAutoStop(iTitle, sStartTime, sEndTime);
Parameters
iTitle Integer value specifying the title. sStartTime String specifying the start time in "hh:mm:ss:ff" format (specifying hours, minutes, seconds, frames). sEndTime String specifying the end time in "hh:mm:ss:ff" format.
Return Value
No return value.
See Also
Starts playback from the previous chapter in the current title.
Syntax
MSWebDVD.PlayPrevChapter();
Return Value
No return value.
See Also
Retrieves the current state of the MSWebDVD object.
Syntax
[ iState = ] MSWebDVD.PlayState
Possible Values
iState Integer value representing the current state of the DVD Navigator. Can be -2 (Undefined), -1 (Uninitialized), 0 (Stopped), 1 (Paused), or 2 (Running). This property is read-only with no default value.
Remarks
The MSWebDVD object controls the DirectShow DVD Navigator filter, which does the actual work of DVD navigation. It is actually the state of the DVD Navigator that this property refers to. The DVD Navigator can be in one of several states, as described above. The PlayState property can be useful as a diagnostic tool, but generally there should be no reason for a scripting application to monitor the state of the DVD Navigator.
Starts playback at the beginning of the specified title.
Syntax
MSWebDVD.PlayTitle(iTitle);
Parameters
iTitle Integer value specifying the title.
Return Value
No return value.
See Also
Sets or retrieves the preferred subpicture stream for the current viewing session.
Syntax
[ iStream = ] MSWebDVD.PreferredSubpictureStream
Possible Values
iStream Integer value representing the current preferred subpicture stream in the MSWebDVD object, which might not be the same as the current default value for the preferred subpicture stream in the Microsoft® Windows® registry. The preferred subpicture stream is set with DVDAdm.DefaultSubpictureLCID.
Retrieves the ReadyState of the MSWebDVD object.
Syntax
[ iReadyState = ] MSWebDVD.ReadyState
Possible Values
iReadyState Integer value representing the control's ReadyState. Can be one of the following: READYSTATE_UNINITIALIZED = 0; READYSTATE_LOADING = 1; READYSTATE_LOADED = 2; READYSTATE_INTERACTIVE = 3; READYSTATE_COMPLETE = 4.
Remarks
This property is read-only with no default value.
The ReadyState property is exposed by any object embedded in a Web page. The values have the following meanings.
READYSTATE_UNINITIALIZED Default initialization state. READYSTATE_LOADING Object is loading its properties. READYSTATE_LOADED Object has been initialized. READYSTATE_INTERACTIVE Object is interactive, but not all its data is available. READYSTATE_COMPLETE Object has received all its data.
Initializes the DVD filter graph.
Syntax
MSWebDVD. Render(iRender = 0);
Parameters
iRender Integer value specifying whether the filter graph will be destroyed and rebuilt. This defaults to zero if no value is specified, which means that the filter graph will not be destroyed and rebuilt if it already exists. Specify 1 to force the graph to be destroyed and rebuilt.
Return Value
No return value.
Remarks
The Render method enables the MSWebDVD object to fully initialize the underlying DirectShow filter graph on startup. This eliminates the slight delay that otherwise occurs when the user issues the first command to play a disc or show a menu. There is no case in which Render needs to be called before calling any other method. For example, if the application calls PlayTitle before the filter graph has been initialized, the MSWebDVD object calls Render automatically before attempting to play the disc.
Starts playback at the beginning of the current chapter.
Syntax
MSWebDVD.ReplayChapter();
Return Value
No return value.
See Also
Displays a system dialog box that enables the user to change the region associated with the DVD drive.
Syntax
MSWebDVD.RegionChange();
Remarks
The region for a DVD drive can be changed only five times.
Return Value
No return value.
Moves the MSWebDVD object to the point on the disc as specified in the current bookmark, with all audio, video, and subpicture settings restored.
Syntax
MSWebDVD.RestoreBookmark();
Return Value
No return value.
Resumes playback after a menu has been displayed.
Syntax
MSWebDVD.Resume();
Return Value
No return value.
Returns display from a submenu to its parent menu, or to the current title if the menu is a top-level menu.
Syntax
MSWebDVD.ReturnFromSubmenu();
Return Value
No return value.
Saves the current disc position and state of the MSWebDVD object so the user can return to the same place later.
Syntax
MSWebDVD.SaveBookmark();
Return Value
No return value.
Remarks
A bookmark is a snapshot of the DVD Navigator's current state. This includes information such as where it is playing on the disc, and which audio and subpictures streams are selected. By saving a bookmark, the user can close the application, shut down the computer, and come back later to continue viewing the disc right where he or she left off, with all settings just as they were before. Only one bookmark can be saved at any given time. When you call SaveBookmark, the old bookmark is overwritten.
See Also
Selects and activates the specified button.
Syntax
MSWebDVD.SelectAndActivateButton(iButton);
Parameters
iButton Integer value specifying the button.
Return Value
No return value.
Remarks
Use this method when implementing custom mouse handling after setting DisableAutoMouseProcessing to true.
This method highlights the specified button and activate it automatically.
See Also
ButtonsAvailable, CurrentButton, ActivateButton, GetButtonAtPosition, GetButtonRect, SelectAtPosition
Selects the menu button at the specified mouse pointer coordinates.
Syntax
MSWebDVD.SelectAtPosition(xPos, yPos);
Parameters
xPos Integer value specifying the x-coordinate. yPos Integer value specifying the y-coordinate.
Return Value
No return value.
Remarks
Use this method when implementing custom mouse handling after setting DisableAutoMouseProcessing to true.
Selecting merely highlights the button. To send the command associated with a button that has been selected, call ActivateButton.
See Also
ButtonsAvailable, CurrentButton, GetButtonAtPosition, GetButtonRect, SelectAndActivateButton
Sets the current default audio language in the MSWebDVD object.
Syntax
MSWebDVD.SelectDefaultAudioLanguage(iLang, iExt);
Parameters
iLang Integer LCID value specifying the language. See the table under Working with LCIDs for possible values. iExt Integer value specifying the DVD audio language extension. See Remarks for possible values.
Remarks
Extension Value NotSpecified 0 Captions 1 VisuallyImpaired 2 DirectorComments1 3 DirectorComments2 4
Return Value
No return value.
Sets the current default subpicture language in the MSWebDVD object.
Syntax
MSWebDVD.SelectDefaultSubpictureLanguage(iLang,iExt);
Parameters
iLang Integer value specifying the language. iExt Integer value specifying the subpicture language extension. See Remarks for possible values.
Return Value
No return value.
Remarks
The subpicture language extension provides further information about the subpicture. The possible values are:
Extension Value Extension Not Specified 0 Normal Captions 1 Big Captions 2 Children's Captions 3 Normal Closed Captions 5 Big Closed Captions 6 Children's Closed Captions 7 Forced 9 Normal Director's Comments 13 Big Director's Comments 14 Children's Director's Comments 15
Selects the left directional button from the displayed menu.
Syntax
MSWebDVD.SelectLeftButton();
Return Value
No return value.
See Also
ActivateButton, SelectLowerButton, SelectRightButton, SelectUpperButton
Selects the lower directional button from the displayed menu.
Syntax
MSWebDVD.SelectLowerButton();
Return Value
No return value.
See Also
ActivateButton, SelectLeftButton, SelectRightButton, SelectUpperButton
Set the specified parental country for subsequent playback.
Syntax
MSWebDVD.SelectParentalCountry(iCountry, sUserName, sPassword);
Parameters
iCountry Integer value specifying the country. sUserName String value specifying the current logged-on user. (Currently ignored.) sPassword String value specifying the application password.
Return Value
No return value.
Remarks
The parental country determines how the parental levels are interpreted.
See Also
Enforcing Parental Management Levels, SelectParentalLevel, NotifyParentalLevelChange, GetTitleParentalLevels, GetPlayerParentalCountry, GetPlayerParentalLevel, AcceptParentalLevelChange
Sets the specified parental level for subsequent playback.
Syntax
MSWebDVD.SelectParentalLevel(iLevel, sUserName, sPassword);
Parameters
iLevel Integer value from 1 through 8 specifying the parental level. To disable parental management, set iLevel to -1. sUserName String value specifying the current user. (Currently ignored.) sPassword String value specifying the password currently stored in the registry.
Return Value
No return value.
Remarks
This method sets the access level in the MSWebDVD object, which determines what content the user can play back. Higher levels can play lower-level content but lower levels can't play higher-level content. The exact meaning of the eight DVD parental management levels varies depending on the country. In the United States and Canada, the levels are mapped to the Motion Picture Association of America (MPAA) rating categories. Parental management in the DVD Navigator is disabled by default.
See Also
Enforcing Parental Management Levels, SelectParentalCountry, NotifyParentalLevelChange, GetTitleParentalLevels, GetPlayerParentalCountry, GetPlayerParentalLevel, AcceptParentalLevelChange
Selects the right directional button from the displayed menu.
Syntax
MSWebDVD.SelectRightButton();
Return Value
No return value.
See Also
Working With Menus
ActivateButton, SelectLeftButton, SelectLowerButton, SelectUpperButton
Selects the upper directional button from the displayed menu.
Syntax
MSWebDVD.SelectUpperButton();
Return Value
No return value.
See Also
ButtonsAvailable, CurrentButton, ActivateButton, GetButtonAtPosition, GetButtonRect, SelectAndActivateButton, SelectAtPosition, SelectLeftButton, SelectLowerButton, SelectRightButton
Zooms the video display to the specified subrectangle.
Syntax
DVD.SetClipVideoRect(oRect);
Parameters
oRect DVDRect object specifying the clipping rectangle.
Return Value
No return value.
Remarks
When you set a new clipping rectangle, the object enlarges that area to fit within the application's overall display dimensions. This creates the effect zooming in on a particular area of the screen. To specify the rectangle, create a new DVDRect object and fill in its properties.
The most common rectangle for video display is 720 x 540.
See Also
Sets the delay time for the ToolTip associated with the MSWebDVD object.
Syntax
MSWebDVD.SetDelayTime(iDelayType, iNewVal)
Parameters
iDelayType Integer value specifying the type of delay. See Remarks. iNewVal Integer value specifying the delay, in milliseconds.
Return Value
No return value.
Remarks
The following table explains the possible values for iDelayType.
TTDT_AUTOPOP = 0 Set the length of time a ToolTip window remains visible if the pointer is stationary within a tool's bounding rectangle. To reset the autopop delay time to its default value, set iNewVal to -1. TTDT_INITIAL = 1 Set the length of time a pointer must remain stationary within a tool's bounding rectangle before the ToolTip window appears. To reset the initial delay time to its default value, set iNewVal to -1. TTDT_RESHOW = 2 Set the length of time it takes for subsequent ToolTip windows to appear as the pointer moves from one tool to another. To reset the reshow delay time to its default value, set iNewVal to -1. TTDT_AUTOMATIC = 3 Set all three delay times to default proportions. The autopop time is ten times the initial time and the reshow time is one fifth the initial time. If this flag is set, use a positive value of iNewVal to specify the initial time, in milliseconds. Set iNewVal to a negative value to return all three delay times to their default values.
Sets the specified general parameter register to the specified value.
Syntax
MSWebDVD.SetGPRM(iIndex, nValue)
Parameters
iIndex Integer value from 0 through 15 specifying the general parameter register to set. iValue Integer specifying the new value for the register.
Remarks
General parameter registers, or GPRMs, are 16-bit registers that each disc can use in unique ways for temporary data storage. A player application does not need to access these registers for any standard playback or navigation control using the MSWebDVD object. This method is provided for player applications implementing advanced functionality. Do not attempt to modify the GPRMs directly unless you have a thorough knowledge of the DVD specification and the ways in which the GPRMs are used on the particular disc to be played. Changing these values can result in unpredictable behavior.
Makes the cursor visible when the MSWebDVD object is in full-screen mode.
Syntax
MSWebDVD.ShowCursor(bShow);
Parameters
bShow Boolean value specifying whether to show the cursor.
Return Value
No return value.
Remarks
When the DVD display goes into full-screen mode, the cursor disappears within 3 to 5 seconds. Use this method to make the cursor visible again if your application's control buttons are visible in full-screen mode.
Displays the specified menu on the screen.
Syntax
MSWebDVD.ShowMenu(iMenuID);
Parameters
iMenuID Integer value specifying the menu. See Remarks for possible values.
Return Value
No return value.
Remarks
iMenuID must be one of the following values.
Menu type Value Title (Top) 2 Root 3 Subpicture 4 Audio 5 Angle 6 Chapter 7 DVD menu names can be somewhat confusing. The title menu is another name for the Video Manager Menu, the main menu for the entire disc; it generally lists all the video title sets available on the disc. The root menu is the menu for one video title set, which can contain one title or a group of titles. All the titles in a title set share the same Subpicture, Audio, and Angle menus.
Advances the DVD-Video stream by the specified number of frames.
Syntax
MSWebDVD.Step(iFrames)
Parameters
iFrames Integer value specifying the number of frames to step.
Return Value
No return value.
Remarks
Before calling this method, call CanStep to determine whether the decoder supports frame stepping.
If the DVD-Video is playing in reverse mode when this method is called, and the decoder supports reverse frame stepping, then the frame stepping is done in reverse.
Resumes playback, canceling still mode.
Syntax
MSWebDVD.StillOff();
Return Value
No return value.
Remarks
The DVD Navigator goes into still mode when it encounters a still frame authored on the disc. It notifies your application by sending an EC_DVD_STILL_ON event. Still mode is different from the DVD Navigator being in a paused state because of a user operation. Calling StillOff resumes playback from still mode but does not restart the DVD Navigator when it is in a paused state.
Stops playback.
Syntax
MSWebDVD.Stop();
Return Value
No return value.
Remarks
If EnableResetOnStop is set to true, calling Stop puts the DVD Navigator, along with the rest of the filter graph, into a stopped state, which means that the next time the user presses the Play button, playback starts at the beginning of the disc. If EnableResetOnStop is set to true, playback resumes where it left off when the user issues the next Play command.
Sets or retrieves the current subpicture state (on or off).
Syntax
[ bState = ] MSWebDVD.SubpictureOn
Possible Values
bState Boolean value indicating whether the subpicture is displayed.
Remarks
This property does not affect display of Closed Captions. Closed Captions are embedded within the video stream. DVD subpictures are transported on a separate stream.
This property is read/write with a default value of false.
Retrieves the number of subpicture streams available in the current title.
Syntax
[ iStreams = ] MSWebDVD.SubpictureStreamsAvailable
Possible Values
iStreams Integer value representing the number of available streams.
Remarks
This property is read-only with no default value. To query each stream for its language attribute, first call this method to get the upper bound. Stream numbering is zero-based.
Retrieves the number of titles available on the disc.
Syntax
[ iTitles = ] MSWebDVD.TitlesAvailable
Possible Values
iTitles Integer value from 1 through 99 representing the number of available titles.
Remarks
This property is read-only with no default value.
Sets the text for the ToolTip that appears when the mouse pointer is over the MSWebDVD video rectangle.
Syntax
[ sToolTip = ] MSWebDVD.ToolTip
Possible Values
sToolTip String value specifying the ToolTip text.
Remarks
This property is read/write with no default value. If the string is empty, no ToolTip appears.
Sets or retrieves the maximum width for the ToolTip associated with the MSWebDVD object.
Syntax
[ iMaxWidth = ] MSWebDVD.ToolTipMaxWidth
Possible Values
iMaxWidth Integer value representing the maximum width for the application's ToolTip.
Remarks
This property is read/write with a default value of 200 pixels.
Retrieves the total playback time for the current title.
Syntax
[ sTotalTime = ] MSWebDVD.TotalTitleTime
Possible Values
sTotalTime String value representing the total playing time of the current title, in the format "hh:mm:ss:ff".
Remarks
This property is read-only with no default value. The returned string will be 11 characters long in the format "hh:mm:ss:ff" (hours, minutes, seconds, frames).
See Also
Retrieves a value that indicates whether the specified user operation (UOP) is currently valid.
Syntax
[ bIsValid = ] MSWebDVD.UOPValid(iUOP);
Parameters
iUOP Integer value specifying the UOP. See Remarks for possible values.
Return Value
Returns a Boolean value indicating whether the specified operation is permitted by UOP control.
Remarks
The possible values of iUOP are defined as follows:
Value User function 0x0 PlayTitle, PlayAtTime PlayAtTimeInTitle 0x1 PlayChapter 0x2 PlayTitle 0x4 Stop 0x8 ReturnFromSubmenu 0x10 PlayChapter 0x20 PlayPrevChapter, ReplayChapter 0x40 PlayNextChapter 0x80 PlayForwards 0x100 PlayBackwards 0x200 ShowMenu with a parameter value of 2 (DVD_MENU_Title) 0x400 ShowMenu with a parameter value of 3 (DVD_MENU_Root) 0x800 ShowMenu with a parameter value of 4 (DVD_MENU_Subpicture) 0x1000 ShowMenu with a parameter value of 5 (DVD_MENU_Audio) 0x2000 ShowMenu with a parameter value of 6 (DVD_MENU_Angle) 0x4000 ShowMenu with a parameter value of 7 (DVD_MENU_Chapter) 0x8000 Resume 0x10000 SelectLeftButton, SelectRightButton,SelectUpperButton,SelectLowerButton 0x20000 StillOff 0x40000 Pause 0x80000 CurrentAudioStream 0x100000 CurrentSubpictureStream 0x200000 CurrentAngle, SelectParentalLevel 0x400000 KaraokeAudioPresentationMode
Sets or retrieves the speaker volume for the audio stream output.
Syntax
[ iVolume = ] MSWebDVD.Volume
Possible Values
iVolume Integer value representing the volume level as attenuation in decibels.
Remarks
This property is read/write with a default value of 0. Full volume is 0, and 10,000 is silence; the scale is logarithmic. Multiply the desired decibel level by 100 (for example 10,000 = 100 dB).
Retrieves the number of volumes in a multivolume set.
Syntax
[ iVolumes = ] MSWebDVD.VolumesAvailable
Possible Values
iVolumes Integer value representing the number of volumes in the set.
Remarks
This property is read-only with no default value. Some DVD titles might be released as a multidisc set or series. Use this method to determine the volume number for the current disc.
Initializes the MSWebDVD object at design time for either windowed or windowless mode.
Syntax
[ bWindowless = ] MSWebDVD.WindowlessActivation
Possible Values
bWindowless Boolean value indicating whether the object is in windowed mode.
Remarks
This property is read/write with a default value of true. Therefore, you only need to set this property if you are running the MSWebDVD object in a windowed container. When contained in a Web page in Microsoft® Internet Explorer, MSWebDVD is always in windowless mode, and you don't need to set this property.
Zooms the video display in or out, centered on a given set of screen coordinates.
Syntax
MSWebDVD.Zoom(iXPos, iYPos, iZoomRatio);
Parameters
iXPos Integer value specifying the x-coordinate at the center of the rectangular zoom area. iYPos Integer value specifying the y-coordinate at the center of the rectangle to be zoomed. iZoomRatio Number value specifying the magnification factor applied to the current zoom value. The total maximum value depends on what the hardware overlay can support; this is typically a factor of 32 to 64 times the original size.
Return Value
No return value.
Remarks
The new zoom ratio stays in effect until it is restored to the original size or changed again. In other words, two calls to this method specifying an iZoomRatio of two will result in a zoom ratio four times larger than the original video size. If the user tries to zoom beyond what the hardware can support, this method will succeed but do nothing.
The SetClipVideoRect method is another way to zoom in; the only difference between the two methods is the way in which the zoom rectangle is specified.