MBS Plugin Documentation
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
method, QuickTime, MBS QuickTime Plugin (QTMovies), class Movie, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Returns true if the movie contains this mediatype.
Notes:
Possible codes:
| Video | vide |
| Sound | soun |
| Text | text |
| Base | gnrc |
| MPEG | MPEG |
| Music | musi |
| TimeCode | tmcd |
| Sprite | sprt |
| Flash | flsh |
| Movie | moov |
| Tween | twen |
| ThreeDee | qd3d |
| ResourceData | rsrc |
| URLData | url |
| WiredAction | wire |
method, QuickTime, MBS QuickTime Plugin (QTMovies), class Movie, Plugin version: 3.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Returns true if the movie is on it's end.
Notes:
Returns false on any error.
Does not work if movie.handle is 0. You can use e.g. OpenAsMovieMBS which returns a movie with handle<>0.
method, QuickTime, MBS QuickTime Plugin (QTMovies), class Movie, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Returns true if the movie is a QTVR movie.
method, QuickTime, MBS QuickTime Plugin (QTMovies), class Movie, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Returns true if the movie is a streamed movie.
method, QuickTime, MBS QuickTime Plugin (QTMovies), class movie, Plugin version: 2.9, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Loads the movie within the time bounds into memory.
Notes:
Flags:
| keepInRam | 1 | Renders all data loaded with this flag set as nonpurgeable. Nonpurgeable data is not released from memory until you request it explicitly. This practice can fill up the user's heap very quickly; exercise caution. |
| unkeepInRam | 2 | Renders all indicated data purgeable. The data is not necessarily released from memory immediately, however. Information about whether a chunk can be purged is maintained internally by a single bit. This means there is no counter. Therefore, if you care very much about the data, you have to work very hard and use the edit list meticulously. |
| flushFromRam | 4 | Purges all indicated data from memory, unless it is currently in use by a media handler (for example, if it is still drawing frames from the requested times). This flag makes the memory available for purging, and then performs the purge. You may want to use this option if you are particularly low on memory. |
| loadForwardTrackEdits | 8 | In some cases, an edited movie plays back much more smoothly if the data around edits is already in RAM. By setting either this flag or the loadBackwardTrackEdits flag, you can load only the data around edits. The Movie Toolbox walks through the edits and decides the right amount of data to load for you. If you are going to play the movie forward, set only the loadForwardTrackEdits flag. If you are going to play in both directions, or you don't know which direction, set both flags. |
| loadBackwardTrackEdits | 16 | In some cases, an edited movie plays back much more smoothly if the data around edits is already in RAM. By setting either this flag or loadForwardTrackEdits, you can load only the data around edits. The Movie Toolbox walks through the edits and decides the right amount of data to load for you. If you are going to play the movie only backward, set the loadBackwardTrackEdits flag. If you are going to play in both directions, or you don't know which direction, set both flags. |
Returns -1 if QuickTime is not available. Any other value is a Mac OS error code.
Does not work if movie.handle is 0. You can use e.g. OpenAsMovieMBS which returns a movie with handle<>0.
method, QuickTime, MBS QuickTime Plugin (QTMovies), class movie, Plugin version: 2.9, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Loads the movie within the time bounds into memory.
Notes:
Flags:
| keepInRam | 1 | Renders all data loaded with this flag set as nonpurgeable. Nonpurgeable data is not released from memory until you request it explicitly. This practice can fill up the user's heap very quickly; exercise caution. |
| unkeepInRam | 2 | Renders all indicated data purgeable. The data is not necessarily released from memory immediately, however. Information about whether a chunk can be purged is maintained internally by a single bit. This means there is no counter. Therefore, if you care very much about the data, you have to work very hard and use the edit list meticulously. |
| flushFromRam | 4 | Purges all indicated data from memory, unless it is currently in use by a media handler (for example, if it is still drawing frames from the requested times). This flag makes the memory available for purging, and then performs the purge. You may want to use this option if you are particularly low on memory. |
| loadForwardTrackEdits | 8 | In some cases, an edited movie plays back much more smoothly if the data around edits is already in RAM. By setting either this flag or the loadBackwardTrackEdits flag, you can load only the data around edits. The Movie Toolbox walks through the edits and decides the right amount of data to load for you. If you are going to play the movie forward, set only the loadForwardTrackEdits flag. If you are going to play in both directions, or you don't know which direction, set both flags. |
| loadBackwardTrackEdits | 16 | In some cases, an edited movie plays back much more smoothly if the data around edits is already in RAM. By setting either this flag or loadForwardTrackEdits, you can load only the data around edits. The Movie Toolbox walks through the edits and decides the right amount of data to load for you. If you are going to play the movie only backward, set the loadBackwardTrackEdits flag. If you are going to play in both directions, or you don't know which direction, set both flags. |
Returns -1 if QuickTime is not available. Any other value is a Mac OS error code.
Does not work if movie.handle is 0. You can use e.g. OpenAsMovieMBS which returns a movie with handle<>0.
method, QuickTime, MBS QuickTime Plugin (QTMovies), class movie, Plugin version: 5.4, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Queries the load state of the movie.
Notes:
Please do not attach not loaded movies to the movieplayer control.
| kMovieLoadStateError | = -1 |
| kMovieLoadStateLoading | = 1000 |
| kMovieLoadStateLoaded | = 2000 |
| kMovieLoadStatePlayable | = 10000 |
| kMovieLoadStatePlaythroughOK | = 20000 |
| kMovieLoadStateComplete | = 100000 |
method, QuickTime, MBS QuickTime Plugin (QTMovies), class movie, Plugin version: 8.0, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Whether the movie should loop.
Example:
dim f as FolderItem
dim m as EditableMovie
f=DesktopFolder.Child("test.mov")
m=f.OpenEditableMovie
// 0 = looping
// 1 = palindrome
// 2 = no looping
m.LoopingMBS=1
call m.CommitChanges
Notes: 0 - normal looping
1 - palindrome looping
2 - no looping
(Read and Write runtime property)
method, Quicktime, MBS QuickTime Plugin (QTMovie), class movie, Plugin version: 6.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: The metadata of the movie.
Notes:
Returns nil on any error.
Requires QuickTime 7.
method, QuickTime, MBS QuickTime Plugin (QTMovies), class Movie, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Returns true if the movie contains a sound track.
method, QuickTime, MBS QuickTime Plugin (QTMovies), class Movie, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Returns true if the movie contains a timecode track.
method, QuickTime, MBS QuickTime Plugin (QTMovies), class movie, Plugin version: 4.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: The height of the movie.
Notes:
In contrast to this property, RB's movie width/height properties are cached.
Does not work if movie.handle is 0. You can use e.g. OpenAsMovieMBS which returns a movie with handle<>0.
(Read and Write runtime property)
Some examples which use this method:
method, QuickTime, MBS QuickTime Plugin (QTMovies), class movie, Plugin version: 2.9, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Returns the picture of the movie for the given position in time units.
Example:
backdrop=m.MoviePictureFrames(5*m.timescale) // 5th second
Notes: Returns nil on low memory.
The picture returned is a Pichandle picture, so you may use the picture.bitmap function if you want a picture you can edit or save as JPEG.
This function can be very slow because it may be necessary to render this picture from the last 20 pictures.
Some examples which use this method:
method, QuickTime, MBS QuickTime Plugin (QTMovies), class Movie, Plugin version: 2.8, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Returns the picture of the movie for the given position in seconds.
Example:
backdrop=m.MoviePicture(5) // 5th second
Notes: Returns nil on low memory.
The picture returned is a Pichandle picture, so you may use the picture.bitmap function if you want a picture you can edit or save as JPEG.
This function can be very slow because it may be necessary to render this picture from the last 20 pictures.
Does not work if movie.handle is 0. You can use e.g. OpenAsMovieMBS which returns a movie with handle<>0.
Some examples which use this method:
method, QuickTime, MBS QuickTime Plugin (QuickTime), class Movie, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Gives CPU time to QuickTime to update this movie.
Notes: Some people cry about missing performance on playing movies in RB. This function may help there. if you use threads it may be good to call it from time to time.
method, QuickTime, MBS QuickTime Plugin (QuickTime), class movie, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: The brightness of the movie.
Notes:
Value is not saved in the movie and only used for display.
Requires Mac OS X 10.4 and requires a new movie control.
(so in current Realbasic it seems to have no effect)
(Read and Write runtime property)
method, QuickTime, MBS QuickTime Plugin (QuickTime), class movie, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: The contrast of the movie.
Notes:
Value is not saved in the movie and only used for display.
Requires Mac OS X 10.4 and requires a new movie control.
(so in current Realbasic it seems to have no effect)
(Read and Write runtime property)
method, QuickTime, MBS QuickTime Plugin (QuickTime), class movie, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: The hue of the movie.
Notes:
Value is not saved in the movie and only used for display.
Requires Mac OS X 10.4 and requires a new movie control.
(so in current Realbasic it seems to have no effect)
(Read and Write runtime property)
method, QuickTime, MBS QuickTime Plugin (QuickTime), class movie, Plugin version: 6.4, Mac OS X: Works, Windows: Does nothing, Linux x86: Does nothing, Feedback.
Function: The saturation of the movie.
Notes:
Value is not saved in the movie and only used for display.
Requires Mac OS X 10.4 and requires a new movie control.
(so in current Realbasic it seems to have no effect)
(Read and Write runtime property)
method, QuickTime, MBS QuickTime Plugin (QTMovies), class movie, Plugin version: 4.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: The width of the movie.
Notes:
In contrast to this property, RB's movie width/height properties are cached.
Does not work if movie.handle is 0. You can use e.g. OpenAsMovieMBS which returns a movie with handle<>0.
(Read and Write runtime property)
Some examples which use this method:
method, QuickTime, MBS QuickTime Plugin (QTMovies), class movie, Plugin version: 3.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Finds the next interesting video time (the next frame).
Notes:
Time is an integer for the time to start the search.
Returns in Time the time found (or 0 on an error).
Duration is set to the duration of this frame.
Remember that in QuickTime each frame can have it's individual length.
time=0 is the beginning of the first frame and it is a frame edge, so starting search with 0 will find zero.
Normally you find using this function the next frame of a movie.
You start with time=1 just after the first frame starts and loop using this function from frame to frame till you get time<=0 again.
After you found a time, use time+1 for the next starting point.
Does not work if movie.handle is 0. You can use e.g. OpenAsMovieMBS which returns a movie with handle<>0.
To move a movie to the found position set the movie.timembs property to the new time.
Some examples which use this method:
method, QuickTime, MBS QuickTime Plugin (QTMovies), class movie, Plugin version: 3.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Finds the next interesting video time (the next frame).
Notes:
Time is an integer for the time to start the search.
Returns in Time the time found (or 0 on an error).
Duration is set to the duration of this frame.
Remember that in QuickTime each frame can have it's individual length.
Set Rate to a negative value to search backwards.
time=0 is the beginning of the first frame and it is a frame edge, so starting search with 0 will find zero.
Normally you find using this function the next frame of a movie.
You start with time=1 just after the first frame starts and loop using this function from frame to frame till you get time<=0 again.
After you found a time, use time+1 for the next starting point.
Does not work if movie.handle is 0. You can use e.g. OpenAsMovieMBS which returns a movie with handle<>0.
To move a movie to the found position set the movie.timembs property to the new time.
Some examples which use this method:
method, QuickTime, MBS QuickTime Plugin (QTMovies), class movie, Plugin version: 3.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Finds the next interesting video time (the next frame).
Notes:
Time is an integer for the time to start the search.
Returns in Time the time found (or 0 on an error).
Duration is set to the duration of this frame.
Remember that in QuickTime each frame can have it's individual length.
time=0 is the beginning of the first frame and it is a frame edge, so starting search with 0 will find zero.
Normally you find using this function the next frame of a movie.
You start with time=1 just after the first frame starts and loop using this function from frame to frame till you get time<=0 again.
After you found a time, use time+1 for the next starting point.
Does not work if movie.handle is 0. You can use e.g. OpenAsMovieMBS which returns a movie with handle<>0.
To move a movie to the found position set the movie.timembs property to the new time.
This function requires you to pass correct flags:
nextTimeMediaSample = 1
nextTimeMediaEdit = 2
nextTimeTrackEdit = 4
nextTimeSyncSample = 8
nextTimeStep = 16
nextTimeEdgeOK = 16384
nextTimeIgnoreActiveSegment = 32768
Default of the other functions are to use nextTimeEdgeOK+nextTimeStep.
Some examples which use this method:
method, QuickTime, MBS QuickTime Plugin (QTMovies), class movie, Plugin version: 3.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Finds the next interesting video time (the next frame).
Notes:
Time is an integer for the time to start the search.
Returns in Time the time found (or 0 on an error).
Duration is set to the duration of this frame.
Remember that in QuickTime each frame can have it's individual length.
Set Rate to a negative value to search backwards.
time=0 is the beginning of the first frame and it is a frame edge, so starting search with 0 will find zero.
Normally you find using this function the next frame of a movie.
You start with time=1 just after the first frame starts and loop using this function from frame to frame till you get time<=0 again.
After you found a time, use time+1 for the next starting point.
Does not work if movie.handle is 0. You can use e.g. OpenAsMovieMBS which returns a movie with handle<>0.
To move a movie to the found position set the movie.timembs property to the new time.
This function requires you to pass correct flags:
nextTimeMediaSample = 1
nextTimeMediaEdit = 2
nextTimeTrackEdit = 4
nextTimeSyncSample = 8
nextTimeStep = 16
nextTimeEdgeOK = 16384
nextTimeIgnoreActiveSegment = 32768
Default of the other functions are to use nextTimeEdgeOK+nextTimeStep.
Some examples which use this method:
method, QuickTime, MBS QuickTime Plugin (QTMovie), class movie, Plugin version: 8.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: The movie pitch.
Notes:
Requires QuickTime 7.1
Get/Set Movie pitch adjustment. Adjusts the pitch of all audio tracks that contribute to the AudioContext mix. Pitch control takes effect only if RateChangesPreservePitchMBS is in effect, otherwise does nothing. The value is specified in cents: 0.0 == no change, 1.0 == one cent up, 100.0 == one semi-tone up, -1.0 == one cent down. The most useful ranges for pitch are +/- 1200. (ie, one octave)
(Read and Write runtime property)
method, QuickTime, MBS QuickTime Plugin (QTMovies), class Movie, Plugin version: 3.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Starts playback of the movie.
Some examples which use this method:
method, QuickTime, MBS QuickTime Plugin (QTMovies), class Movie, Plugin version: 2.8, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Returns the poster picture of the movie if there is one.
Example:
backdrop=m.posterpicture
Notes: Returns nil on low memory.
The picture returned is a Pichandle picture, so you may use the picture.bitmap function if you want a picture you can edit or save as JPEG.
Does not work if movie.handle is 0. You can use e.g. OpenAsMovieMBS which returns a movie with handle<>0.
method, QuickTime, MBS QuickTime Plugin (QTMovies), class movie, Plugin version: 5.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: The current poster time of the movie.
Notes:
Unit is the timebase of the movie.
Does not work if movie.handle is 0. You can use e.g. OpenAsMovieMBS which returns a movie with handle<>0.
(Read and Write runtime property)
method, QuickTime, MBS QuickTime Plugin (QTMovies), class Movie, Plugin version: 3.0, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Sets and gets a movie's preferred playback rate.
Example:
movie.PreferredRateMBS=65536 'normal
Notes: Use this function to change the speed at which a movie is preferred playing.
The new movie rate as a 32-bit, fixed-point number. Positive integers indicate forward rates and negative integers indicate reverse rates. This value immediately changes the rate at which the movie is playing. A value of 1 starts the movie playing at normal speed, a value of 2 causes the movie to play at double speed, -2 starts the movie playing backward at double speed, and so on. A value of 0 stops the movie.
Useful constants:
| kNormalSpeed | &H10000 | = 1.0 * 65536 |
| kDoubleSpeed | &H20000 | = 2.0 * 65536 |
| kHalfSpeed | &H08000 | = 0.5 * 65536 |
| kStopSpeed | &H00000 | = 0.0 * 65536 |
Does not work if movie.handle is 0. You can use e.g. OpenAsMovieMBS which returns a movie with handle<>0.
(Read and Write runtime property)
method, QuickTime, MBS QuickTime Plugin (QTMovies), class Movie, Plugin version: 3.0, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Set and get the preferred volume of a movie.
Example:
movie.PreferredVolume=256 'max
Notes: See the volume property for details.
Does not work if movie.handle is 0. You can use e.g. OpenAsMovieMBS which returns a movie with handle<>0.
(Read and Write runtime property)
method, QuickTime, MBS QuickTime Plugin (QTMovie), class movie, Plugin version: 8.1, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Whether a change in the movie playback rate changes the pitch of the audio.
Notes:
Requires QuickTime 7.1
Get/Set When the playback rate is not unity, audio must be resampled in order to play at the new rate. The default resampling affects the pitch of the audio (eg, playing at 2x speed raises the pitch by an octave, 1/2x lowers an octave). If this property is set on the Movie, an alternative algorithm may be used, which alters the speed without changing the pitch. As this is more computationally expensive, this property may be silently ignored on some slow CPUs. Media handlers may query this movie property and honor it when performing Scaled Edits. This property can be specified as a property to the OpenAsMovieWithPropertiesMBS. Currently, it has no effect when set on an open movie.
(Read and Write runtime property)
method, QuickTime, MBS QuickTime Plugin (QTMovies), class Movie, Plugin version: 3.0, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Sets and gets a movie's playback rate.
Example:
movie.rateMBS=-65536 'backwards
Notes: Use this function to change the speed at which a movie is playing.
The new movie rate as a 32-bit, fixed-point number. Positive integers indicate forward rates and negative integers indicate reverse rates. This value immediately changes the rate at which the movie is playing. A value of 1 starts the movie playing at normal speed, a value of 2 causes the movie to play at double speed, -2 starts the movie playing backward at double speed, and so on. A value of 0 stops the movie.
Useful constants:
| kNormalSpeed | &H10000 | = 1.0 * 65536 |
| kDoubleSpeed | &H20000 | = 2.0 * 65536 |
| kHalfSpeed | &H08000 | = 0.5 * 65536 |
| kStopSpeed | &H00000 | = 0.0 * 65536 |
You need to set the rate after you used the play method to start playback.
Else the Play method will reset the play rate to normal speed.
Does not work if movie.handle is 0. You can use e.g. OpenAsMovieMBS which returns a movie with handle<>0.
(Read and Write runtime property)
Some examples which use this method:
method, QuickTime, MBS QuickTime Plugin (QTCoreClasses), class movie, Plugin version: 3.4, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Registers a media key.
Notes:
Returns an error code (0 for success).
keytype must be a MacRoman string.
method, QuickTime, MBS QuickTime Plugin (QTMovie), class movie, Plugin version: 8.2, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Removes aperture mode dimension information from a movie.
Notes: This function removes aperture mode dimension information from a movie's tracks. It does not attempt to modify sample descriptions, so it may not completely reverse the effect of GenerateMovieApertureModeDimensions. It sets the kQTVisualPropertyID_HasApertureModeDimensions property to false.
method, QuickTime, MBS QuickTime Plugin (QTMovie), class movie, Plugin version: 8.4, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Removes a text track.
Notes:
Index is from 1 to the number of text chapters.
Pass 0 to delete all text tracks.
Returns a Mac OS error code.
method, QuickTime, MBS QuickTime Plugin (QTMovies), class movie, Plugin version: 5.0, Mac OS X: Works, Windows: Works, Linux x86: Does nothing, Feedback.
Function: Saves a movie.
Example:
// e=SaveMBS(file,false,false) // save command in QuickTime movie Player
// save as reference movie
dim f as FolderItem
dim m as movie
f=DesktopFolder.Child("test.mov")
m=f.OpenAsMovie
f=DesktopFolder.Child("new movie.mov")
msgbox str(m.SaveMBS(f,false,false))
Notes: File must be a valid folderitem. This function does not support long file names so you better save to e.g. "temp.mov" and rename the file on success later.
If Flatten is true the whole movie data is written and in that case FlattenActiveTracksOnly controls whether inactivate tracks are written or not.
Returns a Mac OS error code. (0 for success)
Does not work if movie.handle is 0. You can use e.g. OpenAsMovieMBS which returns a movie with handle<>0.
Some examples which use this method:
The items on this page are in the following plugins: MBS QuickTime Plugin.
Monkeybread Software Realbasic Plugins - Pfarrgemeinderat St. Arnulf Nickenich