Platforms to show: All Mac Windows Linux Cross-Platform

Back to DVDPlaybackMBS class.

Previous items

DVDPlaybackMBS.SetAngle(angle 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
Sets the camera angle to display.

angle: A 1-based index that specifies the camera angle to display. The angle number of the main angle is 1. DVD-Video media supports up to nine camera angles.

Lasterror is set.
Before calling this function, DVD-Video media needs to be open and video playback started. The DVD-Video author decides how many camera angles are used. If the specified angle does not exist, this function does nothing.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.SetAspectRatio(AspectRatio 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
Sets the aspect ratio for the current title.

AspectRatio: A constant that specifies the desired aspect ratio for the current title. For a list of possible values, see Aspect Ratios.

Lasterror is set.
This function does nothing and returns noErr.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.SetAudioOutputMode(Mode 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
Set the audio mode.

Lasterror is set.

DVDPlaybackMBS.SetAudioStream(index 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
Sets the audio stream to use.

index: An integer from 1 to 8 that specifies an audio stream in the current title. DVD-Video media supports up to 8 audio 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.SetAudioVolume(Volume 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
Sets the playback audio volume setting (0 - 255).

Volume: An integer in the range 0 to 255 that specifies the new video playback volume setting. Larger values are clamped to 255.

Lasterror is set.

This function changes the current playback audio volume setting, not the system audio volume setting. The actual audio volume experienced by the user is a function of these two settings:

Actual audio volume = system volume * playback audio volume / 255

For example, if you set the playback volume to 127, the actual volume is approximately one-half the current system volume.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.SetChapter(Chapter 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
Sets the chapter to play.

Chapter: An integer that specifies the chapter to play.

Lasterror is set.
This function defines the specified chapter to be the current video playback chapter. If video playback is paused, this function starts playing the chapter immediately. Note that some discs do not allow jumping directly to a chapter.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.SetDefaultAudioLanguageCode(DVDLanguageCode as string, 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
Sets the default audio language code and extension.

DVDLanguageCode: A constant that specifies the default audio language for the specified audio extension.. For a list of possible values, see Language Codes. If no language is specified—that is, if you pass in kDVDLanguageNoPreference or kDVDLanguageCodeNone—the default audio language is matched to the language setting in the International Preferences Panel.

DVDSubpictureExtensionCode: A constant that specifies an audio extension. For a list of possible values, see Audio Extension Codes.

Lasterror is set.

This function selects an audio language other than the DVD's default language for a specified audio extension. Before calling this function, DVD-Video media needs to be open.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.SetDefaultMenuLanguageCode(Code 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 default menu language code.

Code: An integer code that specifies the default menu language for the current title. For a list of possible values, see "Language Codes." If no language is specified—that is, if you pass in kDVDLanguageNoPreference or kDVDLanguageCodeNone—the default menu language is matched to the language setting in the International Preferences Panel.

Lasterror is set.

This function selects a language other than the DVD's default language for menus in the current title. Before calling this function, DVD-Video media needs to be open and video playback stopped.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.SetDefaultSubPictureLanguageCode(DVDLanguageCode as string, 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
Sets the default subpicture language and extension when subpictures are enabled.

DVDLanguageCode: A constant that specifies the default language for the specified subpicture extension. For a list of possible values, see "Language Codes." If no language is specified—that is, if you pass in kDVDLanguageNoPreference or kDVDLanguageCodeNone—the default subpicture language code is matched to the language setting in the International Preferences Panel.

DVDSubpictureExtensionCode: A constant that specifies a subpicture extension. For a list of possible values, see "Subpicture Extension Codes."

Lasterror is set.
If the current title is playing, this function does nothing and lasterror is set to kDVDErrorAlreadyPlaying.

This function is used to select a subpicture language other than the system default language. Before calling this function, DVD-Video media needs to be open and video playback stopped.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.SetDriveRegionCode(regioncode as Integer, AuthorizationHandle 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
Sets the drive region code (requires user authentication).

Lasterror is set.
Requires Mac OS X 10.3.

DVDRegionCode constants - The different possible region codes (used for both the disc and the drive):

kDVDRegionCodeUninitialized&hff
kDVDRegionCode1&hfe
kDVDRegionCode2&hfd
kDVDRegionCode3&hfb
kDVDRegionCode4&hf7
kDVDRegionCode5&hef
kDVDRegionCode6&hdf
kDVDRegionCode7&hbf
kDVDRegionCode8&h7f

DVDPlaybackMBS.SetLastPlayBookmark(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.

Lasterror is set.

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, but does not begin playing the media. See also GotoBookmark.

Available in Mac OS X v10.4 and later.

DVDPlaybackMBS.SetScanRate(scanrate as Integer, 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
Fast forwards or rewinds depending on the direction parameter at the speed specified in the scanrate parameter.

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

The rate at which to scan:
kDVDScanRateOneEigth-8
kDVDScanRateOneFourth-4
kDVDScanRateOneHalf-2
kDVDScanRate1x1
kDVDScanRate2x2
kDVDScanRate4x4
kDVDScanRate8x8
kDVDScanRate16x16
kDVDScanRate32x32

Direction constants:
kDVDScanDirectionForward0
kDVDScanDirectionBackward1

DVDPlaybackMBS.SetSPDIFDataOutDevice(Device 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 a SPDIF capable audio device.

Lasterror is set.

DVDPlaybackMBS.SetSubPictureStream(index 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
Sets the current subpicture stream.

index: A positive integer that specifies the subpicture stream to display. Subpicture stream numbers range from 1 to 32.

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.SetTime(timecode as Integer, time as Integer, 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
Sets the current playback position in the current title based on a time position in seconds relative to the time code (elapsed,remaining).

timecode: A time code constant. You must specify one of two values: kDVDTimeCodeElapsedSeconds or kDVDTimeCodeRemainingSeconds.

time: An integer that specifies the position in seconds.

frames: An integer that specifies the frame number. For the NTSC video format, the range of frame numbers is 0 to 29. For the PAL format, the range is 0 to 24.

his function sets the video playback position in the current title. Not all titles permit this operation, so it's important to check the result code returned by this function.

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

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

DVDPlaybackMBS.SetTimeEventRate(rate 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
Sets the rate of the DVD Playback time event.

The new interval between time events, specified in milliseconds.

Lasterror is set.

The default interval between DVD Playback time events is 900 milliseconds. You can use this function to lengthen or shorten the interval between time events. This function is relevant when you have used the function DVDRegisterEventCallBack to register a callback for one or both of the time events: kDVDEventTitleTime and kDVDEventChapterTime . Time event callbacks are typically used for tasks such as updating the elapsed time or remaining time displayed in your user interface.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.SetTitle(Title 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
Sets the title to play.

Title: An integer in the range 1 to 99 that specifies the title to play.

Lasterror is set.
If the specified title exists on the current media and the media permits this operation, this function begins playing the title.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.SetVideoBounds(x as Integer, y as Integer, w as Integer, 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
Sets the bounds in which to display the video.

x,y,w,h: A rectangle that contains the desired bounds in window local coordinates.

Lasterror is set.

This function is used to set the area inside the current window in which to display the video. The video area is not required to fill the entire window. Generally you should set the video area to be smaller than the window whenever the aspect ratio of the current title and window are different. To find the aspect ratio of the current title, use the function GetAspectRatio.

Because the aspect ratios of the titles in a DVD-Video media folder are not always the same, you may need to call this function repeatedly to reset the video area as the user makes different viewing choices.

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

Some examples using this method:

DVDPlaybackMBS.SetVideoDisplay(CGVideoDisplayHandle 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
Sets the graphics display for the current DVD-Video playback session.

The Quartz display ID for the graphics display you want to use for video playback. For information about how to get a display ID, see Quartz Display Services Reference. (or CGDisplayMBS class)

Lasterror is set.

You need to call this function or DVDSetVideoDevice each time you move the video playback window to a new graphics display. To avoid degrading video performance, you should not attempt to draw a video playback window that spans two different displays.

Available in Mac OS X v10.3 and later.

DVDPlaybackMBS.SetVideoWindowID(WindowID 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
Enables or disables DVD-Video playback in a Cocoa window.

WindowID: The window ID associated with a Cocoa window, or NULL. For information about when to pass 0, see the Discussion below.

Lasterror is set.

If you're using a Cocoa window for DVD-Video playback, you need to use this function in two different situations:

Immediately after calling the constructor to start a new DVD-Video playback session, you should call this function and pass the window ID associated with the Cocoa window.

When video is not playing and you want to draw into the area of the window you set by calling the function SetVideoBounds, you should call this function and pass 0 in the inVidWindowID parameter.

To learn how to obtain the window number for a Cocoa window, see the description of the windowNumber method in the NSWindow class.

Availability
Available in Mac OS X v10.3 and later.

Some examples using this method:

DVDPlaybackMBS.Sleep

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Call when system is putting machine to sleep so playback information can be saved.

Requires Mac OS X 10.3 or newer.
Lasterror is set.
The client must register for sleep notifications with the system so that it can notify the framework of sleep and wake notifications.

DVDPlaybackMBS.StepFrame(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
Steps one frame in the direction specified in DVDScanDirection.

Requires Mac OS X 10.3 or newer.
Lasterror is set.
Currently only supports kDVDScanDirectionForward.

DVDPlaybackMBS.Stop

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

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

DVDPlaybackMBS.SwitchToDisplay(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
Switches the output to the given display.

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

DVDPlaybackMBS.UpdateVideo

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Forces the video to be updated.

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

DVDPlaybackMBS.WakeUp

Type Topic Plugin Version macOS Windows Linux iOS Targets
shared method DVD Playback MBS MacOSX Plugin 9.2 ✅ Yes ❌ No ❌ No ❌ No Desktop only
Call when system is waking up so playback information can be reset.

Requires Mac OS X 10.3 or newer.
Lasterror is set.
The client must register for sleep notifications with the system so that it can notify the framework of sleep and wake notifications.

Previous items

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


The biggest plugin in space...