Platforms to show: All Mac Windows Linux Cross-Platform
Back to DVDPlaybackMBS class.
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Lasterror is set.
Requires Mac OS X 10.3.
DVDAudioStreamFormat constants - The different possible audio stream formats.
| kDVDAudioUnknownFormat | 0 |
| kDVDAudioAC3Format | 1 |
| kDVDAudioMPEG1Format | 2 |
| kDVDAudioMPEG2Format | 3 |
| kDVDAudioPCMFormat | 4 |
| kDVDAudioDTSFormat | 5 |
| kDVDAudioSDDSFormat | 6 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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.
DVDPlaybackMBS.GetNumberOfAudioStreams 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 number of audio streams available in the current title.
Lasterror is set.
Before calling this function, DVD-Video media needs to be open.
Available in Mac OS X v10.3 and later.
DVDPlaybackMBS.GetNumberOfChapters(title 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 |
title: An integer in the range 1 to 99 that specifies a title on the current media.
Returns the number of chapters in the specified title.
Lasterror is set.
If the specified chapter does not exist, this function does nothing and returns an error.
Available in Mac OS X v10.3 and later.
Some examples using this method:
DVDPlaybackMBS.GetNumberOfSubPictureStreams 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 number of subpicture streams available in the current title. DVD-Video media supports up to 32 subpicture streams per title.
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.GetNumberOfTitles 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 number of titles on the current media in the range 0 to 99.
Lasterror is set.
Available in Mac OS X v10.3 and later.
Some examples using this method:
DVDPlaybackMBS.GetScanRate(byref scanrate as Integer, byref direction 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 |
Requires Mac OS X 10.3 or newer.
Lasterror is set.
DVDPlaybackMBS.GetSPDIFDataOutDevice 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 |
Lasterror is set.
DVDPlaybackMBS.GetSPDIFDataOutDeviceCount 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 |
Lasterror is set.
DVDPlaybackMBS.GetSPDIFDataOutDeviceName(index as Integer) 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 |
Lasterror is set.
DVDPlaybackMBS.GetState 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 |
Requires Mac OS X 10.3 or newer.
Lasterror is set.
The current play state of the framework.
Constants:
| kDVDStateUnknown | 0 | |
| kDVDStatePlaying | 1 | playing 1x or less (slow mo) |
| kDVDStatePlayingStill | 2 | |
| kDVDStatePaused | 3 | pause and step frame |
| kDVDStateStopped | 4 | |
| kDVDStateScanning | 5 | playing greater than 1x |
| kDVDStateIdle | 6 |
DVDPlaybackMBS.GetSubPictureLanguageCode(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 |
DVDLanguageCode: On return, the variable contains the language code for the current subpicture. For a list of possible values, see Language Codes.
DVDSubpictureExtensionCode: On return, the variable contains the extension code for the current subpicture. For a list of possible values, see Subpicture Extension Codes.
If subpictures are not available, this function does nothing and lasterror is set to 0.
Lasterror is set.
Available in Mac OS X v10.3 and later.
The items on this page are in the following plugins: MBS MacOSX Plugin.
