MBS Plugin Documentation

Search:

Statistics   -   FAQ   -   Plugin Parts (All, Dependencies)   -   Class hierarchie

New in Version 7.0 7.1 7.2 7.3 7.4 7.5 7.6 7.7 7.8 8.0 8.1 8.2 8.3 8.4 8.5 8.6 8.7 9.0

The list of the   themes,   classes,   controls,   modules,   global methods by category,   global methods by name,   screenshots,   licenses   and   examples.

Platforms to show: All Mac Windows Linux Cross-Platform

Next items

QTGrabberMBS.AskAudioSettings
method, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Causes a sequence grabber to display its settings dialog box to the user.
Notes:
Sets lasterror property (-1 if function is not available or sequence grabber or the sound channel was not initialised).

Returns nil on any error.
Introduced in QuickTime 3 or earlier.

For some users this method fails to show the dialog if they loaded old settings from the preference file.
QTGrabberMBS.AskVideoSettings
method, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Causes a sequence grabber to display its settings dialog box to the user.
Notes:
Sets lasterror property (-1 if function is not available or sequence grabber or the video channel was not initialised).

Pauses the video before displaying the dialog and continues after the dialog is closed.

Returns nil on any error.
Introduced in QuickTime 3 or earlier.

For some users this method fails to show the dialog if they loaded old settings from the preference file.
QTGrabberMBS.AudioChannelHandle as integer
property, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The handle to the audio channel.
Notes:
A SGChannel reference for use in toolbox calls.
(Read only property)
QTGrabberMBS.AudioDevice as string
property, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The name of the current audio device.
Notes:
Sets lasterror property (-1 if function is not available or the audio channel is not initialized).

return "" on any error.
Introduced in QuickTime 3 or earlier.
(Read and write property)
(Read and Write property)
QTGrabberMBS.AudioDeviceInput as Integer
property, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 6.3, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The index of the current selected audio device input in the AudioDeviceList list.
Notes:
Lasterror is set.
Introduced in QuickTime 6.
(Read and Write property)
QTGrabberMBS.AudioDeviceInputName as String
property, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 6.3, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The name of the current audio device input.
Notes:
An input device (like Built-In) may have several inputs like "Line-In", "Digial-In" and "Microphone".

Lasterror is set.
Introduced in QuickTime 6.
(Read only property)
QTGrabberMBS.AudioDeviceList as QTGrabberDeviceListMBS
method, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Retrieves a list of the devices that are valid for an audio channel.
Notes:
Sets lasterror property (-1 if function is not available or sequence grabber was not initialised).

Returns nil on any error.
Introduced in QuickTime 3 or earlier.
QTGrabberMBS.AudioDeviceName as String
property, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 6.3, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The name of the current audio device.
Notes:
Lasterror is set.
Introduced in QuickTime 6.
(Read only property)
QTGrabberMBS.AudioInputRate as double
property, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The rate at which the sound channel is collecting sound data.
Notes:
Sets lasterror property (-1 if function is not available or the sound channel is not initialized).

return "" on any error.
Introduced in QuickTime 3 or earlier.
(Read and write property)
(Read and Write property)
QTGrabberMBS.AudioOutput as QTGrabberOutputMBS
property, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The output for the audio channel.
Notes:
Sets lasterror property (-1 if function is not available or the sound channel is not initialized).

Return nil on any error.
(Read and write property)
(Read and Write property)
QTGrabberMBS.AudioPlayFlags as integer
property, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The playback control flags.
Notes:
Sets lasterror property (-1 if function is not available or the video channel is not initialized).

Possible flags:

channelPlayNormal
Your channel component uses its default playback methodology.

channelPlayFast
Your channel component sacrifices playback quality to achieve the specified playback rate.

channelPlayHighQuality
Your channel component plays the channel's data at the highest possible quality. This option sacrifices playback rate for the sake of image quality. It may reduce the amount of processor time available to other programs in the computer. This option should not affect the quality of the recorded data, however.

channelPlayAllData
Your channel component tries to play all of the data it captures, even the data that is stored in offscreen buffers. This option is useful when you want to be sure that the user sees as much of the captured data as possible. The sequence grabber component sets this flag to 1 to play all the captured data. The sequence grabber component may combine this flag with any of the other values for the playFlags parameter.

channelPlayNormal0
channelPlayFast1
channelPlayHighQuality2
channelPlayAllData4

Introduced in QuickTime 3 or earlier.
(Read and write property)
(Read and Write property)
QTGrabberMBS.AudioSettings as string
property, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Current audio settings used by the sequence grabber.
Notes:
Sets lasterror property (-1 if function is not available or the sequence grabber is not initialized).

return "" on any error.
Introduced in QuickTime 3 or earlier.
(Read and write property)
(Read and Write property)
QTGrabberMBS.AudioTimeScale as integer
property, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Lets the sequence grabber retrieve the audio channel's time scale.
Notes:
Sets lasterror property (-1 if function is not available or the audio channel is not initialized).

Introduced in QuickTime 3 or earlier.
(Read only property)
QTGrabberMBS.AudioUsage as integer
property, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: How you like to
Notes:
Sets lasterror property (-1 if function is not available or the sound channel is not initialized).

Return -1 on any error.
(Read and write property)

Possible values:

seqGrabRecord1This flag is set to 1 if your channel is being used for recording.
seqGrabPreview2This flag is set to 1 if your channel is being used for previewing.
seqGrabPlayDuringRecord4This flag is set to 1 if your channel plays its captured data during a record operation.
seqGrabLowLatencyCapture8return the freshest frame possible, for live work (videoconferencing, live broadcast, live image processing)
seqGrabAlwaysUseTimeBase16Tell VDIGs to use TimebaseTime always, rather than creating uniform frame durations, for more accurate live sync with audio
(Read and Write property)
QTGrabberMBS.AudioVolume as integer
property, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Determines a channel's sound volume setting.
Example:
q.AudioVolume=256*0.5 // multiply with 256; 0.5 is for 50%

Notes:
Sets lasterror property (-1 if function is not available or the video channel is not initialized).

An integer for volume setting of the channel represented as a 16-bit, fixed-point number. The high-order 8 bits contain the integer part of the value; the low-order 8 bits contain the fractional part. Volume values range from -1.0 to 1.0. Negative values play no sound but preserve the absolute value of the volume setting.

Introduced in QuickTime 3 or earlier.
(Read and write property)
(Read and Write property)
QTGrabberMBS.AverageFPS as Double
property, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 8.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The average FPS value measured for the video.
Notes: (Read and Write property)
class QTGrabberMBS
class, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: A class for a QuickTime Sequence Grabber.
Notes:
Documentation from Apple is available on their website. For example here:
<http://developer.apple.com/techpubs/quicktime/qtdevdocs/INMAC/QTC/imSeqGrabChanComp.1.htm>

You may for Windows need a VDIG to add the normal Windows cameras to QuickTimes devices. Such a VDIG is sold e.g. by <http://www.abstractplane.com.au/products_vdig.jsp>.
QTGrabberMBS.close
method, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The destructor.
Notes:
There is no need to call this method except you want to free all resources of this object now without waiting for Realbasic to do it for you.
(e.g. some Realbasic versions crash on Windows if there are plugin objects not closed.)
QTGrabberMBS.CreateEmptyMovie(file as folderitem)
method, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Creates an empty movie file.
Notes:
Sets lasterror property.
(Lasterror is set to -1 if the function is not available or file is nil or not valid).

Introduced in QuickTime 3 or earlier.
QTGrabberMBS.CurrentFrame as Picture
property, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 8.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The last picture which has been captured.
Notes: (Read only property)
QTGrabberMBS.DataRate as integer
property, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Determines for a sequence grabber how much bytes is processed per second.
Notes:
Sets lasterror property (-1 if function is not available or the sound channel is not initialized).

Introduced in QuickTime 3 or earlier.
(Read only property)
QTGrabberMBS.FPS as Double
property, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 8.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The current FPS value measured for the video.
Notes: (Read and Write property)
QTGrabberMBS.Framerate as Double
property, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The video channel's frame rate for recording.
Example:
Framerate=10.0 // 10 fps

Notes:
Sets lasterror property (-1 if function is not available or the video channel is not initialized).

Introduced in QuickTime 3 or earlier.
(in plugin version before 6.3 the value needed to be multiplied with 65536)
(Read and Write property)
QTGrabberMBS.GetAudioInputParameters(byref Samplesize as integer, byref numchannels as integer, byref CompressionType as string)
method, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Retrieves various parameters that relate to sound recording.
Notes:
Sets lasterror property (-1 if function is not available or sound channel was not initialised).

SampleSize is 8 or 16.
numchannels is 1 or 2.

Possible values for CompressionType:

"raw "Sound samples are uncompressed, in offset-binary format (that is, sample data values range from 0 to 255).
"MAC3"Sound samples have been compressed by the Sound Manager at a ratio of 3:1.
"MAC6"Sound samples have been compressed by the Sound Manager at a ratio of 6:1.

Introduced in QuickTime 3 or earlier.
QTGrabberMBS.GetDataOutput(byref file as folderitem, byref flags as integer)
method, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Determines the movie file that is currently assigned to a sequence grabber component and the control flags that would govern a record operation.
Notes:
Sets lasterror property (-1 if function is not available or sequence grabber was not initialised).

Introduced in QuickTime 3 or earlier.

See SetDataOutput for the flags.
QTGrabberMBS.GetMovie as movie
method, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Returns a reference to the movie that contains the data collected during a record operation.
Notes:
Sets lasterror property (-1 if function is not available or sequence grabber was not initialised).

Returns nil on any error.
Introduced in QuickTime 3 or earlier.
QTGrabberMBS.GetSoundLevelMeterValue as integer
method, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 3.3, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The current sound level meter value.
Notes:
Only for one channel.
Lasterror is set.
QTGrabberMBS.Idle
method, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 8.5, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Gives CPU time to the grabber.
Notes: The plugin automatically gives time to the grabber.
QTGrabberMBS.InitFrameBuffer(width as integer, height as integer) as boolean
method, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 8.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Creates the back buffer used for capturing frames.
Notes:
That buffer is used to fill the currentframe picture property.
Returns true on success and false on failure.
QTGrabberMBS.InitGrabber
method, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Initializes the sequence grabber component.
Notes: Sets lasterror property (-1 if function is not available).
QTGrabberMBS.InitSound
method, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Creates the sound channel.
Notes:
Sets lasterror property (-1 if function is not available).
The volume is set to a low value and additional sound rates are added (8, 11, 16, 22 and 32 kHz).
Channel Usage is set to Preview and Record.

In case you get lasterror with value -9405 which means "couldntGetRequiredComponent" you have as a possible solution in case you really have recording hardware, that the QuickTime installation is without Authoring Support. The default QuickTime Installation installs only software needed for playing movies and displaying picture, but not to record them. You may need to do a custom installation to have the Authoring Support files installed.
QTGrabberMBS.InitVideo
method, QuickTime Sequence Grabber, MBS QuickTime Plugin (QTGrabber), class QTGrabberMBS, Plugin version: 2.7, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Creates the video channel.
Notes:
Sets lasterror property (-1 if function is not available).
Sets channel bounds to video source bounds.
Channel Usage is set to Preview, Record and PlayDuringRecord.

In case you get lasterror with value -9405 which means "couldntGetRequiredComponent" you have as a possible solution in case you really have recording hardware, that the QuickTime installation is without Authoring Support. The default QuickTime Installation installs only software needed for playing movies and displaying picture, but not to record them. You may need to do a custom installation to have the Authoring Support files installed.

Previous items Next items

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