Build HTML pages that use the plugin (version > 0.8.5.1)
Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the plugin.
The vlc plugin exports serveral objects that can be accessed for setting and getting information. When used improperly the API's will throw an exception that includes a string that explains what happened. For example when asking for vlc.input.length when there is no playlist item playing.
The vlc plugin knows the following objects:
audio : Access audio properties.
input : Access input properties.
playlist : Access playlist properties.
video : Access video properties.
log : Access log properties.
messages : Access to log message properties.
iterator : Access to log iterator properties.
The following JavaScript code shows howto get a reference to the vlc plugin. This reference can then be used to access the objects of the vlc plugin.
VLC Mozilla plugin test page
Root object
readonly properties
VersionInfo : returns version information string
read/write properties
none
methods
vlc.versionInfo() : returns version information string
Audio object
readonly properties
none
read/write properties
vlc.audio.mute : boolean value to mute and ummute the audio
vlc.audio.volume : a value between [0-200] which indicates a percentage of the volume.
vlc.audio.track : a value between [0-65535] which indicates the audio track to play or that is playing. (supported in vlc version > 0.8.6)
vlc.audio.channel : an integer between 1 and 5 that indicates which audio channel mode is used, values can be: "1=stereo", "2=reverse stereo", "3=left", "4=right", "5=dolby". Use vlc.audio.channel to check if setting of the new audio channel has succeeded. (supported in vlc version > 0.8.6)
Audio Channel:
Stereo
Reverse stereo
Left
Right
Dolby