Platforms to show: All Mac Windows Linux Cross-Platform

Back to DVDPlaybackMBS class.

Next items

DVDPlaybackMBS.Available as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
True if the DVD playback is installed on this Mac.

Requires Mac OS X 10.3 or newer.

DVDPlaybackMBS.ClearLastPlayBookmark

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Sets the video playback position to the beginning of the disc.

This function sets the video playback position to the beginning of the disc, but does not begin playing the media. Calling this function is equivalent to calling the function DVDStop twice in succession. Before calling this function, media needs to be open.
Available in Mac OS X v10.4 and later.
Lasterror is set.

DVDPlaybackMBS.CloseMediaFile

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Closes a previously opened VIDEO_TS folder.

Requires Mac OS X 10.3 or newer.
Lasterror is set.

DVDPlaybackMBS.CloseMediaVolume

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Closes a previously opened DVD disc.

Requires Mac OS X 10.3 or newer.
Lasterror is set.

Some examples using this method:

DVDPlaybackMBS.DisplaySubPicture(value as boolean)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Turns the display of subpictures on or off.

value: A Boolean value that specifies whether to display subpictures in the current title. To display subpictures, specify TRUE. To hide subpictures, specify FALSE.

Lasterror is set.

Before calling this function, DVD-Video media needs to be open and video playback started. You can use this function to display or hide additional bitmap graphic elements such as subtitles.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.DoButtonActivate(inIndex as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Selects and activates a menu button by index.

InIndex: The 1-based index of the menu button the user has selected.

If the index coincides with an active button, this function executes the action corresponding to the button.

Available in Mac OS X v10.4 and later.

DVDPlaybackMBS.DoMenuCGClick(x as Double, y as Double) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
If the point (in window root view coordinates) coincides with a menu button, it will be selected.

Requires Mac OS X 10.5.
Lasterror is set.

DVDPlaybackMBS.DoMenuCGMouseOver(x as Double, y as Double) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
If the point (in window root view coordinates) coincides with a menu button, it will be hightlighted.

Requires Mac OS X 10.5.
Lasterror is set.

DVDPlaybackMBS.DoMenuClick(x as Integer, y as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
If the point (in port coordinates) coincides with a menu button, it will be selected.

Requires Mac OS X 10.3 or newer.
Lasterror is set.

Some examples using this method:

DVDPlaybackMBS.DoMenuMouseOver(x as Integer, y as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
If the point (in port coordinates) coincides with a menu button, it will be hightlighted and it's index returned in outIndex.

Requires Mac OS X 10.3 or newer.
Lasterror is set.

Some examples using this method:

DVDPlaybackMBS.DoUserNavigation(navigation as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Allows the user to navigate between menu buttons.

This is usually done using keyboard keys (arrow keys to move and Enter key to choose a menu item).
Requires Mac OS X 10.3 or newer.
Lasterror is set.

Constants:
kDVDUserNavigationMoveUp1
kDVDUserNavigationMoveDown2
kDVDUserNavigationMoveLeft3
kDVDUserNavigationMoveRight4
kDVDUserNavigationEnter5

DVDPlaybackMBS.EnableWebAccess(enable as boolean)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Turns DVD@ccess support on or off.

Lasterror is set.
Requires Mac OS X 10.3 or newer.

DVDPlaybackMBS.GetAngle as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Gets the camera angle displayed.

Returnsthe integer contains the 1-based index of the current camera angle.

Lasterror is set.

Before calling this function, DVD-Video media needs to be open and video playback started.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.GetAspectRatio as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Gets the aspect ratio of the current title or menu.

Returns the variable specifies the aspect ratio of the current title. For a list of possible aspect ratios see the aspect ration constants.

Lasterror is set.

The aspect ratio of the video can change whenever a different title or menu is displayed. You can use this function together with GetNativeVideoSize to calculate the bounds of the video area in a window.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.GetAudioLanguageCode(byref DVDLanguageCode as string, byref DVDSubpictureExtensionCode as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Gets the current audio language code and extension.

DVDLanguageCode: On return, the variable contains the language code for the current audio stream. For a list of possible values, see the Language Codes constants.

DVDSubpictureExtensionCode: On return, the variable contains the audio extension code for the current audio stream. For a list of possible values, see Audio Extension Codes constants.

Lasterror is set.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.GetAudioLanguageCodeByStream(StreamIndex as Integer, byref DVDLanguageCode as string, byref DVDSubpictureExtensionCode as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Gets the audio language code and extension for a specified stream.

StreamIndex: An integer in the range 1 to 8 that specifies an audio stream in the current title.

DVDLanguageCode: On return, the variable contains the language code for the specified audio stream. For a list of possible values, see Language Codes.

DVDSubpictureExtensionCode: On return, the variable contains the audio extension code for the specified audio stream. For a list of possible values, see Audio Extension Codes.

Lasterror is set.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.GetAudioOutputMode as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Gets the current audio mode setting.

Lasterror is set.

DVDPlaybackMBS.GetAudioOutputModeCapabilities as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns the current possible audio output mode possibilities.

Lasterror is set.

DVDPlaybackMBS.GetAudioStream as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Gets the audio stream currently being used.

Returns the number of the current audio stream, or 0 if the current title has no audio streams.

Lasterror is set.

Before calling this function, DVD-Video media needs to be open and video playback started.

DVDPlaybackMBS.GetAudioStreamFormat(byref outFormat as Integer, byref outBitsPerSample as Integer, byref outSamplesPerSecond as Integer, byref outChannels as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Gets the current audio format (AC3,for example).

Lasterror is set.
Requires Mac OS X 10.3.

DVDAudioStreamFormat constants - The different possible audio stream formats.

kDVDAudioUnknownFormat0
kDVDAudioAC3Format1
kDVDAudioMPEG1Format2
kDVDAudioMPEG2Format3
kDVDAudioPCMFormat4
kDVDAudioDTSFormat5
kDVDAudioSDDSFormat6

DVDPlaybackMBS.GetAudioStreamFormatByStream(index as Integer, byref outFormat as Integer, byref outBitsPerSample as Integer, byref outSamplesPerSecond as Integer, byref outChannels as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Gets the audio format for a specified stream.

index: An integer that specifies an audio stream in the current title.

outFormat: On return, the variable contains the audio format of the audio stream for the current title. For a list of possible formats, see "Audio Stream Formats."

outBitsPerSample: On return, the integer contains the number of bits per sample in the current audio stream.

outSamplesPerSecond: On return, the integer contains the number of samples per second in the current audio stream.

outChannels: On return, the integer contains the number of audio channels in the current audio stream.

Lasterror is set.

Before calling this function, DVD-Video media needs to be open.

Available in Mac OS X v10.4 and later.

DVDPlaybackMBS.GetAudioVolume as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Gets the current playback audio volume setting (0 - 255).

Returns the current playback volume in the range 0 to 255.

Lasterror is set.

This function passes back the current playback audio volume setting. For more information, see DVDSetAudioVolume.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.GetBookmark as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Requests a bookmark to the current play position.

This function is used when playing media on a DVD-Video disc. Before calling this function, the media needs to be open and playing. This function passes back a bookmark to the current play position in the current DVD-Video playback session.

For information about requesting a bookmark when the media is not playing, see GetLastPlayBookmark.

The result is a binary string!

Available in Mac OS X v10.4 and later.

DVDPlaybackMBS.GetButtoninfo(byref numberOfButtons as Integer, byref selectedButton as Integer, byref forcedActivateButton as Integer, byref userButtonOffset as Integer, byref numberOfUserButtons as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Gets information about all available menu buttons in the current title, domain, or content.

numberOfButtons: On return, the integer contains the number of buttons in the current menu.

selectedButton: On return, the integer contains the 1-based index of the selected button.

forcedActivateButton: On return, the integer contains the index of the button whose action is performed when a specified period of time elapses after the menu is first displayed.

userButtonOffset: On return, the integer contains the index of the first user-selectable button. If the number of user-selectable buttons in a menu is smaller than the total number of buttons, this index may be greater than zero.

numberOfUserButtons: On return, the integer contains the number of user-selectable buttons in the current menu.

Lasterror is set.

Available in Mac OS X v10.4 and later.

DVDPlaybackMBS.GetButtonPosition(index as Integer, byref x as Double, byref y as Double, byref w as Double, byref h as Double, byref autoAction as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Gets the position and default action of a menu button.

index: The zero-based index of a menu button. If your button index is 1-based, you should decrement the index before you pass it to this function.

x,y,w,h: On return, the rectangle contains the position and dimensions of the specified button in window local coordinates.

autoAction: On return, a value of 1 indicates the button is a forced activate button—that is, the button's action is executed immediately when the button is selected. A value of 0 indicates the button is not a forced activate button.

Lasterror is set.

Available in Mac OS X v10.4 and later.

DVDPlaybackMBS.GetChapter as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Gets the current chapter.

Lasterror is set.

Some examples using this method:

DVDPlaybackMBS.GetCurrentAudioVolume as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns the current video playback volume.

Lasterror is set.

Currently the minimum and maximum volumes are always 0 and 255.

DVDPlaybackMBS.GetDiscRegionCode as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Gets the region codes available on a DVD-Video disc.

Returns a bitfield that specifies one or more region codes. For more information about region codes, see Region Codes.

Lasterror is set.

This function passes back the region codes assigned to the DVD-Video disc that's currently in use. Before calling this function, you need to call the function DVDOpenMediaVolume to open the media folder on the disc.

To test whether a disc is authorized for playback in region n, you need to compute the bitwise AND of outCode with region code n. If the result is equal to region code n, the disc is authorized for playback in region n.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.GetDriveRegionCode(byref regioncode as Integer, byref NumberChangesLeft as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns the region code the drive is set to and how many changes are left.

Lasterror is set.
Requires Mac OS X 10.3.

Region Codes:
The drive region code must match the DVD disc region code. These calls allow getting the disc region code and getting or setting the drive region code.
NOTE:The drive region code is stored in the drive and can only be set a total of 5 times.
On the last time, the drive will be permanently locked to that region code.

DVDPlaybackMBS.GetFormatStandard as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Gets the video broadcast format of current DVD-Video media.

Returns the video broadcast format of the current media. For a list of possible values, see Video Broadcast Formats.

Lasterror is set.

This function determines which video broadcast format (NTSC or PAL) is used in the current media. Before calling this function, DVD-Video media needs to be open.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.GetGPRMValue(index as Integer) as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns the current value of a general parameter (GPRM) register.

index: An integer index that specifies the desired GPRM register. The valid range is 1 to 16.

Returns the current value of the specified GPRM register.

Lasterror is set.

Available in Mac OS X v10.4 and later.

DVDPlaybackMBS.GetLastPlayBookmark as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Requests a bookmark to the last play position.

Returnns a binary string!

Lasterror is set.
Available in Mac OS X v10.4 and later.

DVDPlaybackMBS.GetMaxAudioVolume as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns the maximum video playback volume

Lasterror is set.

Currently the minimum and maximum volumes are always 0 and 255.

DVDPlaybackMBS.GetMediaUniqueID as memoryblock

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Gets a unique identifier for a media folder.

Returns the unique identifier of the current media.

This function passes back a 64-bit identifier that can help you distinguish between different media folders. While the identifiers generated by this function are not guaranteed to be unique (see below), duplicate identifiers are extremely rare.

There are two known limitations of this function:

Two copies of the same DVD that are produced at different times do not necessarily have the same identifier. This can happen when the two media folders have minor differences.
Two different DVDs with similar content—collections of episodes from a television series, for example—do not always have different identifiers. This can happen when the two media folders are identical.

Available in Mac OS X v10.4 and later.

DVDPlaybackMBS.GetMediaVolumeName as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Gets the volume name of the current media.

This function passes back the media volume name as a string. This is the name seen on the desktop when Mac OS X mounts a DVD-Video disc.

Available in Mac OS X v10.4 and later.

DVDPlaybackMBS.GetMenuLanguageCode as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Gets the menu language code for the current title.

Returns the menu language code for the current title. For a list of possible values, see Language Codes.

Lasterror is set.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.GetMinAudioVolume as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns the minimum video playback volume.

Lasterror is set.

Currently the minimum and maximum volumes are always 0 and 255.

DVDPlaybackMBS.GetNativeVideoHeight as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns the native height of the current title.

Available in Mac OS X v10.3 and later.
Lasterror is set.

DVDPlaybackMBS.GetNativeVideoSize(byref w as Integer, byref h as Integer)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
The native video size.

Requires Mac OS X 10.3 or newer.
Lasterror is set.

DVDPlaybackMBS.GetNativeVideoWidth as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Returns the native width of the current title.

Available in Mac OS X v10.3 and later.
Lasterror is set.

DVDPlaybackMBS.GetNumberOfAngles as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Gets the number of camera angles currently available.

Returns the number of different camera angles in the current title. DVD-Video media supports up to 9 camera angles.

Lasterror is set.
Available in Mac OS X v10.3 and later.

Next items

The items on this page are in the following plugins: MBS MacOSX Plugin.


The biggest plugin in space...