Difference between revisions of "ActiveX"

From VideoLAN Wiki
Jump to navigation Jump to search
m (more wikification)
(→‎Properties and Methods: case on Position and Length, added some more. Plan to add VLCPlaylistMode with enum data)
Line 9: Line 9:
 
|'''''syntax ([[wikipedia:Visual Basic|VB]])'''''
 
|'''''syntax ([[wikipedia:Visual Basic|VB]])'''''
 
|-
 
|-
|length
+
|Length
 
|property (get only)
 
|property (get only)
 
|Returns length of the current clip.
 
|Returns length of the current clip.
 
|-
 
|-
|position
+
|Position
 
|property (get and set)
 
|property (get and set)
 
|Return or set the playback position on the current clip.   
 
|Return or set the playback position on the current clip.   
Line 84: Line 84:
 
|Presumably toggles between the muted/unmuted state of the embedded player.
 
|Presumably toggles between the muted/unmuted state of the embedded player.
 
|controlname.toggleMute
 
|controlname.toggleMute
 +
|-
 +
|AutoLoop
 +
|property
 +
|Boolean value, determines if the player should automatically loop when it finishes the current playlist. 
 +
|-
 +
|AutoPlay
 +
|property
 +
|Boolean value, determines if the player should start playing a new file/playlist immediately upon being loaded. 
 +
|-
 +
|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)
 
|}
 
|}
  

Revision as of 23:57, 16 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 and Methods

The ActiveX control includes the following properties and methods (functions):

name type description syntax (VB)
Length property (get only) Returns length of the current clip.
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
playlistCount property (get only) Returns the count of items in the playlist
playlistIndex property (get only) Returns the index of the current item in the playlist.
toggleMute method Presumably toggles between the muted/unmuted state of the embedded player. controlname.toggleMute
AutoLoop property Boolean value, determines if the player should automatically loop when it finishes the current playlist.
AutoPlay property Boolean value, determines if the player should start playing a new file/playlist immediately upon being loaded.
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)

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.