ActiveX

2006-07-18T16:30:10Z

Dev: /* Options */

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
|}

==Options==
The <code>addTarget</code> method accept the following options :
*<code>:audio-track=''index''</code>
*<code>:vout-filter=''output-filter''</code> (<code>deinterlace</code> for example)
*<code>:deinterlace-mode=''mode''</code> (<code>linear</code> for example)

==Samples==
*[[ActiveX/Delphi|Delphi Implementation]]

* [[ActiveX/HTML|HTML Implementation]]

==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]

ActiveX/HTML

2006-07-18T16:26:22Z

Dev: /* Known Problems and how to solve them */

==Embedding Activex using Javascript==

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();

==Embedding ActiveX using m3u Playlists==
Maybe a better to show VLC in an HTML Website is to use m3u Playlists. It has got the advantage that users with turned-off Javascript can also use this plugin, since document.vlc.addTarget won't work with javascript turned off.

* Step 1: Create the HTML website with the VLC-Object linked to the m3u playlist
* Step 2: Create your m3u playlist with all options, save and upload it to your webspace.
* Step 3 (optional): Create buttons and other objects to control VLC (like document.vlc.play();)

'''Step 1: Creating the website to embed ActiveX Control'''
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">
<HTML>
<BODY marginwidth="0" marginheight="0" topmargin="0" leftmargin="0">
<OBJECT classid="clsid:E23FE9C6-778E-49D4-B537-38FCDE4887D8"
codebase="http://downloads.videolan.org/pub/videolan/vlc/latest/win32/axvlc.cab"
width="400" height="300" id="vlc" events="True">
<param name="Src" value="myplaylist.m3u" />
<param name="ShowDisplay" value="True" />
<param name="AutoLoop" value="True" />
<param name="AutoPlay" value="True" />
<param name="Volume" value="100">
</OBJECT>
</BODY>
</HTML>
You should modify the values of width, height and volume (0-100) fitting to your desires. If you don't know them, simply delete them (e.g. remove ''width="640"'' from the code).

'''Step 2: Creating the m3u playlist'''

Open Notepad, create your playlist and save it as 'myplaylist.m3u' for this example.
#EXTM3U // Required to identify this file as m3u file
#EXTVLCOPT--input-repeat=-1 // repeat the following file/playlist
#EXTVLCOPT--http-reconnect=true // required for a streaming-client to enable repeat
#EXTVLCOPT--any further parameter goes here // see also [[VLC command-line help]]
#EXTINF:0, Test Description // set the title for the following file shown in your playlist
video.mpg // the actual file to be displayed

'''Annotations:'''
* For actual looping of the entire playlist, the user has to have check 'Repeat all' under Preferences --> Playlist --> General
* Mind that options have different names if you play a file locally or if you want to stream it (--sub-filter --> --s-filter)

'''Mind the different Options-styles:'''
--option A global option that is set for the duration of the program.
-option A single letter version of a global --option.
:option An option that only applies to the playlistitem directly before it
and that overrides previous settings.

==Known Problems and how to solve them==

'''Problem'''

A know problem is, that the VLC-Plugin won't be displayed. Instead, you are ask whether you want to install the VLC-ActiveX-Component. "Don't install" cancels the installation and nothing happens. "Install" runs the usual VLC-Setup (mind to install the ActiveX-Plugin), but after reopening an HTML-page with the VLC-Plugin, it's the same situation as before.

'''Solution'''

You have to lower the security settings on your PC. '''Do this at your own risk! Use [http://www.getfirefox.com Firefox] to browse the web!'''

In Internet Explorer select [Tools], [Internet Options]. The "Internet Options" window opens. Select the Tab "Advanced". Scroll down until you see the main point "Security".

Check the following entries:
* Allow active content to CDs to run on My Computer
* Allow active content to run in files on My Computer
* Allow software to run or install even if the signature is invalid

'''Solution 2'''
Instead of lowering security level, you can add the website address to the right security area.

==See also==
* [[ActiveX/Delphi|Delphi Implementation]]

* [[ActiveX|ActiveX Description]]

VideoLAN Wiki - User contributions [en]

ActiveX

ActiveX/HTML