Class

MoviePlayer (deprecated)

Warning

This item was deprecated in version 2021r3. Please use DesktopMoviePlayer as a replacement.

Description

Displays a control for playing movies.

Methods

Name

Parameters

Returns

Shared

AcceptFileDrop

FileType As String

AcceptPictureDrop

AcceptRawDataDrop

Type As String

AcceptTextDrop

Close

DrawInto

g As Graphics, x As Integer, y As Integer

Invalidate

[EraseBackground As Boolean]

Play

Refresh

eraseBackground As Boolean

SetFocus

Stop

Events

Name

Parameters

Returns

Close

ConstructContextualMenu

Base As MenuItem, x As Integer, y As Integer

Boolean

ContextualMenuAction

HitItem As MenuItem

Boolean

ControllerSizeChanged

DragEnter

obj As DragItem, Action As Integer

Boolean

DragExit

obj As DragItem, Action As Integer

DragOver

x As Integer, y As Integer, obj As DragItem, Action As Integer

Boolean

DropObject

Obj As DragItem Action As Integer

KeyDown

Key As String

Boolean

KeyUp

Key As String

MouseEnter

MouseExit

MouseMove

X As Integer, Y As Integer

MouseWheel

X As Integer, Y As Integer, DeltaX As Integer, DeltaY As Integer

Boolean

Open

Play

Stop

Property descriptions

MoviePlayer.Active

Active As Boolean

Indicates whether the RectControl is active.

This property is read-only.

Active is False when the RectControl's window is not in the foreground. When a Window is deactivated, its controls are automatically deactivated unless RectControl.AllowAutoDeactivate is set to False.

MoviePlayer.AllowAutoDeactivate

AllowAutoDeactivate As Boolean

Determines whether the control should be deactivated (on macOS) when the parent window is deactivated. The default is True.

MoviePlayer.AllowTabStop

AllowTabStop As Boolean

If True, the RectControl is in the Tab Order and accepts the focus when the user tabs into it. The default is True. If False, the user cannot tab into it to give it the focus. However, the RectControl can gain the focus by other means, such as the user's clicking on it or by setting the focus in code.

This example removes the control from the Tab Order:

Me.AllowTabStop = False

MoviePlayer.AutoAdjustToMovieSize

AutoAdjustToMovieSize As Boolean

If True, the MoviePlayer control resizes itself to fit the size of the movie. The default is True.

Because movie loading is asynchronous, you should not have AutoAdjustToMovieSize = 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.

This example turns off AutoAdjustToMovieSize.

Var f As FolderItem
f = FolderItem.ShowOpenFileDialog(FileTypes1.VideoMp4)
If f <> Nil Then
  MoviePlayer1.AutoAdjustToMovieSize = False
  MoviePlayer1.movie = Movie.Open(f)
End If

MoviePlayer.AutoPlay

AutoPlay As Boolean

If True, the movie will start playing automatically when it is assigned to the Movie property of the control. The default is False.

This example sets AutoPlay and then opens a movie.

Var myMovieFile As FolderItem

myMovieFile = FolderItem.ShowOpenFileDialog(FileTypes1.VideoMp4)
If myMovieFile <> Nil Then
  MoviePlayer1.AutoPlay = True
  MoviePlayer1.Movie = movie.Open(myMovieFile)
End If

MoviePlayer.AutoRepeat

AutoRepeat As Boolean

If True, it replays the movie automatically when it reaches the end. The default is True.

This example turns AutoRepeat off.

Var f As FolderItem

f = FolderItem.ShowOpenFileDialog(FileTypes1.VideoMp4)
If f <> Nil Then
  MoviePlayer1.AutoPlay = True
  MoviePlayer1.AutoRepeat = False
  MoviePlayer1.Movie = Movie.Open(f)
End If

MoviePlayer.Border

Border As Boolean

This property is read-only.

MoviePlayer.ControllerHeight

ControllerHeight As Integer

The height of the controller (pixels).

This property is read-only.

MoviePlayer.ControllerWidth

ControllerWidth As Integer

The width of the controller (pixels).

This property is read-only.

MoviePlayer.Duration

Duration As Double

The duration (in seconds) of the currently playing media.

This property is read-only.

The movie must be playing for this property to hold a value. If no movie is playing, it is set equal to zero.

This example gets the Duration of the movie.

Var duration As Double = MoviePlayer1.Duration

MoviePlayer.Enabled

Enabled As Boolean

Determines if the control should be enabled when the owning window is opened.

A disabled control cannot be clicked and cannot receive the focus.

This example disables the control. Its caption is grayed out.

Me.Enabled = False

MoviePlayer.Handle

Handle As Integer

Returns a handle to the control.

This property is read-only.

For interfacing with Mac APIs using Declare).

On Windows returns the HWND of the control.

On Linux it returns a GtkWidget.

The following gets a handle to the control.

Var i As Integer = Me.Handle

MoviePlayer.HasController

HasController As Boolean

Determines if the controller is displayed. The default is True.

This example hides the controls and autoplays the movie.

Var f As FolderItem

f = FolderItem.ShowOpenFileDialog(FileTypes1.VideoMp4)
If f <> Nil Then
  MoviePlayer1.AutoPlay = True
  MoviePlayer1.HasController = False
  MoviePlayer1.Movie = Movie.Open(f)
End If

MoviePlayer.HasStepControls

HasStepControls As Boolean

If True, the controller has forward and reverse arrows to the right of the slider. The default is True.

When set in code, HasStepControls takes effect the next time the MoviePlayer is assigned a movie.

This example hides the step controls. Since it is called prior to the assignment of a movie to the player, the controls are not shown for this movie.

Var f As FolderItem

f=FolderItem.ShowOpenFileDialog(FileTypes1.VideoMp4)
If f <> Nil Then
  MoviePlayer1.AutoPlay = True
  MoviePlayer1.HasStepControls = False
  MoviePlayer1.Movie = Movie.Open(f)
End If

MoviePlayer.HasVolumeControl

HasVolumeControl As Boolean

Displays the speaker volume control.

When set in code, this takes effect the next time the MoviePlayer control is assigned a movie.

The following example hides the volume control before assigning a movie to the player.

Var f As FolderItem

f = FolderItem.ShowOpenFileDialog(FileTypes1.VideoMp4)
If f <> Nil Then
  MoviePlayer1.AutoPlay = True
  MoviePlayer1.HasVolumeControl = False
  MoviePlayer1.Movie = Movie.Open(f)
End If

MoviePlayer.Height

Height As Integer

The height (in points) of the control.

This example sets the height of the control to 100:

Me.Height = 100

MoviePlayer.Index

Index As Integer

If the control is used in a control set, this specifies the control's index in the set.

This property is read-only.

The control set is often used to manage a group of RadioButtons since a single RadioButton in a window doesn't make much sense. Most typically, you create an instance of the RadioButton, assign 0 to its Index property, and then duplicate it. This increments the value of Index for each new instance but retain the original control's name.

To determine which RadioButton the user clicked, use the Action event handler of the control set. The parameter Index contains the value of Index for the RadioButton that was clicked. The event handler is this:

Sub Action(Index As Integer)
  Label1.Text = "You chose radio button " + index.ToString + "."
End Sub

To set a RadioButton in a control set, you use its Index property to refer to the RadioButton whose value you want to set. For example, the following line selects the second RadioButton from code:

RadioButton1(1).Value = True ' 0-based

MoviePlayer.Left

Left As Integer

The left side of the control in local coordinates (relative to the window).

The following example moves the control 100 points from the left side of the window:

Me.Left = 150

MoviePlayer.LockBottom

LockBottom As Boolean

Determines whether the bottom edge of the control should stay at a set distance from the bottom edge of the parent control, if there is one, or the owning window.

This property can be set in the control's Inspector. The following example sets it in code.

Me.LockBottom = True

MoviePlayer.LockLeft

LockLeft As Boolean

Determines whether the left edge of the control should stay at a set distance from the left edge of the parent control, if there is one, or the owning window.

Beginning with version 2009r5, LockLeft and Locktop default to True when you add a new control to a window. Existing controls will be altered only if LockRight and/or LockBottom are not set. LockLeft has no effect unless LockRight is True.

This property can be set in the control's Inspector. The following example sets it in code.

Me.LockLeft = True

MoviePlayer.LockRight

LockRight As Boolean

Determines whether the right edge of the control should stay at a set distance from the right edge of the parent control, if there is one, or the owning window.

This property can be set in the control's Inspector. The following example sets it in code.

Me.LockRight = True

MoviePlayer.LockTop

LockTop As Boolean

Determines whether the top edge of the control should stay at a set distance from the top edge of the parent control, if there is one, or the owning window.

Beginning with version 2009r5, LockTop and LockLeft default to True when you add a control to a window. Existing controls will be altered only if LockRight and/or LockBottom are not set. LockTop has no effect unless LockBottom is True.

This property can be set in the control's Inspector. The following example sets it in code.

Me.LockTop = True

MoviePlayer.MouseCursor

MouseCursor As MouseCursor

The cursor to be displayed while the mouse is within the control and both the DesktopApplication and Window class's MouseCursor properties are Nil.

If the DesktopApplication class's MouseCursor property is not Nil or the Window's MouseCursor property is not Nil, then any control's MouseCursor property is ignored. You can use a cursor stored in the Cursors module. On Macintosh, you can also obtain a MouseCursor from a resource file.

This line in the Open event of the control sets the default cursor to the finger pointer.

Me.MouseCursor = System.Cursors.FingerPointer

MoviePlayer.MouseX

MouseX As Integer

The X coordinate of the mouse (points). Measured from the top-left corner of the control.

This property is read-only.

This code is in the MouseDown event of a TextField and displays the X-coordinate at the point of the MouseDown event.

Me.Value = Str(Me.MouseX)

MoviePlayer.MouseY

MouseY As Integer

The Y coordinate of the mouse (points). Measured from the top-left corner of the control.

This property is read-only.

This code is in the MouseDown event of a TextField and displays the Y-coordinate at the point of the MouseDown event.

Me.Value = Str(Me.MouseY)

MoviePlayer.Movie

Movie As Movie

The movie that will be played.

This example displays a movie in a MoviePlayer and plays it.

Var f As FolderItem

f = FolderItem.ShowOpenFileDialog(FileTypes1.VideoMp4)
If f <> Nil Then
  MoviePlayer1.AutoPlay = True
  MoviePlayer1.Movie = Movie.Open(f)
End If

MoviePlayer.Name

Name As String

The name of the control. Set the name of the control in the Inspector.

This property is read-only.

MoviePlayer.OLEMovieObject

OLEMovieObject As OLEObject

Returns an OLEObject that you can use to access the MoviePlayer directly. Documentation for this object can be found here: https://msdn.microsoft.com/en-us/library/windows/desktop/dd563945(v=vs.85).aspx

This property is read-only.

Sets the "stretchToFit" property in the OLEObject to True:

Var obj As OLEObject = MoviePlayer1.OLEMovieObject
obj.Value("stretchToFit") = True

MoviePlayer.PanelIndex

PanelIndex As Integer

If the control has been placed on a TabPanel or PagePanel control, this is the panel (page/tab) that the control is on. If the control is not on a panel, it returns -1.

The first panel is numbered zero. If the control has been placed on a panel of a TabPanel or PagePanel control, it returns the panel number. If the control is not on a PagePanel or TabPanel, it returns -1. If you change the PanelIndex to a nonexistent panel, the control will disappear until you give it a PanelIndex value that corresponds to a panel that exists.

If you are looking to change the currently selected panel (page/tab), use PagePanel.SelectedPanelIndex.

This code displays the panel index of the control that is on the page.

Label3.Value = Str(Me.PanelIndex)

MoviePlayer.Parent

Parent As Control

Used to get and set the control's parent control or window.

Returns Nil if the parent is the window. Assign Nil to make the control's parent the window, even if it is enclosed by another control. The child control's behavior in the IDE will reflect the parent's state. If the parent control is somehow in another window, an InvalidParentException will occur.

The following example sets the parent of the control to the window.

Me.Parent = Nil

MoviePlayer.PlayerType

PlayerType As Integer

Indicates the type of movie the MoviePlayer will play.

This property is read-only.

PlayerType can take on the following values:

Value

Description

0

Preferred player

1

QuickTime player

2

Windows Media player

On Windows, the preferred player is the Windows Media Player, but if WMP cannot play the movie, the QuickTime player will try to be used instead. On macOS, PlayerType is ignored, as AVFoundation is used to play movies. If desired, set PlayerType to 2 to prevent the QuickTime player from being used on Windows. This is also ignored on Linux, where MoviePlayer uses GStreamer by default (requires version 010+) and uses Xine if GStreamer is not available.

MoviePlayer.Position

Position As Double

The number of seconds from the start of the movie.

The following example moves the playhead to the 60 second point in the movie.

MoviePlayer1.Position = 60

MoviePlayer.RepeatInReverse

RepeatInReverse As Boolean

If True, it plays the movie in reverse when the movie reaches its end. AutoRepeat must be True for RepeatInReverse to work.

The following example invokes the RepeatInReverse feature.

Var f As FolderItem

f = FolderItem.ShowOpenFileDialog(FileTypes1.VideoMp4)
If f <> Nil Then
  MoviePlayer1.AutoPlay = True
  MoviePlayer1.RepeatInReverse = False
  MoviePlayer1.Movie = Movie.Open(f)
End If

MoviePlayer.Scope

Scope As Integer

Used to determine whether access to the control is Public (0) or Private (2). The default is Public.

This property is read-only.

If the Scope of a control is set to Private, it cannot be accessed from outside its parent window.

MoviePlayer.TabIndex

TabIndex As Integer

The RectControl's position in the Tab Order. It is 0-based. A TabIndex of 0 is the first RectControl to get the focus.

On the Mac you need Full Keyboard Access turned on in System Preferences (Keyboard->Shortcuts) in order to manually set focus to non-text controls.

This example sets the control's TabIndex.

Me.TabIndex = 2

MoviePlayer.Tooltip

Tooltip As String

Text of help message displayed as a Windows or Linux "tooltip" or macOS help tag.

The tip/tag is displayed when the user hovers the mouse cursor over the control.

This example adds a tooltip to a BevelButton that has an icon.

Me.CaptionAlignment = 0 ' left
Me.CaptionDelta = 10
Me.Tooltip = "Click to bark."

Me.Icon = Woof ' added to the project
Me.CaptionPosition = 2

MoviePlayer.Top

Top As Integer

The top of the control in local coordinates (relative to the window).

This example sets the top of the control to 140 points from the top of the window:

Me.Top = 140

MoviePlayer.Transparent

Transparent As Boolean

Determines whether the control is transparent on Windows. The default is False. Has no effect on macOS or Linux.

Transparent controls draw more slowly and use more memory in order to cache the background. Unless you absolutely require transparency, leave this set to False.

For projects that were created prior to 2018r1, this property defaults to True to emulate previous behavior. Consider changing it to False to improve performance if you do not require transparency.

MoviePlayer.TrueWindow

TrueWindow As Window

Returns a reference to the actual enclosing Window.

This property is read-only.

TrueWindow walks up the window hierarchy and finds the actual enclosing window regardless of how deeply nested the RectControl or DesktopContainer hierarchy is.

Window also has a TrueWindow property.

This example accesses the TrueWindow and displays its Title property in a TextField.

TextField1.Text = Me.TrueWindow.Title

MoviePlayer.Visible

Visible As Boolean

Determines whether the control is visible when its owning window is opened. The default is True: the control is visible.

The following code in the DisclosureTriangle Action event handler displays or hides a ListBox on the window:

ListBox1.Value = Me.Visible

MoviePlayer.Volume

Volume As Integer

Gets or sets the movie's volume. The range is from 0 to 255.

This example sets the volume to a very low level.

MoviePlayer1.Volume = 10

MoviePlayer.Width

Width As Integer

The width (in points) of the control.

The following example resizes the control:

Me.Width = 200

MoviePlayer.Window

Window As Window

The control's parent window.

This property is read-only.

This code gets the parent window's Title property.

TextField1.Text = Me.Window.Title

Method descriptions

MoviePlayer.AcceptFileDrop

AcceptFileDrop(FileType As String)

Permits documents of type FileType to be dropped on the control. FileType must be a file type that you defined in via the FileType class or the File Type Sets Editor.

This code in the Open event of an ImageWell makes it possible for the user to drop either a picture or a file that is a jpeg image. The File Type Sets editor was used to define the “image/jpeg” file type. It is one of the “Common File Types” that is available in the editor.

Me.AcceptPictureDrop
Me.AcceptFileDrop("image/jpeg")

To restrict file drops to just folders (and not files), you can put this code in the DragEnter event:

If Not obj.FolderItem.IsFolder Then Return True

MoviePlayer.AcceptPictureDrop

AcceptPictureDrop

Permits pictures to be dropped on the control.

If a control should accept pictures in a drag and drop, then AcceptPictureDrop needs to be called prior to the drop. Typically, it is in the Open event of the control itself. For example, the line:

Me.AcceptPictureDrop

in the Open event of the control that will receive the dragged pictures is needed. When the picture is dropped, the DropObject event is called and this is where you will put your code to handle the drop.

Canvas.Open:

Me.AcceptPictureDrop

Canvas.DropObject:

If obj.PictureAvailable Then
  Me.Backdrop = obj.Picture
End If

MoviePlayer.AcceptRawDataDrop

AcceptRawDataDrop(Type As String)

Permits data (of the Type specified) to be dropped on the control.

The following specfies a generic file type defined in the File Type Sets editor.

Me.AcceptRawDataDrop("????")

MoviePlayer.AcceptTextDrop

AcceptTextDrop

Permits text to be dropped on the control.

This line in the Open event of a control that can accept dragged text.

Me.AcceptTextDrop

MoviePlayer.Close

Close

Closes a control.

Closing a control permanently removes the control from memory, making it impossible to access. You can close both non-indexed controls and indexed controls. When you close an indexed control, the indexes for the remaining controls will shift downward so that the indexes start with zero and are consecutive.

The following code closes the control. When this is executed from a visible control, the control disappears from the window.

Me.Close

MoviePlayer.DrawInto

DrawInto(g As Graphics, x As Integer, y As Integer)

Draws the contents of the RectControl into the specified Graphics context. The parameters x and y are the coordinates of the top, left corner.

This method does not work with HTMLViewer and OpenGLSurface.

This example draws the current control into the Graphics of a Picture and then displays it as the Backdrop of a Canvas:

Var p As New Picture(Me.Width, Me.Height)
Me.DrawInto(p.Graphics, 0, 0)
Canvas1.Backdrop = p

MoviePlayer.Invalidate

Invalidate([EraseBackground As Boolean])

Similar to RefreshRect, but causes the specified region of the RectControl to be marked dirty and to be redrawn when the window contents need to be redrawn. The region to be redrawn is specified by the X, Y, Width, and Height parameters. This form of Invalidate was formerly called InvalidateRect.

The following code refreshes the control. EraseBackground defaults to True.

Me.Invalidate(False)

MoviePlayer.Play

Play

Plays the current movie.

The following example opens the movie that the user chose and plays it.

Var f As FolderItem

f = FolderItem.ShowOpenFileDialog(FileTypes1.VideoMp4)
If f <> Nil Then
  MoviePlayer1.RepeatInReverse = False
  MoviePlayer1.Movie = Movie.Open(f)
  MoviePlayer1.Play
End If

MoviePlayer.Refresh

Refresh(eraseBackground As Boolean)

Repaints the portion specified of the contents of the control immediately.

Calling this frequently can cause the code executing to slow down. It is often preferable to call RectControl.Invalidate instead.

Refresh the entire area:

Me.Refresh(False)

Refresh a portion of the area:

Me.Refresh(100, 150, 200, 300)

MoviePlayer.SetFocus

SetFocus

If applicable, sets the focus to the RectControl. KeyDown events are directed to the control.

If the control cannot get the focus on the platform on which the application is running, SetFocus does nothing. The SetFocus method of the Window class or the ClearFocus method can be used to remove the focus from the control that currently has the focus, leaving no control with the focus.

On the Mac you need Full Keyboard Access turned on in System Preferences (Keyboard->Shortcuts) in order to manually set focus to non-text controls.

The following example sets the focus to TextField1. If another control has the focus when this line is executed, then the user sees that TextField1 gets the focus.

TextField1.SetFocus

MoviePlayer.Stop

Stop

Stops the current movie.

This example stops the current movie that is playing in MoviePlayer1.

MoviePlayer1.Stop

Event descriptions

MoviePlayer.Close

Close

The control is about to close.

MoviePlayer.ConstructContextualMenu

ConstructContextualMenu(Base As MenuItem, x As Integer, y As Integer) As Boolean

This event is called when it is appropriate to display a contextual menu for the control.

This event handler is the recommended way to handle contextual menus because this event figures out whether the user has requested the contextual menu, regardless of how they did it. Depending on platform, it might be in the MouseUp or MouseDown event and it might be a right+click or by pressing the contextual menu key on the keyboard, for example.

Base is analogous to the menu bar for the contextual menu. Any items you add to Base will be shown as menu items. If you return False, the event is passed up the parent hierarchy.

If you return True, the contextual menu is displayed. The parameters x and y are the mouse locations. If the event was fired because of a non-mouse event, then x and y are both set to -1. See the example of a contextual menu in the following section.

The following ConstructContextualMenu event handler builds a menu with three menu items plus a submenu with three additional menu items.

' Add some items
base.AddMenu(New MenuItem("Test 1"))
base.AddMenu(New MenuItem("Test 2"))
base.AddMenu(New MenuItem("Test 3"))

' Add a Separator
base.AddMenu(New MenuItem(MenuItem.TextSeparator))

' Add a sub menu
Var submenu As New MenuItem("SubMenu")
submenu.AddMenu(New MenuItem("SubMenu Test 1"))
submenu.AddMenu(New MenuItem("SubMenu Test 2"))
submenu.AddMenu(New MenuItem("SubMenu Test 3"))
base.AddMenu(submenu)

' Add a Separator
base.AddMenu(New MenuItem(MenuItem.TextSeparator))

Return True

MoviePlayer.ContextualMenuAction

ContextualMenuAction(HitItem As MenuItem) As Boolean

Fires when a contextual menuitem hitItem was selected but the Action event and the MenuHandler for the menuitem did not handle the menu selection.

This event gives you a chance to handle the menu selection by inspecting the menuitem's Text or Tag properties to see which item was selected. Use this in conjunction with ConstructContextualMenu if you have not specified the Action event or the Menu Handler for the items on the contextual menu. See the example of a contextual menu in the examples for the RectControl class.

Return True if this event has handled the item the user chose from the contextual menu. Returning False will cause the control's parent to execute its ContextualMenuAction event. This can be handy if you have the same contextual menu for several controls who share the same Parent (several on the same window for example). By returning False you can handle them all in a single event.

This simple event handler displays the value of the selected menu item.

If hitItem <> Nil Then MessageBox(hitItem.Value)
Return True

MoviePlayer.ControllerSizeChanged

ControllerSizeChanged

The size of the controller has changed.

When a movie first starts this event fires and allows you read the ControllerWidth/Height properties and then resize the MoviePlayer and or window to best accommodate that size. The event also fires if the movie changes size "on its own."

MoviePlayer.DragEnter

DragEnter(obj As DragItem, Action As Integer) As Boolean

Fires when the passed DragItem enters the RectControl.

Returns a Boolean. Return True from this event to prevent the drop from occurring.

The Action parameter specifies the drag action. It can take the following class constants of the DragItem class:

Value

Class Constant

0

DragItem.DragActionDefault

1

DragItem.DragActionCopy

2

DragItem.DragActionMove

3

DragItem.DragActionLink

To restrict file drops to just folders (and not files), you can put this code in the DragEnter event:

If Not obj.FolderItem.IsFolder Then Return True

MoviePlayer.DragExit

DragExit(obj As DragItem, Action As Integer)

Fires when the passed DragItem exits the RectControl.

The Obj parameter is the item being dragged. The Action parameter specifies the drag action. It can take the following class constants of the DragItem class:

Value

Constant

0

DragItem.DragActionDefault

1

DragItem.DragActionCopy

2

DragItem.DragActionMove

3

DragItem.DragActionLink

MoviePlayer.DragOver

DragOver(x As Integer, y As Integer, obj As DragItem, Action As Integer) As Boolean

Fires when the DragItem is over the RectControl.

The Obj parameter is the object being dragged. The coordinates x and y are relative to the RectControl. Returns a Boolean. Return True from this event to prevent the drop from occurring.

The Action parameter specifies the drag action, which is typically done by holding down a modifier key (Shift, Alt, Option, Command, etc.) while doing the drag. It can take the following class constants of the DragItem class:

Value

Constant

0

DragItem.DragActionDefault

1

DragItem.DragActionCopy

2

DragItem.DragActionMove

3

DragItem.DragActionLink

MoviePlayer.DropObject

DropObject(Obj As DragItem Action As Integer)

The item represented by Obj has been dropped on the control.

The Obj parameter is the object being dragged. The Action parameter specifies the drag action. It can take the following class constants of the DragItem class:

{| class="genericTable" ! width=10% |Value ! width=60% |Class Constant |- |0 | DragItem.DragActionDefault |- |1 | DragItem.DragActionCopy |- |2 | DragItem.DragActionMove |- |3 | DragItem.DragActionLink |- |}

The following DropObject event handler can handle either a dropped picture or a dropped file. The type of file that it can handle needs to have been specified in a call to AcceptFileDrop prior to the drop, for example, in the Open event.

If Obj.PictureAvailable Then
  Me.Image = obj.Picture
ElseIf Obj.FolderItemAvailable Then
  Me.Image = Picture.Open(obj.FolderItem)
End If

MoviePlayer.KeyDown

KeyDown(Key As String) As Boolean

The user has pressed the Key passed while the control has the focus.

How KeyDown works depends on the type of control.

TextField and TextArea Returning True means the key is intercepted, preventing the key from actually reaching the control at all. This would be useful if you want to override the behavior of the tab key for example. Returning False means the key reaches the control.

All Other Controls Returning True prevents the KeyDown event on the parent control (usually the window) from executing. Returning False results in the execution of the KeyDown event of the parent control.

MoviePlayer.KeyUp

KeyUp(Key As String)

Fires when the passed Key is released in the RectControl that has the focus.

It is not guaranteed to be the same key that received the KeyDown event.

MoviePlayer.MouseEnter

MouseEnter

The mouse has entered the area of the control.

MoviePlayer.MouseExit

MouseExit

The mouse has left the area of the control.

MoviePlayer.MouseMove

MouseMove(X As Integer, Y As Integer)

The mouse has moved within the control to the coordinates passed. The coordinates are local to the control, not to the window.

MoviePlayer.MouseWheel

MouseWheel(X As Integer, Y As Integer, DeltaX As Integer, DeltaY As Integer) As Boolean

The mouse wheel has been moved.

The parameters X and Y are the mouse coordinates relative to the control that has received the event. The parameters DeltaX and DeltaY hold the number of scroll lines the wheel has been moved horizontally and vertically, as defined by the operating system. DeltaX is positive when the user scrolls right and negative when scrolling to the left. DeltaY is positive when the user scrolls down and negative when scrolling up.

Returns a Boolean. Return True to prevent the event from propagating further.

MoviePlayer.Open

Open

The control is about to be displayed. Use this event to initialize a control.

The Open event is called after the Constructor.

Be warned that initializing control property values using the Constructor instead of the Open event may result in those property values being overwritten by what is set in the Inspector. For best results, use the Open event for control initialization rather than the control Constructor.

If the control is supposed to handle drag and drop, you need to tell it which type of item it needs to be able to handle. The following example informs the control that pictures and files can be dropped on it. The type of the file it needs to support is specified via the File Types Editor.

Sub Open()
  Me.AcceptPictureDrop
  Me.AcceptFileDrop("JPEG")
End Sub

MoviePlayer.Play

Play

The current movie is about to begin playing.

MoviePlayer.Stop

Stop

The current movie is about to stop playing.

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 HasController property dictates if the movie controls (if any) will be displayed. Passing False means that there will be no user controls available. Passing True means that the regular movie controls will be available.

Because movie loading is asynchronous, you should not have AutoAdjustToMovieSize = 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.

Windows resizing

Movies do not automatically resize to fill the screen on Windows. You can alter this behavior with this code:

Var obj As OLEObject = MoviePlayer1.MovieController
obj.Value("stretchToFit") = True

Sample code

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

MoviePlayer1.Movie = myHomeMovie

This code loads a movie called "MyMovie" from the current folder into MoviePlayer1 and plays it.

Var f As FolderItem
f = FolderItem.ShowOpenFileDialog("MyMovie")
MoviePlayer1.HasVolumeControl = True
MoviePlayer1.HasStepControls = False
MoviePlayer1.Movie = Movie.Open(f)
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 code uses the MovieController property to get the current position of the player:

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

Compatibility

All project types on all supported operating systems.

See also

RectControl parent class; Movie.OpenURL function; Movie, WebMoviePlayer classes.