Class
WebAudioPlayer
Description
Plays sounds and provides a user interface for sound control.
Properties
Name |
Type |
Read-Only |
Shared |
---|---|---|---|
✓ |
|||
✓ |
|||
✓ |
|||
✓ |
|||
✓ |
|||
Methods
Name |
Parameters |
Returns |
Shared |
---|---|---|---|
Script As String |
|||
Events
Name |
Parameters |
Returns |
---|---|---|
hitItem As WebMenuItem |
||
Property descriptions
WebAudioPlayer.AllowAutoPlaying
AllowAutoPlaying As Boolean
When True the audio will begin as soon as enough of it has loaded to allow it to play without having to stop to load more of it.
WebAudioPlayer.AllowLooping
AllowLooping As Boolean
When True, the sound will be played repeatedly, starting over each time it reaches the end.
WebAudioPlayer.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.
WebAudioPlayer.ControlID
ControlID As String
Identifies the control on a per session basis.
This property is read-only.
WebAudioPlayer.Duration
Duration As Double
The duration (in seconds) of time required to play the audio file.
This property is read-only.
WebAudioPlayer.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
WebAudioPlayer.HasController
HasController As Boolean
When True, the WebAudioPlayer will display a set of controls the user can use to control the audio playback.
WebAudioPlayer.Name
Name As String
The name of the control.
This property is read-only.
WebAudioPlayer.Page
Page As WebPage
Identifies the web page that contains the control.
This property is read-only.
WebAudioPlayer.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.
WebAudioPlayer.Position
Position As Double
The number of seconds into playback at which the audio file currently is.
WebAudioPlayer.URL
URL As String
The URL from which the sound file can/will be downloaded.
Method descriptions
WebAudioPlayer.Close
Close
Removes the control from the page.
WebAudioPlayer.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();")
WebAudioPlayer.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)
WebAudioPlayer.Pause
Pause
Pauses audio playback.
WebAudioPlayer.Play
Play
Begins playback of the audio file.
WebAudioPlayer.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
WebAudioPlayer.Closed
Closed
The control has been removed from the browser either because the page has closed or the control's Close method was called.
WebAudioPlayer.ContextualMenuSelected
ContextualMenuSelected(hitItem As WebMenuItem)
Called when a contextual menu item is selected. This selected item is contained in hitItem.
WebAudioPlayer.DownloadAborted
DownloadAborted
The download was aborted by the server.
WebAudioPlayer.DownloadError
DownloadError
An error occurred while download the sound file from the server.
WebAudioPlayer.DownloadStalled
DownloadStalled
The downloading of the file has stalled.
WebAudioPlayer.DownloadSuspended
DownloadSuspended
The downloading of the file has been suspended.
WebAudioPlayer.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.
WebAudioPlayer.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.
WebAudioPlayer.PlaybackBegan
PlaybackBegan
The playback has begun either because the either because the Play method was called, the user pressed the Play button in the controller or AllowAutoPlaying was True and the file has finished downloading.
WebAudioPlayer.PlaybackEnded
PlaybackEnded
Playback of the sound file has ended because the sound file finished playing and AllowAutoPlaying is False.
WebAudioPlayer.PlaybackPaused
PlaybackPaused
Playing of the sound file has paused either because the Pause method was called or because the user pressed the Pause button in the audio player controller.
WebAudioPlayer.PlaybackProgressed
PlaybackProgressed
Playback of the sound file has progressed. If implemented, this event is called frequently while the sound is playing. However, it may be called less frequently should the device need to conserve power.
WebAudioPlayer.PlaybackReady
PlaybackReady
Enough of the sound file has downloaded such that the app can begin playing the sound. The rest of the sound file can download while the sound is playing.
WebAudioPlayer.PlaybackReadyThroughEnd
PlaybackReadyThroughEnd
The sound file has been completely downloaded thus playback can proceed without the need to download the rest of the file while the sound is playing.
WebAudioPlayer.PositionChanged
PositionChanged
The Position property has changed either via code or by the user dragging the position indicator in the web audio player controller.
WebAudioPlayer.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.
Notes
MP3 files are supported for all supported browsers. WAV files are supported on Windows only. Ogg files are supported for FireFox only.
Compatibility
Web projects on all supported operating systems.
See also
WebUIControl parent class