PlaySound

Purpose:

Sends the content in a Form Object to a URL

Category:

Multimedia

Syntax:

PlaySound "music file" loop

music file

A compatible music file to play (.mp3 recomended).

loop

A boolean value (true or false) for repeating the sound continuosly.

Example:

PlaySound "mymusic.mp3" false


StopSound

Purpose:

Stop individual or all playing sound files started with PlaySound. Leave the file name parameter blank to stop all sounds.

Category:

Multimedia

Syntax:

StopSound "file name or URL of audio"
file name or URL of audio

The sound to stop. Leave blank to stop all sounds.

Example:

StopSound "mymusic.mp3"


SoundBeep

Purpose:

Plays a beep sound.

Category:

Multimedia

Syntax:

SoundBeep

Example:

SoundBeep


CreateVideoPlayer

Purpose:

Create a video (mp4) player inside a Container.

Category:

Multimedia

Syntax:

CreateVideoPlayer "object name" "file name" playcontrols autoplay loop muted

object name

The name of an existing Container object.

file name

Complete .mp4 file path or URL.
If you choose a file from your local hard drive, it will be copied automatically to the Build Folder once your project is compiled.

playcontrols

Show or hide play controls (true or false).

autoplay

Set autoplay (true or false).

loop

Loop video when finished (true or false)

muted

No sound (true or false)

Example:

CreateVideoPlayer "Container1" "c:\myvideos\myvideo.mp4" true false false false


VideoPlayerPlay

Purpose:

Play a video previosly created with CreateVideoPlayer

Category:

Multimedia

Syntax:

VideoPlayerPlay "object name"

object name

The name of the Container object where the Video Player has been created.

Example:

VideoPlayerPlay "Container1"


VideoPlayerPause

Purpose:

Pauses a video previosly created with CreateVideoPlayer

Category:

Multimedia

Syntax:

VideoPlayerPause "object name"

object name

The name of the Container object where the Video Player has been created.

Example:

VideoPlayerPause "Container1"


VideoPlayerStop

Purpose:

Stop a video previosly created with CreateVideoPlayer

Category:

Multimedia

Syntax:

VideoPlayerStop "object name"

object name

The name of the Container object where the Video Player has been created.

Example:

VideoPlayerStop "Container1"


VideoPlayerSetCurrentTime

Purpose:

Set video position in seconds

Category:

Multimedia

Syntax:

VideoPlayerSetCurrentTime "object name" "seconds"

object name

The name of the Container object where the Video Player has been created.

seconds

Number of seconds from the begining

Example:

VideoPlayerSetCurrentTime "Container1" 5


VideoPlayerGetCurrentTime

Purpose:

Get video position in seconds

Category:

Multimedia

Syntax:

VideoPlayerSetCurrentTime "object name" [var name]

object name

The name of the Container object where the Video Player has been created.

var name

Variable to store the value.

Example:

VideoPlayerGetCurrentTime "Container1" [myvar]


VideoPlayerSetVolume

Purpose:

Set the video sound volume percentage

Category:

Multimedia

Syntax:

VideoPlayerSetVolume "object name" percentage

object name

The name of the Container object where the Video Player has been created.

percentage

Sound volume percentage value (0-100).

Example:

VideoPlayerSetVolume "Container1" 60


VideoPlayerSetSrc

Purpose:

Set the video player source file (.mp4)

Category:

Multimedia

Syntax:

VideoPlayerSetSrc "object name" "file name"

object name

The name of the Container object where the Video Player has been created.

file name

Complete .mp4 file path or URL.
If you choose a file from your local hard drive, it will be copied automatically to the Build Folder once your project is compiled.

Example:

VideoPlayerSetSrc "Container1" "c:\myvideos\myvideofile.mp4"


VideoPlayerSetPlaybackRate

Purpose:

Set the playback speed (0.5 half speed, 2 double...)

Category:

Multimedia

Syntax:

VideoPlayerSetPlaybackRate "object name" rate

object name

The name of the Container object where the Video Player has been created.

rate

rate number (0.5 half speed, 2 double speed...)

Example:

VideoPlayerSetPlaybackRate "Container1" 2


VideoPlayerSetProperty

Purpose:

Set any of the video player properties on or off

Category:

Multimedia

Syntax:

VideoPlayerSetProperty "object name" "property name" value

object name

The name of the Container object where the Video Player has been created.

property name

One of the valid videoplayer properties: autoplay, controls, loop, muted

value

true or false

Example:

VideoPlayerSetProperty "Container1" "controls" true


VideoPlayerGetProperty

Purpose:

Get any of the video player properties value

Category:

Multimedia

Syntax:

VideoPlayerGetProperty "object name" "property name" [var name]

object name

The name of the Container object where the Video Player has been created.

property name

One of the valid videoplayer properties: autoplay, controls, loop, muted

var name

Variable to store the value.

Example:

VideoPlayerGetProperty "Container1" "controls" [myvar]


OnVideoEvent

Purpose:

Set the subroutine to execute when a video event occurs

Category:

Multimedia

Syntax:

OnVideoEvent "object name" "video event" "subroutine name"

object name

The name of the Container object where the Video Player has been created.

video event

One of the valid video events:
canplay: Fires when the browser can start playing the audio/video
canplaythroug: Fires when the browser can play through the audio/video without stopping for buffering
loadstart: Fires when the browser starts looking for the audio/video
ended: Fires when the current playlist is ended
error: Fires when an error occurred during the loading of an audio/video
pause: Fires when the audio/video has been paused
play: Fires when the audio/video has been started or is no longer paused
seeking: Fires when the user starts moving/skipping to a new position in the audio/video
timeupdate: Fires when the current playback position has changed
waiting: Fires when the video stops because it needs to buffer the next frame

subroutine name

Name of the subroutine to execute.

Example:

OnVideoEvent "Container1" "ended" "mysubroutine"


CreateAudioPlayer

Purpose:

Create an audio (mp3) player inside a Container.

Category:

Multimedia

Syntax:

CreateAudioPlayer "object name" "file name" playcontrols autoplay loop

object name

The name of an existing Container object.

file name

Complete .mp3 file path or URL.
If you choose a file from your local hard drive, it will be copied automatically to the Build Folder once your project is compiled.

playcontrols

Show or hide play controls (true or false).

autoplay

Set autoplay (true or false).

loop

Loop video when finished (true or false)

Example:

CreateAudioPlayer "Container1" "c:\mymusic\myaudio.mp3" true false false


AudioPlayerPlay

Purpose:

Play an audio previosly created with CreateAudioPlayer

Category:

Multimedia

Syntax:

AudioPlayerPlay "object name"

object name

The name of the Container object where the Audio Player has been created.

Example:

AudioPlayerPlay "Container1"


AudioPlayerPause

Purpose:

Pauses an audio previosly created with CreateAudioPlayer

Category:

Multimedia

Syntax:

AudioPlayerPause "object name"

object name

The name of the Container object where the Audio Player has been created.

Example:

AudioPlayerPause "Container1"


AudioPlayerStop

Purpose:

Stop an audio previosly created with CreateAudioPlayer

Category:

Multimedia

Syntax:

AudioPlayerStop "object name"

object name

The name of the Container object where the Audio Player has been created.

Example:

AudioPlayerStop "Container1"


AudioPlayerSetCurrentTime

Purpose:

Set audio player position in seconds

Category:

Multimedia

Syntax:

AudioPlayerSetCurrentTime "object name" "seconds"

object name

The name of the Container object where the Audio Player has been created.

seconds

Number of seconds from the begining

Example:

AudioPlayerSetCurrentTime "Container1" 5


AudioPlayerGetCurrentTime

Purpose:

Get audio player position in seconds

Category:

Multimedia

Syntax:

AudioPlayerSetCurrentTime "object name" [var name]

object name

The name of the Container object where the Audio Player has been created.

var name

Variable to store the value.

Example:

AudioPlayerGetCurrentTime "Container1" [myvar]


AudioPlayerSetVolume

Purpose:

Set the audio player sound volume percentage

Category:

Multimedia

Syntax:

VideoPlayerSetVolume "object name" percentage

object name

The name of the Container object where the Audio Player has been created.

percentage

Sound volume percentage value (0-100).

Example:

AudioPlayerSetVolume "Container1" 60


AudioPlayerSetSrc

Purpose:

Set the audio player source file (.mp3)

Category:

Multimedia

Syntax:

AudioPlayerSetSrc "object name" "file name"

object name

The name of the Container object where the Audio Player has been created.

file name

Complete .mp3 file path or URL.
If you choose a file from your local hard drive, it will be copied automatically to the Build Folder once your project is compiled.

Example:

AudioPlayerSetSrc "Container1" "c:\myaudio\myaudiofile.mp3"


AudioPlayerSetPlaybackRate

Purpose:

Set the playback speed (0.5 half speed, 2 double...)

Category:

Multimedia

Syntax:

AudioPlayerSetPlaybackRate "object name" rate

object name

The name of the Container object where the Audio Player has been created.

rate

rate number (0.5 half speed, 2 double speed...)

Example:

AudioPlayerSetPlaybackRate "Container1" 2


AudioPlayerSetProperty

Purpose:

Set any of the audio player properties on or off

Category:

Multimedia

Syntax:

AudioPlayerSetProperty "object name" "property name" value

object name

The name of the Container object where the Audio Player has been created.

property name

One of the valid audioplayer properties: autoplay, controls, loop, muted

value

true or false

Example:

AudioPlayerSetProperty "Container1" "controls" true


AudioPlayerGetProperty

Purpose:

Get any of the audio player properties value

Category:

Multimedia

Syntax:

AudioPlayerGetProperty "object name" "property name" [var name]

object name

The name of the Container object where the Audio Player has been created.

property name

One of the valid videoplayer properties: autoplay, controls, loop, muted

var name

Variable to store the value.

Example:

AudioPlayerGetProperty "Container1" "controls" [myvar]


OnAudioEvent

Purpose:

Set the subroutine to execute when an audio player event occurs

Category:

Multimedia

Syntax:

OnAudioEvent "object name" "video event" "subroutine name"

object name

The name of the Container object where the Video Player has been created.

video event

One of the valid video events:
canplay: Fires when the browser can start playing the audio/video
canplaythroug: Fires when the browser can play through the audio/video without stopping for buffering
loadstart: Fires when the browser starts looking for the audio/video
ended: Fires when the current playlist is ended
error: Fires when an error occurred during the loading of an audio/video
pause: Fires when the audio/video has been paused
play: Fires when the audio/video has been started or is no longer paused
seeking: Fires when the user starts moving/skipping to a new position in the audio/video
timeupdate: Fires when the current playback position has changed
waiting: Fires when the video stops because it needs to buffer the next frame

subroutine name

Name of the subroutine to execute.

Example:

OnAudioEvent "Container1" "ended" "mysubroutine"