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

Previous items

QTTrackMBS.SetAudioChannelLayout(labels() as integer)
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 8.3, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Sets the channel layout for a sound channel.
Example:
dim m as movie
dim f as FolderItem
dim i,c as integer
dim layout(1) as integer

const kAudioChannelLabel_Left = 1
const kAudioChannelLabel_Right = 2
const kAudioChannelLabel_Center = 3
const kAudioChannelLabel_LFEScreen = 4
const kAudioChannelLabel_LeftSurround = 5 // WAVE: "Back Left"
const kAudioChannelLabel_RightSurround = 6 // WAVE: "Back Right"
const kAudioChannelLabel_LeftCenter = 7
const kAudioChannelLabel_RightCenter = 8
const kAudioChannelLabel_CenterSurround = 9 // WAVE: "Back Center" or plain "Rear Surround"
const kAudioChannelLabel_LeftSurroundDirect = 10 // WAVE: "Side Left"
const kAudioChannelLabel_RightSurroundDirect = 11 // WAVE: "Side Right"
const kAudioChannelLabel_TopCenterSurround = 12
const kAudioChannelLabel_VerticalHeightLeft = 13 // WAVE: "Top Front Left"
const kAudioChannelLabel_VerticalHeightCenter = 14 // WAVE: "Top Front Center"
const kAudioChannelLabel_VerticalHeightRight = 15 // WAVE: "Top Front Right"

const kAudioChannelLabel_TopBackLeft = 16
const kAudioChannelLabel_TopBackCenter = 17
const kAudioChannelLabel_TopBackRight = 18

const kAudioChannelLabel_RearSurroundLeft = 33
const kAudioChannelLabel_RearSurroundRight = 34
const kAudioChannelLabel_LeftWide = 35
const kAudioChannelLabel_RightWide = 36
const kAudioChannelLabel_LFE2 = 37
const kAudioChannelLabel_LeftTotal = 38 // matrix encoded 4 channels
const kAudioChannelLabel_RightTotal = 39 // matrix encoded 4 channels
const kAudioChannelLabel_HearingImpaired = 40
const kAudioChannelLabel_Narration = 41
const kAudioChannelLabel_Mono = 42
const kAudioChannelLabel_DialogCentricMix = 43

const kAudioChannelLabel_CenterSurroundDirect = 44 // back center non diffuse

const kAudioChannelLabel_Haptic = 45

// first order ambisonic channels
const kAudioChannelLabel_Ambisonic_W = 200
const kAudioChannelLabel_Ambisonic_X = 201
const kAudioChannelLabel_Ambisonic_Y = 202
const kAudioChannelLabel_Ambisonic_Z = 203

// Mid/Side Recording
const kAudioChannelLabel_MS_Mid = 204
const kAudioChannelLabel_MS_Side = 205

// X-Y Recording
const kAudioChannelLabel_XY_X = 206
const kAudioChannelLabel_XY_Y = 207

// other
const kAudioChannelLabel_HeadphonesLeft = 301
const kAudioChannelLabel_HeadphonesRight = 302
const kAudioChannelLabel_ClickTrack = 304
const kAudioChannelLabel_ForeignLanguage = 305

// generic discrete channel
const kAudioChannelLabel_Discrete = 400

// numbered discrete channel
const kAudioChannelLabel_Discrete_0 = 65536
const kAudioChannelLabel_Discrete_1 = 65537
const kAudioChannelLabel_Discrete_2 = 65538
const kAudioChannelLabel_Discrete_3 = 65539
const kAudioChannelLabel_Discrete_4 = 65540
const kAudioChannelLabel_Discrete_5 = 65541
const kAudioChannelLabel_Discrete_6 = 65542
const kAudioChannelLabel_Discrete_7 = 65543
const kAudioChannelLabel_Discrete_8 = 65544
const kAudioChannelLabel_Discrete_9 = 65545
const kAudioChannelLabel_Discrete_10 = 65546
const kAudioChannelLabel_Discrete_11 = 65547
const kAudioChannelLabel_Discrete_12 = 65548
const kAudioChannelLabel_Discrete_13 = 65549
const kAudioChannelLabel_Discrete_14 = 65550
const kAudioChannelLabel_Discrete_15 = 65551

f=GetOpenFolderItem("")
if f=nil then Return

m=f.OpenAsMovie
if m=nil then
MsgBox "Failed to open movie: "+f.DisplayName
Return
end if


c=m.TrackCountMBS

for i=1 to c
dim t as QTTrackMBS

t=m.GetTrackIndexMBS(i)
if t<>nil then
'MsgBox t.MediaType
if t.MediaType="soun" then
if t.MediaSoundSampleDescription(1).ChannelCount=2 then
layout(0)=kAudioChannelLabel_Right
layout(1)=kAudioChannelLabel_Right
t.SetAudioChannelLayout layout
Title=str(t.Lasterror)
end if
end if
end if
next

MoviePlayer1.Movie=m

Notes:
Pass only the number of array values matching the number of sound channels in the audio.
Use the constants provided with the example code.
Lasterror is set.
QTTrackMBS.SetTextTrackAsChapterTrack(type as string, isChapterTrack as boolean)
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 8.4, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Set the (first) text track in the specified movie to be or not to be a chapter track for the (first) enabled track of the specified type.
Notes: Lasterror is set.
QTTrackMBS.SetTrackApertureModeDimensionsUsingSampleDescription as integer
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 8.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Sets a track's aperture mode dimensions using values calculated using a sample description.
Notes:
This function should be used to add information needed to support aperture modes to newly created tracks. This information is calculated using the track's first sample description is used.
Returns a QuickTime error code.
QTTrackMBS.SetTrackDimensions(width as integer, height as integer)
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 4.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Changes the track dimensions.
QTTrackMBS.SetTrackMatrix(x as integer, y as integer, w as integer, h as integer)
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 4.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Sets the destination rectangle for the track inside the movie rectangle.
Example:
Sub RepositionTimeCodeTrack()
// Find Time Code track and move/resize it as you like

dim q as QTTrackMBS
dim i,c as integer

c=myMovie.TrackCountMBS
for i=1 to c
q=myMovie.GetTrackIndexMBS(i)

if q.MediaType="tmcd" then
q.SetTrackMatrix 0,0,200,50
end if
next
End Sub

Notes: You can use this to have a movie with e.g. two video tracks and one for example in the center of the playing movie.
QTTrackMBS.SoundBalance as integer
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 3.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The balance of the sound.
Example:
dim ml,mr as movie
dim f as FolderItem
dim t as QTTrackMBS

f=DesktopFolder.Child("Left.aif")
ml=f.OpenAsMovie

f=DesktopFolder.Child("Right.aif")
mr=f.OpenAsMovie

t=mr.GetTrackIndexMBS(1) // first track
t.SoundBalance=127 // right only

t=ml.GetTrackIndexMBS(1) // first track
t.SoundBalance=-128 // left only

MoviePlayerr.movie=mr
MoviePlayerl.movie=ml

MoviePlayerl.play
MoviePlayerr.Play

Notes:
Range is from -128 to 127.
(Read and Write runtime property)
QTTrackMBS.SoundBass as integer
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 5.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The bass value of a sound track.
Example:
Sub SetMovieBass(m as movie, value as integer)
dim i,c as integer
dim t as QTTrackMBS

// walk through each track
c=m.TrackCountMBS
for i=1 to c
t=m.GetTrackIndexMBS(i)

// set value
t.SoundBass=value // for bass
next
End Sub

Notes:
The value is a short (-32767 to 32766), but the correct range is unknown.
Default value for a track is 0.
Lasterror is set.
(Read and Write runtime property)
QTTrackMBS.SoundGetEffectiveBalance as integer
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 3.3, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Gets the effective sound balance setting of a media handler used for this track.
Notes:
The Movie Toolbox returns the current balance setting of the media handler as a 16-bit, fixed-point value. The high-order 8 bits contain the integer part of the value; the low-order 8 bits contain the fractional part. Valid balance values range from -1.0 to 1.0. Negative values emphasize the left sound channel, and positive values emphasize the right sound channel; a value of 0 specifies neutral balance.

Introduced in QuickTime 4.
Lasterror is set.
QTTrackMBS.SoundGetEffectiveVolume as integer
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 3.3, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Gets the effective volume setting for the media handler used by this track.
Notes:
The media's current volume setting. This value is represented as a 16-bit, fixed-point number. The high-order 8 bits contain the integer portion; 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 4.
Lasterror is set.
QTTrackMBS.SoundGetEqualizerBandLevels(count as integer) as memoryblock
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 3.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Returns the current sound equalizer band levels.
Notes:
Returns a memoryblock with count bytes.
One byte for each band.
Returns nil on any error.
QTTrackMBS.SoundLevelMeterInfo(byref numChannels as integer, byref leftMeter as integer, byref rightMeter as integer)
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 3.3, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Gets the right and left sound level meter values for a media handler used by this track.
Notes:
numChannelsContains 1 for mono or 2 for stereo source.
leftMeterLeft meter level, 0-255 range.
rightMeterRight meter level, 0-255 range.

Introduced in QuickTime 4.
Lasterror is set.
QTTrackMBS.SoundLevelMeteringEnabled as boolean
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 3.3, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Wether sound level metering capability is enabled.
Notes:
The media's current volume setting. This value is represented as a 16-bit, fixed-point number. The high-order 8 bits contain the integer portion; 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 4.
Lasterror is set.
(Read and Write runtime property)
QTTrackMBS.SoundOutputComponentHandle as integer
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 3.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Which output component to use for sound output.
Notes:
You get such a handle from the QTComponentInformation class.
(Read and Write runtime property)
QTTrackMBS.SoundSetDefaultEqualizerBands as integer
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 3.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Initializes the sound equalizer bands.
Notes:
The band frequencies used here (these are the same bands used by QuickTime Player):
kBandFreq0&h00C8000000200 Hz
kBandFreq1&h0190000000400 Hz
kBandFreq2&h0320000000800 Hz
kBandFreq3&h0640000001600 Hz
kBandFreq4&h0C80000003200 Hz
kBandFreq5&h1900000006400 Hz
kBandFreq6&h3200000012800 Hz
kBandFreq7&h5208000021000 Hz
QTTrackMBS.SoundSetEqualizerBands(count as integer, values as memoryblock) as integer
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 3.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Initializes the sound equalizer bands.
Notes: Pass in a memoryblock with count integer values (4 byte per value) for the frequencies.
QTTrackMBS.SoundTreble as integer
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 5.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The treble value of a sound track.
Example:
Sub SetMovieTreble(m as movie, value as integer)
dim i,c as integer
dim t as QTTrackMBS

// walk through each track
c=m.TrackCountMBS
for i=1 to c
t=m.GetTrackIndexMBS(i)

// set value
t.SoundTreble=value // for bass
next
End Sub

Notes:
The value is a short (-32767 to 32766), but the correct range is unknown.
Default value for a track is 0.
Lasterror is set.
(Read and Write runtime property)
QTTrackMBS.TimeCodeAtTime(MediaTime as integer) as QTTimeCodeMBS
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 5.0, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Searches the time code at the given media time.
Notes:
Returns nil on any error.
Lasterror is set.
QTTrackMBS.TimeCodeToFrameNumber(timecode as QTTimeCodeMBS)
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 5.0, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Converts a timecode time value into its corresponding frame number.
Notes:
Uses the values from the timecode for the conversion and stores result in the frameNumber property.
Lasterror is set.
Requires QuickTime 3.
QTTrackMBS.TimeCodeToString(timecode as QTTimeCodeMBS) as string
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 5.0, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Converts a time value into a text string (HH:MM:SS.FF).
Notes:
Lasterror is set.
The passed in timecode is used to get the values for the conversion.
Returns an ASCII string.
If the timecode uses the dropframe technique, the separators are semicolons (;) rather than colons (:).
Requires QuickTime 3.
QTTrackMBS.TimeOffset as integer
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 4.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The time offset of the track within the movie.
Notes:
In timescale of the movie.
(Read and Write runtime property)
QTTrackMBS.TrackClipMask as picture
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 5.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The clip mask for this track.
Notes:
Pass nil to remove the mask.
Black parts in the mask are showed, white ones are invisible.
Returns nil on any error.
(Read and Write runtime property)
QTTrackMBS.TrackCreationTime as integer
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 4.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The track creation time.
QTTrackMBS.TrackEnabled as boolean
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 4.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: Whether a track is enabled.
Example:
t.TrackEnabled=true

Notes: (Read and Write runtime property)
QTTrackMBS.TrackHandle as Integer
property, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 3.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The handle for the track.
Notes: (Read and Write property)
QTTrackMBS.TrackID as integer
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 3.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The ID of the track.
QTTrackMBS.TrackModificationTime as integer
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 4.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The track modification time.
QTTrackMBS.TrackVolume as integer
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 3.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The sound volume for this track.
Example:
Title=str(MoviePlayer1.Position)+" "+str(MoviePlayer1.movie.GetTrackIndexMBS(1).TrackVolume)

Notes: (Read and Write runtime property)
QTTrackMBS.Width as integer
method, QuickTime, MBS QuickTime Plugin (QTMovie), class QTTrackMBS, Plugin version: 4.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.

Function: The width of the track media.
Notes:
Not valid for sound tracks.
(Read and Write runtime property)

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