Class

WebMoviePlayer


Description

Plays a movie in a web app using the MP4 video capabilities of the client browser.

Methods

Name

Parameters

Returns

Shared

Close

ExecuteJavaScript

script As String

GotoURL

URL As String, inNewWindow As Boolean = False

Pause

Play

SetFocus

UpdateBrowser

Property descriptions


WebMoviePlayer.AllowAutoPlay

AllowAutoPlay As Boolean

If True, the movie will begin playing as soon as enough of the file has downloaded.


WebMoviePlayer.AllowFullScreen

AllowFullScreen As Boolean

If True, the movieplayer shows the FullScreen button. If False, it hides it.


WebMoviePlayer.AllowLooping

AllowLooping As Boolean

If True, the movie will restart when it is playing and reaches the end.


WebMoviePlayer.ContextualMenu

ContextualMenu As WebMenuItem

If you assign a WebMenuItem to the control, it will be displayed when the user right-clicks the control.

On a WebPage, you can disable/remove the default contextual menu by an empty WebMenuItem class object to this property.

This code populates a contextual menu in the Shown event of the control.

Var menu As New WebMenuItem

menu.AddMenuItem("One")
menu.AddMenuItem("Two")
menu.AddMenuItem("Three")
Me.ContextualMenu = menu

The menu selection is then handled by the ContextualMenuSelected event when the user right-clicks on the control. For example, it can be of the form:

Select case hitItem.Text
Case "One"
  MessageBox("One")
Case "Two"
  MessageBox("Two")
Case "Three"
  MessageBox("Three")
End Select

WebMoviePlayer.ControlID

ControlID As String

Identifies the control on a per session basis.

This property is read-only.


WebMoviePlayer.Duration

Duration As Double

The duration (length) of the movie in seconds.

This property is read-only.

This property is set when the DurationChanged event is called.

Var d As Double
d = MoviePlayer1.Duration

WebMoviePlayer.Enabled

Enabled As Boolean

When True the WebControl is drawn enabled and responds to user action. When False, the control appears as disabled and does not respond to user actions.

In the case of WebTimer, when set to False this disables and stops the WebTimer. When set to True, it starts the WebTimer.

Disable a button when a check box value changes:

If AllowSaveCheckBox.Value Then
  SaveButton.Enabled = True
Else
  AllowSaveButton.Enabled = False
End If

WebMoviePlayer.HasController

HasController As Boolean

If True, the movie player's controller is displayed.


WebMoviePlayer.Height

Height As Integer

The height (in pixels) of the control.


WebMoviePlayer.Indicator

Indicator As Indicators

The color scheme for the control.


WebMoviePlayer.Left

Left As Integer

The position of the left side of the WebUIControl in pixels, relative to the web page.


WebMoviePlayer.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 web page.

This property is read-only.


WebMoviePlayer.LockHorizontal

LockHorizontal As Boolean

LockHorizontal overrides LockLeft and LockRight. It allows you to proportionally lock a control's position to the center of its parent control (or web page).

This property is read-only.

For example, if you place a control in the center of the page and sets both LockHorizontal and LockVertical, the control will stay in the center of the page.


WebMoviePlayer.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 web page.

This property is read-only.


WebMoviePlayer.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 web page.

This property is read-only.


WebMoviePlayer.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 web page.

This property is read-only.


WebMoviePlayer.LockVertical

LockVertical As Boolean

LockVertical overrides LockTop and LockBottom. It allows you to proportionally lock a control's position to keep it centered within the parent control or web page.

This property is read-only.

For example, if you place a control in the center of the page, and sets both LockHorizontal and LockVertical, the control will stay in the center of the page.


WebMoviePlayer.MovieURL

MovieURL As String

The URL from which the movie will be downloaded.


WebMoviePlayer.Name

Name As String

The name of the control.

This property is read-only.


WebMoviePlayer.Page

Page As WebPage

Identifies the web page that contains the control.

This property is read-only.


WebMoviePlayer.Parent

Parent As WebControl

Used to get the control's parent control or page. If the parent control is a WebContainer, then it returns the WebContainer. If it is on a WebPage, it returns the WebPage.

This property is read-only.


WebMoviePlayer.Position

Position As Double

The play position of the movie in seconds.

This property is set when the PositionChanged event is called.

Set the movie play position to halfway point:

Var halfway As Double = MoviePlayer1.Duration / 2
MoviePlayer1.Position = halfway

WebMoviePlayer.PosterURL

PosterURL As String

The URL from which an image can be downloaded that will be displayed before the movie is initially played.


WebMoviePlayer.Style

Style As WebStyle

The WebStyle for the control.

In the Pressed event of a WebButton, set the text to bold:

Var style As New WebStyle
style.Bold = True
Me.Style = style

WebMoviePlayer.TabIndex

TabIndex As Integer

The WebUIControl's control's position in the Tab Order. The control with a TabIndex of 0 is the first WebUIControl to get the focus when the page opens in the browser.

This example sets the control's TabIndex.

Me.TabIndex = 2

WebMoviePlayer.Tooltip

Tooltip As String

Text of a message displayed as a tooltip.

The tip is displayed when the user places the mouse on the control and leaves it there.

This code in the Shown event of a Button sets the tooltip:

Me.Tooltip = "Save changes"

WebMoviePlayer.Top

Top As Integer

The top of the control in local coordinates relative to the web page.


WebMoviePlayer.Visible

Visible As Boolean

If True, the control is drawn. If False, it's not.

Hide a control based on a checkbox setting:

If ShowEmailCheckbox.Value Then
  EmailField.Visible = True
Else
  EmailField.Visible = False
End If

WebMoviePlayer.Width

Width As Integer

The width (in pixels) of the web control.

This code in the Shown event handler increases the size of the control:

Me.Width = Me.Width + 50

Method descriptions


WebMoviePlayer.Close

Close

Removes the control from the page.


WebMoviePlayer.ExecuteJavaScript

ExecuteJavaScript(script As String)

Executes the JavaScript passed. The JavaScript passed can call a JavaScript function in a WebPageSource control.

The Xojo web framework uses EcmaScript 6 which is more strict than previous versions of JavaScript. For more details, see the EcmaScript 6 documentation.

This code in the Pressed event of a Button displays an alert using JavaScript:

Me.ExecuteJavaScript("alert('Hello!');")

This code will select the text in a WebTextField (or WebTextArea):

WebTextField1.ExecuteJavascript("document.getElementById('" + _
  WebTextField1.ControlID + "_inner').select();")

WebMoviePlayer.GotoURL

GotoURL(URL As String, inNewWindow As Boolean = False)

Opens the passed URL in place of the current web page or downloads a file. If InNewWindow is True, the browser is asked to open the URL in a new window.

If the browser has popup windows disabled and InNewWindow is True, the method silently fails and the page is not shown.

If InNewWindow is False, the running web app is replaced with the specified URL. If you want to display an external web site within your web app, use the WebHTMLViewer control.

Display a web site in a new popup window:

Me.GotoURL("http://www.wikipedia.org", True)

WebMoviePlayer.Pause

Pause

Pauses the movie.


WebMoviePlayer.Play

Play

Starts playing the movie from its current position.

By default Safari prevents movies from being automatically played in this manner. The user will instead have to click the play button on the player control itself in order to start playing the movie, which then allows this method to work. Alternatively, the user can change their Safari Preferences (Preferences->Websites) for the web site from "Stop Media with Sound" to "Allow All Auto-Play".


WebMoviePlayer.SetFocus

SetFocus

Sets the focus to the Control.

This code checks for a required value when a button is pressed:

If UserNameField.Text.IsEmpty Then
  MessageBox("Please enter your UserName.")
  UserNameField.SetFocus
  Return
End If

WebMoviePlayer.UpdateBrowser

UpdateBrowser

Forces the current values of the control to be sent to the browser.

This method is useful when you are computing values in a loop and wish to update the browser immediately rather than wait until the current method ends.

This code iterates through a RowSet of database rows, updates a ProgressBar and then forces the updated ProgressBar to be sent to the browser via UpdateBrowser.

ProgressBar1.Maximum = SalesData.RowCount
For Each row As DatabaseRow in SalesData
 AnalyzeSales(row)
 ProgressBar1.Value = ProgressBar1.Value + 1
 ProgressBar1.UpdateBrowser
Next

Event descriptions


WebMoviePlayer.Closed

Closed

The control has been removed from the browser either because the page has closed or the control's Close method was called.


WebMoviePlayer.ContextualMenuSelected

ContextualMenuSelected(hitItem As WebMenuItem)

Called when a contextual menu item is selected. This selected item is contained in hitItem.

This code populates a contextual menu in the Opening event of a WebToolbar:

Var menu As New WebMenuItem

menu.AddMenuItem("One")
menu.AddMenuItem("Two")
menu.AddMenuItem("Three")
Me.ContextualMenu = menu

The menu selection is then handled by the ContextualMenuSelected event when the user right-clicks on the control. For example, it can be of the form:

Select case hitItem.Text
Case "One"
  MessageBox("One")
Case "Two"
  MessageBox("Two")
Case "Three"
  MessageBox("Three")
End Select

WebMoviePlayer.DownloadAborted

DownloadAborted

The movie did not finish loading but not as the result of an error.


WebMoviePlayer.DownloadError

DownloadError

An error has occurred during the download.


WebMoviePlayer.DownloadStalled

DownloadStalled

The movie download has stalled.


WebMoviePlayer.DownloadSuspended

DownloadSuspended

The movie download has been suspended.

This differs from the DownloadAborted event in that a download that has been suspended can be resumed.


WebMoviePlayer.DurationChanged

DurationChanged

The duration of the movie has changed. This can happen in real time when the content is being streamed.


WebMoviePlayer.Hidden

Hidden

The control is about to become no longer visible. This could be because the page is being closed, is being replaced as the foreground page by another page or because the control or a parent control's Visible property has been set to False.

Note

This event is equivalent to the DesktopWindow.Deactivated event in a desktop app.


WebMoviePlayer.Opening

Opening

The control has been created and the page is opening but has not been sent to the browser yet.

The Opening event handler can be used to initialize non-visual properties and settings for controls.

In most cases, you should use the Shown event to initialize controls.


WebMoviePlayer.PlaybackEnded

PlaybackEnded

The playback of the movie has ended.


WebMoviePlayer.PlaybackPaused

PlaybackPaused

The playback of the movie has paused either by the code called the Pause method or by the user clicking the Pause button.


WebMoviePlayer.PlaybackProgressed

PlaybackProgressed(seconds As Double)

The length in seconds the movie has been playing since its beginning.


WebMoviePlayer.PlaybackReady

PlaybackReady

Enough of the movie has downloaded that playback of it may begin.


WebMoviePlayer.PlaybackStarted

PlaybackStarted

The playback of the movie has started either via the Play method or by the user clicking the Play button.


WebMoviePlayer.PositionChanged

PositionChanged(seconds As Double)

Called when the movie play position has changed.


WebMoviePlayer.Shown

Shown

The control has appeared on the currently displayed page. This could be because its parent page just finished loading, its parent page has come to the foreground or the control is now visible having been previously invisible because it or its parent control's Visible property has been set to True.

Use the Shown event for initializing your controls or doing anything that would interact with other controls or user interface elements on the web page instead of the Opening event.

Note

This event is the web equivalent to the DesktopWindow.Activated event.

This code in the Shown event of a WebListBox adds 2 rows with 3 columns:

Me.RemoveAllRows
Me.AddRow("Row 1", "Bob", "Roberts")
Me.AddRow("Row 2", "Barb", "Reynolds")

This example sets the text of a label:

If Session.LoggedIn Then
  Me.Text = "Welcome!"
Else
  Me.Text = "Welcome, " + Session.UserName
End If

Notes

WebMoviePlayer uses the built-in HTML5 video player on all browsers. Encoding your movies in MP4 format is recommended as all browsers support that format. Safari also supports .mov files and Firefox supports .ogv files.

Compatibility

Web projects on all supported operating systems.

See also

WebUIControl parent class; WebAudioPlayer control; MoviePlayer desktop control.