Class # DesktopMoviePlayer

forsearch

Movie

forsearch

Video

forsearch

Player

forsearch

Media --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ## Description Displays a control for playing movies. ## Properties

table-centered_columns_3_and_4

| Name | Type | Read-Only | Shared | |-------------------------------------------------------------------|------------------------------------------------------------|-----------|--------| | `Active` | `Boolean` | ✓ | | | `AllowAutoDeactivate` | `Boolean` | | | | `AllowTabStop` | `Boolean` | | | | `AutoAdjustToMovieSize` | `Boolean` | | | | `AutoPlay` | `Boolean` | | | | `AutoRepeat` | `Boolean` | | | | `ControllerHeight` | `Integer` | ✓ | | | `ControllerWidth` | `Integer` | ✓ | | | `Duration` | `Double` | ✓ | | | `Enabled` | `Boolean` | | | | `Handle` | `Ptr` | ✓ | | | `HasBorder` | `Boolean` | | | | `HasController` | `Boolean` | | | | `HasStepControls` | `Boolean` | | | | `HasVolumeControl` | `Boolean` | | | | `Height` | `Integer` | | | | `Index` | `Integer` | | | | `Left` | `Integer` | | | | `LockBottom` | `Boolean` | | | | `LockLeft` | `Boolean` | | | | `LockRight` | `Boolean` | | | | `LockTop` | `Boolean` | | | | `MouseCursor` | `MouseCursor` | | | | `Movie` | `Movie` | | | | `Name` | `String` | ✓ | | | `OLEMovieObject` | `OLEObject` | ✓ | | | `PanelIndex` | `Integer` | | | | `Parent` | `Object` | | | | `Position` | `Double` | | | | `Rate` | `Double` | | | | `RepeatInReverse` | `Boolean` | | | | `Scope` | `Integer` | ✓ | | | `TabIndex` | `Integer` | | | | `Tooltip` | `String` | | | | `Top` | `Integer` | | | | `Transparent` | `Boolean` | | | | `Visible` | `Boolean` | | | | `Volume` | `Integer` | | | | `Width` | `Integer` | | | | `Window` | `DesktopWindow` | ✓ | | ## Methods

table-centered_column_4

| 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` | | | | `Play` | | | | | `Refresh` | immediately As `Boolean` = `False` | | | | | x As `Integer`, y As `Integer`, width As `Integer`, height As `Integer`, immediately As `Boolean` = `False` | | | | `SetFocus` | | | | | `Stop` | | | | ## Events

table-centered_column_4

| Name | Parameters | Returns | |-----------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------| | `Closing` | | | | `ConstructContextualMenu` | Base As `DesktopMenuItem`, x As `Integer`, y As `Integer` | `Boolean` | | `ContextualMenuItemSelected` | HitItem As `DesktopMenuItem` | `Boolean` | | `ControllerSizeChanged` | | | | `DragEnter` | obj As `DragItem`, Action As `DragItem.Types` | `Boolean` | | `DragExit` | obj As `DragItem`, Action As `DragItem.Types` | | | `DragOver` | x As `Integer`, y As `Integer`, obj As `DragItem`, Action As `DragItem.Types` | `Boolean` | | `DropObject` | obj As `DragItem`, action As `DragItem.Types` | | | `FocusLost` | | | | `FocusReceived` | | | | `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` | | `MovieStarted` | | | | `MovieStopped` | | | | `Opening` | | | ## Property descriptions

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

DesktopMoviePlayer.Active **Active** As `Boolean` > Indicates whether the `control` is active. > > Active is `False` when the control's window is not in the foreground. When a `DesktopWindow` is deactivated, its controls are automatically deactivated unless `AllowAutoDeactivate` is set to `False`. > > This property is read-only.

forsearch

DesktopMoviePlayer.AllowAutoDeactivate **AllowAutoDeactivate** As `Boolean` > Determines whether the control should be deactivated (on macOS) when the parent window is deactivated. The default is `True`.

forsearch

DesktopMoviePlayer.AllowTabStop **AllowTabStop** As `Boolean` > If `True`, the control 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 control 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: > > ``` xojo > Me.AllowTabStop = False > ```

forsearch

DesktopMoviePlayer.AutoAdjustToMovieSize **AutoAdjustToMovieSize** As `Boolean` > If `True`, the DesktopMoviePlayer 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. > > ``` xojo > Var f As FolderItem = FolderItem.ShowOpenFileDialog(FileTypes1.VideoMp4) > > If f <> Nil Then > MoviePlayer1.AutoAdjustToMovieSize = False > MoviePlayer1.Movie = Movie.Open(f) > End If > ```

forsearch

DesktopMoviePlayer.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. > > ``` xojo > Var f As FolderItem = FolderItem.ShowOpenFileDialog(FileTypes1.VideoMp4) > > If f <> Nil Then > MoviePlayer1.AutoPlay = True > MoviePlayer1.Movie = Movie.Open(f) > End If > ```

forsearch

DesktopMoviePlayer.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. > > ``` xojo > Var f As FolderItem = FolderItem.ShowOpenFileDialog(FileTypes1.VideoMp4) > > If f <> Nil Then > MoviePlayer1.AutoPlay = True > MoviePlayer1.AutoRepeat = False > MoviePlayer1.Movie = Movie.Open(f) > End If > ```

forsearch

DesktopMoviePlayer.ControllerHeight **ControllerHeight** As `Integer` > The height of the controller (pixels). > > This property is read-only.

forsearch

DesktopMoviePlayer.ControllerWidth **ControllerWidth** As `Integer` > The width of the controller (pixels). > > This property is read-only.

forsearch

DesktopMoviePlayer.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. > > ``` xojo > Var duration As Double = MoviePlayer1.Duration > ```

forsearch

DesktopMoviePlayer.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. > > ``` xojo > Me.Enabled = False > ```

forsearch

DesktopMoviePlayer.Handle **Handle** As `Ptr` > Returns a handle to the control. > > This property is read-only. > > For interfacing with Mac APIs using `Declares`, **DesktopControl.Handle** returns NSViews (except for `DesktopToolbar`). > > On Windows returns the HWND of the control. > > On Linux it returns a GtkWidget. > > The following gets a handle to the control. > > ``` xojo > Var p As Ptr = Me.Handle > ```

forsearch

DesktopMoviePlayer.HasBorder **HasBorder** As `Boolean` > Indicates whether or not it is visible.

forsearch

DesktopMoviePlayer.HasController **HasController** As `Boolean` > Determines if the controller is displayed. The default is `True`. > > This example hides the controls and autoplays the movie. > > ``` xojo > Var f As FolderItem = FolderItem.ShowOpenFileDialog(FileTypes1.VideoMp4) > > If f <> Nil Then > MoviePlayer1.AutoPlay = True > MoviePlayer1.HasController = False > MoviePlayer1.Movie = Movie.Open(f) > End If > ```

forsearch

DesktopMoviePlayer.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. > > ``` xojo > Var f As FolderItem = FolderItem.ShowOpenFileDialog(FileTypes1.VideoMp4) > > If f <> Nil Then > MoviePlayer1.AutoPlay = True > MoviePlayer1.HasStepControls = False > MoviePlayer1.Movie = Movie.Open(f) > End If > ```

forsearch

DesktopMoviePlayer.HasVolumeControl **HasVolumeControl** As `Boolean` > Displays the speaker volume control. > > When set in code, this takes effect the next time the DesktopMoviePlayer control is assigned a movie. > > The following example hides the volume control before assigning a movie to the player. > > ``` xojo > Var f As FolderItem = FolderItem.ShowOpenFileDialog(FileTypes1.VideoMp4) > > If f <> Nil Then > MoviePlayer1.AutoPlay = True > MoviePlayer1.HasVolumeControl = False > MoviePlayer1.Movie = Movie.Open(f) > End If > ```

forsearch

DesktopMoviePlayer.Height **Height** As `Integer` > The height (in points) of the control. > > This example sets the height of the control to 100: > > ``` xojo > Me.Height = 100 > ```

forsearch

DesktopMoviePlayer.Index **Index** As `Integer` > If the control is used in a control set, this specifies the control's index in the set.

forsearch

DesktopMoviePlayer.Left **Left** As `Integer` > The distance from the left side of the control to the left side of its containing window or container. > > The following example moves the control 100 points from the left side of the window: > > ``` xojo > Me.Left = 150 > ```

forsearch

DesktopMoviePlayer.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. > > ``` xojo > Me.LockBottom = True > ```

forsearch

DesktopMoviePlayer.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. > > 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. > > ``` xojo > Me.LockLeft = True > ```

forsearch

DesktopMoviePlayer.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. > > ``` xojo > Me.LockRight = True > ```

forsearch

DesktopMoviePlayer.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. > > 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. > > ``` xojo > Me.LockTop = True > ```

forsearch

DesktopMoviePlayer.MouseCursor **MouseCursor** As `MouseCursor` > The cursor to be displayed while the mouse is within the control and both the `DesktopApplication` and `DesktopWindow` class's MouseCursor properties are `Nil`. > > If the `DesktopApplication` class's MouseCursor property is not `Nil` or the `DesktopWindow`'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 macOS, you can also obtain a `MouseCursor` from a resource file. > > This line in the Opening event of the control sets the default cursor to the finger pointer. > > ``` xojo > Me.MouseCursor = System.Cursors.FingerPointer > ```

forsearch

DesktopMoviePlayer.Movie **Movie** As `Movie` > The movie that will be played. > > This example displays a movie in a DesktopMoviePlayer and plays it. > > ``` xojo > Var f As FolderItem = FolderItem.ShowOpenFileDialog(FileTypes1.VideoMp4) > > If f <> Nil Then > MoviePlayer1.AutoPlay = True > MoviePlayer1.Movie = Movie.Open(f) > End If > ```

forsearch

DesktopMoviePlayer.Name **Name** As `String` > The name of the control. Set the name of the control in the Inspector. > > This property is read-only.

forsearch

DesktopMoviePlayer.OLEMovieObject **OLEMovieObject** As `OLEObject` > Returns an `OLEObject` that you can use to access the DesktopMoviePlayer directly. Documentation for this object can be found here: > > This property is read-only. > > Sets the "stretchToFit" property in the OLEObject to `True`: > > ``` xojo > Var obj As OLEObject = MoviePlayer1.OLEMovieObject > > obj.Value("stretchToFit") = True > ```

forsearch

DesktopMoviePlayer.PanelIndex **PanelIndex** As `Integer` > If the control has been placed on a `DesktopTabPanel` or `DesktopPagePanel` 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 `DesktopTabPanel` or `DesktopPagePanel` control, it returns the panel number. If the control is not on a `DesktopPagePanel` or `DesktopTabPanel`, 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 `DesktopPagePanel.SelectedPanelIndex`. > > This code displays the panel index of the control that is on the page. > > ``` xojo > MessageBox(Me.SelectedPanelIndex.ToString) > ```

forsearch

DesktopMoviePlayer.Parent **Parent** As `Object` > Used to get and set the control's parent control or window. > > If the control is on the window, the Parent will be the `Window`. If the control is on the container, the Parent will be the `container`. If the control is completed enclosed by another control, the Parent will be that `control`. > > If you do not want the enclosing control to be the parent, set the Parent property of that control to `Nil` to make it the `Window`. > > 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. > > ``` xojo > Me.Parent = Nil > ```

forsearch

DesktopMoviePlayer.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. > > ``` xojo > MoviePlayer1.Position = 60 > ```

forsearch

DesktopMoviePlayer.Rate **Rate** As `Double` > Controls the playback speed of the DesktopMoviePlayer. A default value of 1.0 plays the movie at normal speed, 0.5 plays at half speed, 2.0 plays it twice as fast, and -1.0 plays it in reverse, etc.

forsearch

DesktopMoviePlayer.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. > > ``` xojo > Var f As FolderItem = FolderItem.ShowOpenFileDialog(FileTypes1.VideoMp4) > > If f <> Nil Then > MoviePlayer1.AutoPlay = True > MoviePlayer1.RepeatInReverse = False > MoviePlayer1.Movie = Movie.Open(f) > End If > ```

forsearch

DesktopMoviePlayer.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. > >

> >

> > Note > >

> > This is a designtime-only property and thus can only be set in the Inspector and is not accessible via code. > >

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

forsearch

DesktopMoviePlayer.TabIndex **TabIndex** As `Integer` > The control's position in the Tab Order. The control with whose TabIndex is 0 will get the focus first. > > On macOS, only controls where you enter data from the keyboard typically get the focus. In order to manually set focus to controls that don't allow keyboard entry, go to System Preferences, click on the Keyboard icon then on the Shortcuts tab and then check the *Use keyboard navigation to move focus between controls* checkbox. > > This example sets the control's TabIndex. > > ``` xojo > Me.TabIndex = 2 > ```

forsearch

DesktopMoviePlayer.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 control: > > ``` xojo > Me.Tooltip = "Click to bark." > ```

forsearch

DesktopMoviePlayer.Top **Top** As `Integer` > The distance from the top of the control to the top of its containing window or container. > > This example sets the top of the control to 140 points from the top of the window: > > ``` xojo > Me.Top = 140 > ```

forsearch

DesktopMoviePlayer.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.

forsearch

DesktopMoviePlayer.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 makes the control invisible: > > ``` xojo > Me.Visible = False > ```

forsearch

DesktopMoviePlayer.Volume **Volume** As `Integer` > Gets or sets the movie's volume. The range is from 0 to 100. If the volume falls outside that range, it'll will throw an `OutOfBoundsException`. > > This example sets the volume to a very low level. > > ``` xojo > MoviePlayer1.Volume = 10 > ```

forsearch

DesktopMoviePlayer.Width **Width** As `Integer` > The width (in points) of the control. > > The following example resizes the control: > > ``` xojo > Me.Width = 200 > ```

forsearch

DesktopMoviePlayer.Window **Window** As `DesktopWindow` > The control's parent window. > > This property is read-only. > > This code gets the parent window's Title property. > > ``` xojo > MessageBox(Me.Window.Title) > ``` ## Method descriptions

forsearch

DesktopMoviePlayer.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 Opening event 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. > > ``` xojo > Me.AcceptPictureDrop > Me.AcceptFileDrop("image/jpeg") > ``` > > To restrict file drops to specific file types on macOS, in addition to creating a File Type (as a `project item` or `via code`) to define the file extension, you must also use the `DragEnter` event: > > For example, to restrict drops to folders only: > > ``` xojo > If Not obj.FolderItem.IsFolder Then Return True > ``` > > To restrict drops to a files with a specific extension: > > ``` xojo > If Not obj.FolderItem.Extension <> ".my_extension" Then Return True > ```

forsearch

DesktopMoviePlayer.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 Opening event of the control itself. For example, the line: > > ``` xojo > Me.AcceptPictureDrop > ``` > > in the Opening 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. > > Opening Event: > > ``` xojo > Me.AcceptPictureDrop > ``` > > DropObject Event: > > ``` xojo > If obj.PictureAvailable Then > Me.Backdrop = obj.Picture > End If > ```

forsearch

DesktopMoviePlayer.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. > > ``` xojo > Me.AcceptRawDataDrop("????") > ```

forsearch

DesktopMoviePlayer.AcceptTextDrop **AcceptTextDrop** > Permits text to be dropped on the control. > > This line in the Opening event of a control that can accept dragged text. > > ``` xojo > Me.AcceptTextDrop > ```

forsearch

DesktopMoviePlayer.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. > > ``` xojo > Me.Close > ```

forsearch

DesktopMoviePlayer.DrawInto **DrawInto**(g As `Graphics`, x As `Integer`, y As `Integer`) > Draws the contents of the control into the specified `Graphics` context. The parameters *x* and *y* are the coordinates of the top, left corner. > >

> >

> > Note > >

> > DrawInto will only work if the control is on a window or container. > >

> > This example draws the current control into the Graphics of a Picture and then displays it as the Backdrop of a Canvas: > > ``` xojo > Var p As New Picture(Me.Width, Me.Height) > > Me.DrawInto(p.Graphics, 0, 0) > Canvas1.Backdrop = p > ```

forsearch

DesktopMoviePlayer.Play **Play** > Plays the current movie. > > The following example opens the movie that the user chose and plays it. > > ``` xojo > Var f As FolderItem = FolderItem.ShowOpenFileDialog(FileTypes1.VideoMp4) > > If f <> Nil Then > MoviePlayer1.RepeatInReverse = False > MoviePlayer1.Movie = Movie.Open(f) > MoviePlayer1.Play > End If > ```

forsearch

DesktopMoviePlayer.Refresh **Refresh**(immediately As `Boolean` = `False`) > Redraws the portion specified of the contents of the control the next time the OS redraws the control or immediately if `True` is passed. > > If you are calling this so frequently that you experience a slowdown in your code, pass `True` for the immediately parameter. > > Calling this method causes the Render event to fire. > > Refresh the entire area immediately: > > ``` xojo > Me.Refresh(True) > ``` ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

DesktopMoviePlayer.Refresh **Refresh**(x As `Integer`, y As `Integer`, width As `Integer`, height As `Integer`, immediately As `Boolean` = `False`) > Redraws the portion specified of the contents of the control the next time the OS redraws the control or immediately if `True` is passed. > > Refresh a portion of the area the next time the OS redraws the control: > > ``` xojo > Me.Refresh(100, 150, 200, 300) > ```

forsearch

DesktopMoviePlayer.SetFocus **SetFocus** > If applicable, sets the focus to the DesktopUIControl. 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 `DesktopWindow` 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. > >

> >

> > Note > >

> > On macOS, 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 in the Opening event sets the focus to the that control. If another control has the focus when this line is executed, then the user sees this control gets the focus. > > ``` xojo > Me.SetFocus > ```

forsearch

DesktopMoviePlayer.Stop **Stop** > Stops the current movie. > > This example stops the current movie that is playing in MoviePlayer1. > > ``` xojo > MoviePlayer1.Stop > ``` ## Event descriptions

forsearch

DesktopMoviePlayer.Closing **Closing** > The control is closing.

forsearch

DesktopMoviePlayer.ConstructContextualMenu **ConstructContextualMenu**(Base As `DesktopMenuItem`, 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. > > ``` xojo > ' Add some items > base.AddMenu(New DesktopMenuItem("Test 1")) > base.AddMenu(New DesktopMenuItem("Test 2")) > base.AddMenu(New DesktopMenuItem("Test 3")) > > ' Add a Separator > base.AddMenu(New DesktopMenuItem(DesktopMenuItem.TextSeparator)) > > ' Add a sub menu > Var submenu As New DesktopMenuItem("SubMenu") > submenu.AddMenu(New DesktopMenuItem("SubMenu Test 1")) > submenu.AddMenu(New DesktopMenuItem("SubMenu Test 2")) > submenu.AddMenu(New DesktopMenuItem("SubMenu Test 3")) > base.AddMenu(submenu) > > ' Add a Separator > base.AddMenu(New DesktopMenuItem(DesktopMenuItem.TextSeparator)) > > Return True > ```

forsearch

DesktopMoviePlayer.ContextualMenuItemSelected **ContextualMenuItemSelected**(HitItem As `DesktopMenuItem`) As `Boolean` > Fires when a contextual menuitem *selectedItem* was selected but the `MenuItemSelected` event and the MenuHandler for the `DesktopMenuItem` 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 `MenuItemSelected` event or the Menu Handler for the items on the contextual menu. See the example of a contextual menu in the examples for the **DesktopUIControl** 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 ContextualMenuItemSelected 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. > > ``` xojo > If selectedItem <> Nil Then MessageBox(selectedItem.Text) > Return True > ```

forsearch

DesktopMoviePlayer.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."

forsearch

DesktopMoviePlayer.DragEnter **DragEnter**(obj As `DragItem`, Action As `DragItem.Types`) As `Boolean` > Fires when the passed `DragItem` enters the DesktopUIControl. > > Returns a `Boolean`. Return `True` from this event to prevent the drop from occurring. > > The Action parameter specifies the type of drag action. > > To restrict file drops to just folders (and not files), you can put this code in the DragEnter event: > > ``` xojo > If Not obj.FolderItem.IsFolder Then Return True > ```

forsearch

DesktopMoviePlayer.DragExit **DragExit**(obj As `DragItem`, Action As `DragItem.Types`) > Fires when the passed `DragItem` exits the DesktopUIControl. > > The *obj* parameter is the item being dragged. The *Action* parameter specifies the type of drag action.

forsearch

DesktopMoviePlayer.DragOver **DragOver**(x As `Integer`, y As `Integer`, obj As `DragItem`, Action As `DragItem.Types`) As `Boolean` > Fires when the `DragItem` is over the DesktopUIControl. > > The *obj* parameter is the object being dragged. The coordinates x and y are relative to the **DesktopUIControl**. Returns a `Boolean`. Return `True` from this event to prevent the drop from occurring. > > The *Action* parameter specifies the type of drag action, which is typically done by holding down a modifier key (Shift, Alt, Option, Command, etc.) while doing the drag.

forsearch

DesktopMoviePlayer.DropObject **DropObject**(obj As `DragItem`, action As `DragItem.Types`) > The item represented by *obj* has been dropped on the control. > > The *obj* parameter is the object being dragged. The *action* parameter specifies the type of drag action. > > 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 Opening event. > > ``` xojo > If Obj.PictureAvailable Then > Me.Image = obj.Picture > ElseIf Obj.FolderItemAvailable Then > Me.Image = Picture.Open(obj.FolderItem) > End If > ```

forsearch

DesktopMoviePlayer.FocusLost **FocusLost** > The `control` has lost the focus. > >

> >

> > Note > >

> > On macOS, controls other than text fields and lists will accept and lose focus only if the full keyboard access option is enabled in System Preferences/Keyboard. > >

forsearch

DesktopMoviePlayer.FocusReceived **FocusReceived** > The `control` has received the focus and has a selection rectangle around it. > >

> >

> > Note > >

> > On macOS, controls other than text fields and lists will accept focus only if the full keyboard access option is enabled in System Preferences/Keyboard. > >

forsearch

DesktopMoviePlayer.KeyDown **KeyDown**(Key As `String`) As `Boolean` > The user has pressed the *Key* passed while the `control` has the focus. > > 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.

forsearch

DesktopMoviePlayer.KeyUp **KeyUp**(Key As `String`) > Fires when the passed *Key* is released in the control that has the focus. > > It is not guaranteed to be the same key that received the KeyDown event.

forsearch

DesktopMoviePlayer.MouseEnter **MouseEnter** > The mouse has entered the area of the control.

forsearch

DesktopMoviePlayer.MouseExit **MouseExit** > The mouse has left the area of the control.

forsearch

DesktopMoviePlayer.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.

forsearch

DesktopMoviePlayer.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.

forsearch

DesktopMoviePlayer.MovieStarted **MovieStarted** > The current movie has started playing.

forsearch

DesktopMoviePlayer.MovieStopped **MovieStopped** > The current movie has stopped playing.

forsearch

DesktopMoviePlayer.Opening **Opening** > The control is about to be displayed. Use this event to initialize a control. > > The Opening event is called after the Constructor. > > Be warned that initializing control property values using the Constructor instead of the Opening event may result in those property values being overwritten by what is set in the Inspector. For best results, use the Opening 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. > > ``` xojo > Sub Opening() > Me.AcceptPictureDrop > Me.AcceptFileDrop("JPEG") > End Sub > ``` ## Notes Windows uses the Windows Movie Player to play movies and macOS uses AVFoundation. On Linux, the MoviePlayer uses GStreamer by default (it requires libgstreamer-1). The DesktopMoviePlayer works correctly only under X11. 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: ``` xojo Var obj As OLEObject = MoviePlayer1.MovieController obj.Value("stretchToFit") = True ``` ### Playing a movie on Linux When an app runs on Wayland, the movie plays in a separate, detached window unless gstreamer1.0-gtk3 is installed. ## Sample code This code sets the movie "myHomeMovie" as the movie to be played. ``` xojo MoviePlayer1.Movie = myHomeMovie ``` --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- This code loads a movie called "MyMovie" from the current folder into MoviePlayer1 and plays it. ``` xojo Var f As FolderItem = FolderItem.ShowOpenFileDialog("MyMovie") If f <> Nil Then MoviePlayer1.HasVolumeControl = True MoviePlayer1.HasStepControls = False MoviePlayer1.Movie = Movie.Open(f) MoviePlayer1.Play End If ``` --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- If you added the movie to your project, you can assign it to the movie property with only one line of code: ``` xojo MoviePlayer1.Movie = MyMovie ``` --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- The following code uses the OLEMovieObject property to get the current position of the player: ``` xojo Var pos As Double = MoviePlayer1.OLEMovieObject.Controls.CurrentPosition ``` ## Compatibility | | | |-----------------------|---------| | **Project Types** | Desktop | | **Operating Systems** | All |

`DesktopUIControl` parent class; `Movie.OpenURL` function; `Movie`, `WebMoviePlayer` classes.