ActiveX

2006-02-18T17:49:43Z

Webstorm: HTML code example

The [[Windows]] build of VLC includes an (optionaly installed) '''ActiveX control'''. The ActiveX control enables VLC to be embedded in web browsers and third-party applications.

==Properties==

The ActiveX control includes the following properties:
{|
|'''''name'''''
|'''''type'''''
|'''''get or set'''''
|'''''description'''''
|-
|Length
|Integer
|get
|Returns length of the current clip.
|-
|playlistCount
|
|get
|Returns the count of items in the playlist
|-
|playlistIndex
|
|get
|Returns the index of the current item in the playlist.
|-
|AutoLoop
|Boolean
|get/set
|Determines if the player should automatically loop when it finishes the current playlist.
|-
|AutoPlay
|Boolean
|get/set
|Determines if the player should start playing a new file/playlist immediately upon being loaded.
|-
|Volume
|Integer
|get/set
|Current volume (scaled from 0 to 100)
|-
|MRL
|String
|get/set
|Presumably returns the MRL of the currently loaded file.
|-
|Time
|Integer
|get/set
|Time elapsed in seconds playing current MRL, 0 for live feed\
|-
|showdisplay
|Boolean
|get/set
|show/hide control viewport
|-
|Playing
|Boolean
|get
|Returns whether some MRL is playing
|-
|Position
|'real'
|get/set
|Playback position within current MRL, scaled from 0.0 to 1.0. Live feed returns 0.0
|-
|VersionInfo
|String
|get
|Returns version and build information.
|}
Note: In Visual Basic, type "Long" should be used for properties listed with type "Integer".

==Methods==
The ActiveX control includes the following methods (functions):
{|
|'''''name'''''
|'''''type'''''
|'''''description'''''
|'''''syntax ([[wikipedia:Visual Basic|VB]])'''''
|-
|setVariable
|method
|Assigns a value to a variable that is defined in libvlc.c
|controlname.setVariable name as String, value
|-
|getVariable
|method
|Returns the contents of a variable that is defined in libvlc.c
|x = controlname.getVariable(name as String)
|-
|pause
|method
|Pauses the currently playing clip
|controlname.pause
|-
|play
|method
|Plays as in the normal player, if a clip is not loaded, does nothing.
|controlname.play
|-
|playFaster
|method
|Makes the currently playing clip play faster.
|controlname.playFaster
|-
|playSlower
|method
|Makes the currently playing clip play slower.
|controlname.playSlower
|-
|stop
|method
|Makes the currently playing clip stop.
|controlname.stop
|-
|shuttle
|method
|Moves the playback position a specified number of seconds in either direction.
|controlname.shuttle(seconds as Long)
|-
|playlistClear
|method
|Clears the playlist
|controlname.playlistClear
|-
|playlistNext
|method
|Goes to next item in the playlist
|controlname.playlistNext
|-
|playlistPrev
|method
|Goes to previous item in the playlist
|controlname.playlistPrev
|-
|addTarget
|method
|Adds a uri to the current playlist or replaces the current playlist with the uri.
|controlname.addTarget(uri as String, options, mode as [[VLCPlaylistMode]], Position as Long)
|-
|toggleMute
|method
|Toggles between the muted/unmuted state of the embedded player.
|controlname.toggleMute
|-
|fullscreen
|method
|Toggles between fullscreen and non-fullscreen modes.
|controlname.fullscreen
|}
==Samples==
*[[ActiveX/Delphi|Delphi Implementation]]

==HTML code example==
You can insert the ActiveX control in your HTML pages like this :

<OBJECT classid="clsid:E23FE9C6-778E-49D4-B537-38FCDE4887D8"
codebase="http://downloads.videolan.org/pub/videolan/vlc/latest/win32/axvlc.cab"
width="640" height="480" id="vlc" events="True">
<param name="Src" value="" />
<param name="ShowDisplay" value="True" />
<param name="AutoLoop" value="False" />
<param name="AutoPlay" value="False" />
</OBJECT>

Then, using Javascript, you can select another source, or change the audio track :

document.vlc.playlistClear();
var options=[":audio-track=5"]; // select audio track 5 (=6th, 1st is 0)
document.vlc.addTarget("...",options,2,0); // replace entry 0
document.vlc.play();

==Installing==
The ActiveX control can be installed as an option when using the Windows installer, it is also included in the Windows zip file.
Also note that the ActiveX control can be automatically installed using the http://downloads.videolan.org/pub/videolan/vlc/latest/win32/axvlc.cab file. This can be useful if you want to embed the ActiveX control in a web page.
==See Also==
*[http://trac.videolan.org/vlc/file/trunk/activex/README.TXT Official ReadMe]

VideoLAN Wiki - User contributions [en]

ActiveX