Difference between revisions of "ActiveX"

From VideoLAN Wiki
Jump to navigation Jump to search
Line 10: Line 10:
 
|'''''name'''''
 
|'''''name'''''
 
|'''''type'''''
 
|'''''type'''''
 +
|'''''get or set'''''
 
|'''''description'''''
 
|'''''description'''''
|'''''type'''''
 
 
|-
 
|-
 
|Length
 
|Length
|property (get only)
+
|
 +
|get
 
|Returns length of the current clip.
 
|Returns length of the current clip.
 
|-
 
|-
 
|playlistCount
 
|playlistCount
|property (get only)
+
|
 +
|get
 
|Returns the count of items in the playlist
 
|Returns the count of items in the playlist
 
|-
 
|-
 
|playlistIndex
 
|playlistIndex
|property (get only) <!-- may be settable too, unsure -->
+
|
 +
|get <!-- may be settable too, unsure -->
 
|Returns the index of the current item in the playlist.   
 
|Returns the index of the current item in the playlist.   
 
|-
 
|-
 
|AutoLoop
 
|AutoLoop
|property
+
|Boolean
|Boolean value, determines if the player should automatically loop when it finishes the current playlist.   
+
|both
 +
|Determines if the player should automatically loop when it finishes the current playlist.   
 
|-
 
|-
 
|AutoPlay
 
|AutoPlay
|property
+
|Boolean
|Boolean value, determines if the player should start playing a new file/playlist immediately upon being loaded.   
+
|both
 +
|Determines if the player should start playing a new file/playlist immediately upon being loaded.   
 
|-
 
|-
 
|Volume
 
|Volume
|property
+
|
 +
|both
 
|Presumably sets and gets the volume of VLC's waveout.
 
|Presumably sets and gets the volume of VLC's waveout.
 
|-
 
|-
 
|MRL
 
|MRL
|property
+
|String
 +
|get <!-- possibly set too -->
 
|Presumably returns the MRL of the currently loaded file.
 
|Presumably returns the MRL of the currently loaded file.
 
|-
 
|-
 
|Time
 
|Time
|property
+
|
 +
|
 
|Unknown
 
|Unknown
 
|-
 
|-
 
|object
 
|object
|property
+
|
 +
|
 
|Unknown, possibly a way to access objects and then use getVariable/setVariable on them?
 
|Unknown, possibly a way to access objects and then use getVariable/setVariable on them?
 
|}
 
|}
 +
 
==Methods==
 
==Methods==
 
The ActiveX control includes the following methods (functions):
 
The ActiveX control includes the following methods (functions):

Revision as of 06:40, 18 January 2006

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 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 both Determines if the player should automatically loop when it finishes the current playlist.
AutoPlay Boolean both Determines if the player should start playing a new file/playlist immediately upon being loaded.
Volume both Presumably sets and gets the volume of VLC's waveout.
MRL String get Presumably returns the MRL of the currently loaded file.
Time Unknown
object Unknown, possibly a way to access objects and then use getVariable/setVariable on them?

Methods

The ActiveX control includes the following methods (functions):

name type description syntax (VB)
Position property (get and set) Return or set the playback position on the current clip.
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 Presumably 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 Presumably toggles between the muted/unmuted state of the embedded player. controlname.toggleMute
fullscreen method Presumably toggles between fullscreen and non-fullscreen modes. controlname.fullscreen

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.