Media Player Object Plugin

Actions

In addition to the generic "Plugin" actions supported by all plugin objects, the Media Player plugin also supports the following actions:

number MediaPlayer.GetCurrentPos (string ObjectName);

Description:

Gets the current playback position (in seconds) of a Media Player object.

ObjectName:

(string) The name of the Media Player object that you want to apply this action to.

Returns:

(number) The current playback position of the Media Player object, in seconds.

Example:

-- Get the current playback position and the total clip length
-- and display the information in a label object. This could be
-- done on a page's "On Timer" event to display playback progress
local length = MediaPlayer.GetLength("media_player");
local pos = MediaPlayer.GetCurrentPos("media_player");
local msg = string.format("%.2f/%.2f",pos,length);
Label.SetText("time",msg);

number MediaPlayer.GetLength (string ObjectName);

Description:

Gets the length of the currently loaded media (in seconds) of a Media Player object.

ObjectName:

(string) The name of the Media Player object that you want to apply this action to.

Returns:

(number) The length of the currently loaded media, in seconds.

Example:

-- Get the current playback position and the total clip length
-- and display the information in a label object. This could be
-- done on a page's "On Timer" event to display playback progress
local length = MediaPlayer.GetLength("media_player");
local pos = MediaPlayer.GetCurrentPos("media_player");
local msg = string.format("%.2f/%.2f",pos,length);
Label.SetText("time",msg);

number MediaPlayer.GetState (string ObjectName);

Description:

Gets the current state of a Media Player object.

ObjectName:

(string) The name of the Media Player object that you want to apply this action to.

Returns:

(number) The state of the Media Player object:

VIDEO_STOPPED (0) - Stopped.
VIDEO_PAUSED (1) - Paused.
VIDEO_PLAYING (2) - Playing.

Example:

-- This script could be put onto a play/pause toggle button's On Click 
-- event in order to toggle the text on the button
if((MediaPlayer.GetState("media_player") == VIDEO_PAUSED) or (MediaPlayer.GetState("media_player") == VIDEO_STOPPED))then
    MediaPlayer.Play("media_player");
    Button.SetText("ButtonPlay", "PAUSE");
else
    MediaPlayer.Pause("media_player");
    Button.SetText("ButtonPlay", "PLAY");
end

number MediaPlayer.GetVolume (string ObjectName);

Description:

Gets the volume of a Media Player object.

Note: This action does not work reliably with the Media Player 6.4 ActiveX control, but it works fine with the Media Player 9.0+ control.

ObjectName:

(string) The name of the Media Player object that you want to apply this action to.

Returns:

(number) The current volume of the Media Player object. 0 means silent, 100 is maximum volume.

Example:

-- Get the current volume level of a Media Player object
nVolume = MediaPlayer.GetVolume("media_player");

MediaPlayer.Load (string ObjectName, string Filename);

Description:

Loads a media file into a Media Player object.

ObjectName:

(string) The name of the Media Player object that you want to apply this action to.

Filename:

(string) The fully qualified path and filename of the media file to load.

Returns:

Nothing.

Example:

-- Display a File Browse Dialog, and then play the video that they select    

-- Pick a nice default folder to start the browsing in (My Documents)    
myfolder = Shell.GetFolder(SHF_MYDOCUMENTS);    

-- Show the file browse dialog    
strExtensions = "All Video Files (*.avi;*.mpg;*.wmv;*.asf)|*.avi;*.mpg;*.wmv;*.asf|All Files (*.*)|*.*|";    
tFiles = Dialog.FileBrowse(true, "Load Video", myfolder, strExtensions, "", "", false, true);    

-- Only load the video if they did not press Cancel    
if tFiles[1] ~= "CANCEL" then    
    -- make sure the object is visible before trying to load a video    
    Plugin.SetVisible("media_player", true);    
	    
    -- Load the video File    
    MediaPlayer.Load("media_player",tFiles[1]);    
    
    -- Play the video    
    Video.Play("Video1");    
end    

MediaPlayer.Pause (string ObjectName);

Description:

Pauses the playback of a Media Player object.

ObjectName:

(string) The name of the Media Player object that you want to apply this action to.

Returns:

Nothing.

Example:

-- Pause playback in a Media Player object
MediaPlayer.Pause("media_player");

MediaPlayer.Play (string ObjectName);

Description:

Starts the playback of a Media Player object.

ObjectName:

(string) The name of the Media Player object that you want to apply this action to.

Returns:

Nothing.

Example:

-- Start playback in a Media Player object
MediaPlayer.Play("media_player");

MediaPlayer.Seek (string ObjectName, number SeekType, number SeekTime = 0);

Description:

Seeks to a position in a media clip that is loaded in a Media Player object.

ObjectName:

(string) The name of the Media Player object that you want to apply this action to.

SeekType:

(number) The type of seek to perform:

SEEK_BEGINNING (0) - Seek to the beginning of the current track.
SEEK_END (1) - Seek to the end of the current track.
SEEK_FORWARD (2) - Seek forward.
SEEK_BACKWARD (3) - Seek backward.
SEEK_SPECIFIC (4) - Seek to a specific time within the track.

SeekTime:

(number) The time in seconds to seek to (or seek by). Defaults to 0.

Note: SeekTime is only used if SeekType is 2, 3 or 4.

Returns:

Nothing.

Example:

-- Rewind the media clip    
MediaPlayer.Seek("media_player", SEEK_BEGINNING);    

-- Seek forward seven and one half seconds    
MediaPlayer.Seek("media_player", SEEK_FORWARD, 7.5);    

-- Seek to fifteen seconds into the clip    
MediaPlayer.Seek("media_player", SEEK_SPECIFIC, 15);    

MediaPlayer.SetFullScreen (string ObjectName, boolean Fullscreen);

Description:

Controls whether a Media Player object will play in full screen mode or at its normal size.

ObjectName:

(string) The name of the Media Player object that you want to apply this action to.

Fullscreen:

(boolean) Whether the Media Player window should go to full screen mode. If true, the Media Player window will go to full screen mode (if it isn't already full screen). If false, it will return to normal size (if it isn't already normal).

Note: For Windows Media Player 9.0+ you must call this action after loading your media file. Calling this action before you load your media file will have no effect.

Returns:

Nothing.

Example:

-- Make the Media Player object go full screen
MediaPlayer.SetFullScreen("media_player", true);

MediaPlayer.SetVolume (string ObjectName, number Volume);

Description:

Sets the volume level of a Media Player object. The volume can range from 0 (silent) to 100 (full).

Note: This action does not work reliably with the Media Player 6.4 ActiveX control, but it works fine with the Media Player 9.0+ control.

ObjectName:

(string) The name of the Media Player object that you want to apply this action to.

Volume:

(number) The volume level to set (0-100).

Returns:

Nothing.

Example:

-- Set the volume to 50%
MediaPlayer.SetVolume("media_player", 127);

MediaPlayer.Stop (string ObjectName);

Description:

Stops the playback of a Media Player object.

ObjectName:

(string) The name of the Media Player object that you want to apply this action to.

Returns:

Nothing.

Example:

-- Stop the playback in a Media Player object
MediaPlayer.Stop("media_player");