MoviePlayer

From Xojo Documentation
Jump to: navigation, search

Class (inherits from RectControl)

Displays a control for playing movies.

Events
Close DragOver MouseMove
ConstructContextualMenu DropObject MouseWheel
ContextualMenuAction KeyDown Open
ControllerSizeChanged KeyUp Play
DragEnter MouseEnter Stop
DragExit MouseExit


Properties
Active ReadOnlyProperty.png Index ReadOnlyProperty.png PanelIndex
AutoDeactivate Left Parent
AutoPlay LockBottom PlayerType
AutoResize LockLeft Position
Border ReadOnlyProperty.png LockRight Scope ReadOnlyProperty.png
Controller LockTop Speaker
ControllerHeight ReadOnlyProperty.png Looping TabIndex
ControllerWidth ReadOnlyProperty.png MouseCursor TabStop
Duration ReadOnlyProperty.png MouseX ReadOnlyProperty.png Top
Enabled MouseY ReadOnlyProperty.png TrueWindow ReadOnlyProperty.png
Handle ReadOnlyProperty.png Movie Visible
HasStep MovieController ReadOnlyProperty.png Volume
Height Name Width
HelpTag Palindrome Window ReadOnlyProperty.png


Methods
AcceptFileDrop Close Refresh
AcceptPictureDrop DrawInto RefreshRect
AcceptRawDataDrop Invalidate SetFocus
AcceptTextDrop Play Stop

Notes

Windows uses the Windows Movie Player to play movies and macOS uses AVFoundation. On Linux, the MoviePlayer uses GStreamer by default (it requires version 0,10+) and uses Xine if GStreamer is not available.

The Controller property dictates how the movie controls (if any) will be displayed. Passing 0 (zero) means that there will be no user controls available. Passing 1 means that a movie icon or badge will be displayed in the lower left corner of the movie area instead of the controller. When this badge is clicked by the user, the badge disappears and the regular movie controls appear at the bottom of the movie frame. Passing 2 displays the regular movie controls.

Because movie loading is asynchronous, you should not have AutoResize = True if you are also manually modifying the Width and Height as it is possible that the auto resizing will occur after you have changed the size.

Examples

This example sets the movie "myHomeMovie" as the movie to be played.

MoviePlayer1.Movie = myHomeMovie

This example loads a movie called "MyMovie" from the current directory (folder) into MoviePlayer1 and plays it.

Dim f As FolderItem
f = GetFolderItem("MyMovie")
MoviePlayer1.Speaker = True
MoviePlayer1.HasStep = False
MoviePlayer1.Movie = f.OpenAsMovie
MoviePlayer1.Play

If you added the movie to your project, you can assign it to the movie property with only one line of code:

MoviePlayer1.Movie = MyMovie

The following example uses the MovieController property to get the current position of the player:

Dim pos As Double
pos = MoviePlayer1.MovieController.Controls.CurrentPosition

See Also

OpenURLMovie function; Movie, EditableMovie, WebMoviePlayer classes.

Personal tools
Namespaces

Variants
Actions
Main
Content
Starting Out
Dig Deeper
More Help
Toolbox
About