Platforms to show: All Mac Windows Linux Cross-Platform

Back to DVDPlaybackMBS class.

Previous items Next items

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
Gets the number of audio streams currently available.

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
Gets the number of chapters in the specified title.

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
Gets the number of subpicture streams currently available.

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
Gets the number of titles available on the media.

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
Returns the current scan direction and rate.

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
Returns the selected SPDIF capable audio device.

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
Gets the number of SPDIF capable audio devices.

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
Gets the name of a SPDIF capable audio device

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
Returns the current play state of the DVDPlayback framework.

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

The current play state of the framework.

Constants:
kDVDStateUnknown0
kDVDStatePlaying1playing 1x or less (slow mo)
kDVDStatePlayingStill2
kDVDStatePaused3pause and step frame
kDVDStateStopped4
kDVDStateScanning5playing greater than 1x
kDVDStateIdle6

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
Gets the subpicture language code and extension for the current subpicture stream.

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.

DVDPlaybackMBS.GetSubPictureLanguageCodeByStream(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 subpicture language code and extension for a specified subpicture stream.

StreamIndex: A subpicture stream number in the current title. Subpicture stream numbers range from 1 to 32.

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

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

Lasterror is set.

If subpictures are not available, this function does nothing and lasterror is not 0.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.GetSubPictureStream 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 subpicture stream.

Returns the identifier of the current subpicture stream, or 0 if the current title has no subpictures. 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.GetTime(timecode as Integer, byref time as Integer, byref frames 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 position in the current title in seconds relative to the requested time code (elapsed,remaining).

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

Constants:
kDVDTimeCodeUninitialized0
kDVDTimeCodeElapsedSeconds1
kDVDTimeCodeRemainingSeconds2
kDVDTimeCodeTitleDurationSeconds3only useable for GetTime
kDVDTimeCodeChapterElapsedSeconds4only useable for GetTime
kDVDTimeCodeChapterRemainingSeconds5only useable for GetTime
kDVDTimeCodeChapterDurationSeconds6only useable for GetTime

DVDPlaybackMBS.GetTimeEventRate 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 rate of the time event.

Returns the current interval between time events in milliseconds.

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

DVDPlaybackMBS.GetTitle 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 the current title.

Returns the current title number, or 0 if a menu is active. DVD-Video media can contain up to 99 titles.

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

DVDPlaybackMBS.GetVideoBounds(byref x as Integer, byref y as Integer, 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
Returns (in port coordinates) the rect used to play video.

Lasterror is set.
Requires Mac OS X 10.3.

DVDPlaybackMBS.GetVideoDisplay 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 graphics display for the current DVD-Video playback session.

Returns the display ID is set to the current video playback display.

Lasterror is set.

Before calling this function, you need to set the video playback display using SetVideoDisplay or SwitchToDisplay.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.GetVideoKeyColor as color

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 key color used by the video driver.

Available in Mac OS X v10.3 and later.
Deprecated in Mac OS X v10.5.
Not available to 64-bit applications.

This function does nothing and returns the color black.

DVDPlaybackMBS.GetVideoWindowID 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 window ID of the Cocoa window in use for DVD-Video playback.

Returns the window ID of the Cocoa window currently in use for DVD-Video playback, or zero if there is no Cocoa window.

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

DVDPlaybackMBS.GoBackOneLevel

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 a submenu is active, moves up one level in the same domain.

Lasterror is set.

This function is used to navigate one level up in a hierarchical structure in the same domain—for example, from a scene selection menu back to the main menu. This action is comparable to navigating upwards in the directory or folder hierarchy of a file system.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.GotoBookmark(Bookmark 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
Sets the video playback position using a bookmark, and resumes play.

This function is used when playing media on a DVD-Video disc. Before calling this function, the media needs to be open. This function uses the specified bookmark to set the video playback position, and begins playing the media.

Bookmark ist a binary string. Make sure you did not destroy it by an encoding conversion!

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

DVDPlaybackMBS.GoToMenu(menu 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
Jump to a particular menu (Root Menu,Sub Picture Menu, etc.).

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

DVDPlaybackMBS.HasMedia 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
Returns true if the playback framework has media to play and the framework had received an Open call on the media.

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

DVDPlaybackMBS.HasMenu(menu as Integer) 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
Returns if input menu type is available.

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

DVDPlaybackMBS.HasNextChapter 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
Returns true if there is a chapter after the current chapter.

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

DVDPlaybackMBS.HasPreviousChapter 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
Returns true if there is a chapter before the current chapter.

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

DVDPlaybackMBS.Idle

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 framework to get a consistent time to process at. (Might be removed in the future).

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

DVDPlaybackMBS.IsDisplayingSubPicture 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
Returns true if subpictures are currently being displayed.

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

DVDPlaybackMBS.IsMuted 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
Toggles the mute setting on or off.

Returns true if the playback volume is currently muted.
Requires Mac OS X 10.3 or newer.
Lasterror is set.

DVDPlaybackMBS.IsOnMenu(byref OnMenu as boolean, byref menu 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
Are we currently on a menu, and if so, which one.

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

DVDPlaybackMBS.IsPaused 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
Returns true if the framework has media and is paused.

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

DVDPlaybackMBS.IsPlaying 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
Returns true if the framework has media and is playing (even if paused).

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

DVDPlaybackMBS.IsSupportedDisplay(CGVideoDisplayHandle as Integer) 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 display is supported.

Lasterror is set.
Requires Mac OS X 10.3 or newer.
You can use the handle from a CGDisplayMBS object.

DVDPlaybackMBS.IsValidMedia(folder as folderitem) 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
Returns true if the folderitem points to a valid media layout.

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

Some examples using this method:

DVDPlaybackMBS.Lasterror 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 last error code reported.

Requires Mac OS X 10.3 or newer.

kDVDErrorUnknown-70001Catch all error
kDVDErrorInitializingLib-70002There was an error initializing the playback framework
kDVDErrorUninitializedLib-70003The playback framework has not been initialized.
kDVDErrorNotAllowedDuringPlayback-70004action is not allowed during playback
kDVDErrorUnassignedGrafPort-70005A grafport was not set.
kDVDErrorAlreadyPlaying-70006Media is already being played.
kDVDErrorNoFatalErrCallBack-70007The application did not install a callback routine for fatal errors returned by the framework.
kDVDErrorIsAlreadySleeping-70008The framework has already been notified to sleep.
kDVDErrorDontNeedWakeup-70009DVDWakeUp was called when the framework was not asleep.
kDVDErrorTimeOutOfRange-70010Time code is outside the valid range for the current title.
kDVDErrorUserActionNoOp-70011The operation was not allowed by the media at this time.
kDVDErrorMissingDrive-70012The DVD drive is not available.
kDVDErrorNotSupportedConfiguration-70013The current system configuration is not supported.
kDVDErrorNotSupportedFunction-70014The operation is not supported. For example, trying to slow mo backwards.
kDVDErrorNoValidMedia-70015The media was not valid for playback.
kDVDErrorWrongParam-70016The invalid parameter was passed.
kDVDErrorMissingGraphicsDevice-70017A valid graphics device is not available.
kDVDErrorGraphicsDevice-70018A graphics device error was encountered.
kDVDErrorPlaybackOpen-70019The framework is already open (probably by another process).
kDVDErrorInvalidRegionCode-70020The region code was not valid.
kDVDErrorRgnMgrInstall-70021The region manager was not properly installed or missing from the system.
kDVDErrorMismatchedRegionCode-70022The disc region code and the drive region code do not match.
kDVDErrorNoMoreRegionSets-70023The drive does not have any region changes left.
kDVDErrordRegionCodeUninitialized-70024The drive region code was not initialized.
kDVDErrorAuthentification-70025The user attempting to change the region code could not be authenticated.
kDVDErrorOutOfVideoMemory-70026The video driver does not have enough video memory available to playback the media.
kDVDErrorNoAudioOutputDevice-70027An appropriate audio output device could not be found.
kDVDErrorSystem-70028A system error was encountered.
kDVDErrorNavigation-70029The user has made a selection not supported in the current menu.

DVDPlaybackMBS.LastErrorString 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 an error message for the lasterror code.

Requires Mac OS X 10.3 or newer.

DVDPlaybackMBS.Mute(mute 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
Toggles the mute setting on or off.

mute: a boolean value that specifies whether to turn the mute setting on or off. To mute the video playback volume, pass TRUE. To restore the previous volume setting, pass FALSE.

Lasterror is set.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.NextChapter

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 to the next chapter on the current title.

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

DVDPlaybackMBS.OpenMediaFile(folder as folderitem)

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Opens a VIDEO_TS folder (can be on a hard drive or a dvd disc).

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

DVDPlaybackMBS.OpenMediaVolume(disc as folderitem)

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

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

Some examples using this method:

DVDPlaybackMBS.Pause

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Pauses the media if currently playing.

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

DVDPlaybackMBS.Play

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

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

DVDPlaybackMBS.PreviousChapter

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 to the previous chapter on the current title.

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

DVDPlaybackMBS.Resume

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Starts playing if currently paused.

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

DVDPlaybackMBS.ReturnToTitle

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 from the menu back to the current position within the title.

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

Previous items Next items

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


The biggest plugin in space...