Documentation:WebPlugin - Revision history

Da2424: /* Playlist object */ Improve description for vlc.playlist.parse()

2020-07-05T19:57:57Z

Playlist object: Improve description for vlc.playlist.parse()

← Older revision		Revision as of 19:57, 5 July 2020
Line 504:		Line 504:
	*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist ('''deprecated''', do not use, see [[#Playlist_items_object\|Playlist items]])		*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist ('''deprecated''', do not use, see [[#Playlist_items_object\|Playlist items]])
	*'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number <!-- (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() ) --> ('''deprecated''', do not use, see [[#Playlist_items_object\|Playlist items]])		*'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number <!-- (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() ) --> ('''deprecated''', do not use, see [[#Playlist_items_object\|Playlist items]])
	*'''vlc.playlist.parse(options, timeout)''': (supported in vlc version ≥ 3.0.0) Parse the first media in the playlist. This fetches (local or network) art, meta data and/or tracks information. Returns the parsed status.		*'''vlc.playlist.parse(options, timeout)''': (supported in vlc version ≥ 3.0.0) Parse the first media in the playlist. This fetches (local or network) art, meta data and/or tracks information. A timeout for parsing can be set in milliseconds or to indefinitely (0). Returns the parsed status.

	Available options flags for parsing (which can be combined):		Available options flags for parsing (which can be combined):

Da2424: /* Playlist object */ Improve description for vlc.playlist.parse()

2020-07-05T19:32:13Z

Playlist object: Improve description for vlc.playlist.parse()

@@ Line 505: / Line 505: @@
 *'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number <!-- (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() ) --> ('''deprecated''', do not use, see [[#Playlist_items_object|Playlist items]])
 *'''vlc.playlist.parse(options, timeout)''': (supported in vlc version ≥ 3.0.0) Parse the first media in the playlist. This fetches (local or network) art, meta data and/or tracks information. Returns the parsed status.
 ==== Playlist items object  ====

Da2424: /* Marquee Object */ Update marquee API description for VLC 4.0

2020-07-05T18:59:33Z

Marquee Object: Update marquee API description for VLC 4.0

← Older revision		Revision as of 18:59, 5 July 2020
Line 586:		Line 586:
	read/write properties		read/write properties

	*'''vlc.video.marquee.text''': (supported in vlc version ≥ 1.1.0) display my text on the screen.		*'''vlc.video.marquee.text''': (supported in vlc version ≥ 1.1.0, since vlc version 4.0.0 writeonly) display my text on the screen.
	*'''vlc.video.marquee.color''': (supported in vlc version ≥ 1.1.0) change the text color. val is the new color to use (WHITE=0x000000, BLACK=0xFFFFFF, RED=0xFF0000, GREEN=0x00FF00, BLUE=0x0000FF...).		*'''vlc.video.marquee.color''': (supported in vlc version ≥ 1.1.0) change the text color. val is the new color to use (WHITE=0x000000, BLACK=0xFFFFFF, RED=0xFF0000, GREEN=0x00FF00, BLUE=0x0000FF...).
	*'''vlc.video.marquee.opacity''': (supported in vlc version ≥ 1.1.0) change the text opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).		*'''vlc.video.marquee.opacity''': (supported in vlc version ≥ 1.1.0) change the text opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).

Da2424: /* Video object */ Update crop API description for VLC 4.0

2020-07-05T18:56:12Z

Video object: Update crop API description for VLC 4.0

← Older revision		Revision as of 18:56, 5 July 2020
Line 549:		Line 549:
	*'''vlc.video.scale''': (supported in vlc version ≥ 3.0.0) get and set the video scaling factor as float. That is the ratio of the number of pixels on screen to the number of pixels in the original decoded video in each dimension. Zero is a special value; it will adjust the video to the output window.		*'''vlc.video.scale''': (supported in vlc version ≥ 3.0.0) get and set the video scaling factor as float. That is the ratio of the number of pixels on screen to the number of pixels in the original decoded video in each dimension. Zero is a special value; it will adjust the video to the output window.
	*'''vlc.video.subtitle''': (supported in vlc version > 0.8.6a) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled.		*'''vlc.video.subtitle''': (supported in vlc version > 0.8.6a) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled.
	*'''vlc.video.crop''': get and set the geometry of the zone to crop. This is set as <width> x <height> + <left offset> + <top offset>. A possible value is: "120x120+10+10"		*'''vlc.video.crop''': (removed with vlc version 4.0.0) get and set the geometry of the zone to crop. This is set as <width> x <height> + <left offset> + <top offset>. A possible value is: "120x120+10+10"
	*'''vlc.video.teletext''': (supported in vlc version ≥ 0.9.0) get and set teletext page to show on the video stream. This will only work if a teletext elementary stream is available in the video stream. The property takes an integer as input value [0..1000] for indicating the teletext page to view, setting the value to 0 means hide teletext.		*'''vlc.video.teletext''': (supported in vlc version ≥ 0.9.0) get and set teletext page to show on the video stream. This will only work if a teletext elementary stream is available in the video stream. The property takes an integer as input value [0..1000] for indicating the teletext page to view, setting the value to 0 means hide teletext.
	*'''vlc.video.track''': (supported in vlc version ≥ 2.2.7) a value between [1-65535] which indicates the video track to play or that is playing. a value of 0 means the video is/will be disabled.		*'''vlc.video.track''': (supported in vlc version ≥ 2.2.7) a value between [1-65535] which indicates the video track to play or that is playing. a value of 0 means the video is/will be disabled.
Line 559:		Line 559:
	*'''vlc.video.toggleTeletext()''': (supported in vlc version ≥ 0.9.0) toggle the teletext page to overlay transparent or not, based on the previous setting		*'''vlc.video.toggleTeletext()''': (supported in vlc version ≥ 0.9.0) toggle the teletext page to overlay transparent or not, based on the previous setting
	*'''vlc.video.description(int i)''': (supported in vlc version ≥ 2.2.7) give the i-th video track name. 0 corresponds to disable and 1 to the first video track.		*'''vlc.video.description(int i)''': (supported in vlc version ≥ 2.2.7) give the i-th video track name. 0 corresponds to disable and 1 to the first video track.
			*'''vlc.video.crop_ratio(int numerator, int denominator)''': (supported in vlc version ≥ 4.0.0) Forces a crop ratio on any and all video tracks rendered by the media player. To disable video crop, set a crop ratio with zero as denominator.
			*'''vlc.video.crop_window(int x, int y, int width, int height)''': (supported in vlc version ≥ 4.0.0) Selects a sub-rectangle of video to show. Any pixels outside the rectangle will not be shown. To unset the video crop window, use vlc.video.crop_ratio() or vlc.video.crop_border().
			*'''vlc.video.crop_border(int left, int right, int top, int bottom)''': (supported in vlc version ≥ 4.0.0) Selects the size of video edges to be cropped out. To unset the video crop borders, set all borders to zero.

	==== Deinterlace Object ====		==== Deinterlace Object ====

Da2424: /* Event registration issue with IE11 */ Improve description

2020-07-05T18:17:24Z

Event registration issue with IE11: Improve description

← Older revision		Revision as of 18:17, 5 July 2020
Line 332:		Line 332:
	</syntaxhighlight>		</syntaxhighlight>

	Workaround 2 - Use an old IE-only implementation of event registration:		Workaround 2 - Use an old IE-only implementation of event registration. An example with the MediaPlayerBuffering event:
	<syntaxhighlight lang="javascript" line>		<syntaxhighlight lang="javascript" line>
	<script for="vlc" event="MediaPlayerBuffering(val)">		<script for="vlc" event="MediaPlayerBuffering(val)">

Da2424: /* Root object */ Add workaround descriptions for event registration issue with IE11

2020-07-04T21:23:12Z

Root object: Add workaround descriptions for event registration issue with IE11

@@ Line 321: / Line 321: @@
 //-->
 </syntaxhighlight><syntaxhighlight lang="html5" start="119" line>
 </script>
 </syntaxhighlight>

Da2424: /* Introduction: Building Web pages with Video */ Add note for dropped NPAPI support

2020-07-04T21:05:11Z

Introduction: Building Web pages with Video: Add note for dropped NPAPI support

← Older revision		Revision as of 21:05, 4 July 2020
Line 18:		Line 18:
	{\| class="wikitable"		{\| class="wikitable"
	\|-		\|-
	\| Mozilla Firefox \|\| [[File:Firefox-logo.png\|40x40px]]		\| Mozilla Firefox (up to v51) \|\| [[File:Firefox-logo.png\|40x40px]]
	\|-		\|-
	\| Internet Explorer \|\| [[File:Internet Explorer.png\|40x40px]]		\| Internet Explorer \|\| [[File:Internet Explorer.png\|40x40px]]
	\|-		\|-
	\| Safari \|\| [[File:Apple Safari.png\|40x40px]]		\| Safari (up to v11) \|\| [[File:Apple Safari.png\|40x40px]]
	\|-		\|-
	\| Chrome \|\|		\| Chrome (up to v44) \|\|
	\|-		\|-
	\| Konqueror \|\|		\| Konqueror \|\|
	\|-		\|-
	\| Opera \|\|		\| Opera (up to v36) \|\|
	\|}		\|}

	It has been tested on GNU/Linux, Windows and MacOS.		It has been tested on GNU/Linux, Windows and MacOS.


			'''Note:'''

			In the most of browsers, the support for NPAPI plugins was dropped. Only in some forks of Firefox like Waterfox or Pale Moon, NPAPI plugins are still supported.

			For this reason, the NPAPI plugin will be dropped in vlc version 4.

	== Embed tag attributes ==		== Embed tag attributes ==

Da2424: /* Playlist object */ add vlc.playlist.parse()

2020-04-24T20:28:40Z

Playlist object: add vlc.playlist.parse()

← Older revision		Revision as of 20:28, 24 April 2020
Line 482:		Line 482:
	*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist ('''deprecated''', do not use, see [[#Playlist_items_object\|Playlist items]])		*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist ('''deprecated''', do not use, see [[#Playlist_items_object\|Playlist items]])
	*'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number <!-- (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() ) --> ('''deprecated''', do not use, see [[#Playlist_items_object\|Playlist items]])		*'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number <!-- (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() ) --> ('''deprecated''', do not use, see [[#Playlist_items_object\|Playlist items]])
			*'''vlc.playlist.parse(options, timeout)''': (supported in vlc version ≥ 3.0.0) Parse the first media in the playlist. This fetches (local or network) art, meta data and/or tracks information. Returns the parsed status.

	==== Playlist items object ====		==== Playlist items object ====

Da2424: Add vlc.playlist.stop_async() and the event MediaPlayerStopAsyncDone

2020-04-24T20:10:28Z

Add vlc.playlist.stop_async() and the event MediaPlayerStopAsyncDone

← Older revision		Revision as of 20:10, 24 April 2020
Line 169:		Line 169:
	*'''MediaPlayerPaused''': vlc is in paused state		*'''MediaPlayerPaused''': vlc is in paused state
	*'''MediaPlayerStopped''': vlc is in stopped state		*'''MediaPlayerStopped''': vlc is in stopped state
			*'''MediaPlayerStopAsyncDone''': (supported in vlc version ≥ 3.0.0) playback has stopped asynchronously
	*'''MediaPlayerForward''': vlc is fastforwarding through the media (this never gets invoked)		*'''MediaPlayerForward''': vlc is fastforwarding through the media (this never gets invoked)
	*'''MediaPlayerBackward''': vlc is going backwards through the media (this never gets invoked)		*'''MediaPlayerBackward''': vlc is going backwards through the media (this never gets invoked)
Line 235:		Line 236:
	function handle_MediaPlayerStopped(){		function handle_MediaPlayerStopped(){
	console.log("Stopped");		console.log("Stopped");
			}
			function handle_MediaPlayerStopAsyncDone(){
			console.log("Stopped asynchronously");
	}		}
	function handle_MediaPlayerForward(){		function handle_MediaPlayerForward(){
Line 291:		Line 295:
	registerVLCEvent("MediaPlayerPaused", handle_MediaPlayerPaused);		registerVLCEvent("MediaPlayerPaused", handle_MediaPlayerPaused);
	registerVLCEvent("MediaPlayerStopped", handle_MediaPlayerStopped);		registerVLCEvent("MediaPlayerStopped", handle_MediaPlayerStopped);
			registerVLCEvent("MediaPlayerStopAsyncDone", handle_MediaPlayerStopAsyncDone);
	registerVLCEvent("MediaPlayerForward", handle_MediaPlayerForward);		registerVLCEvent("MediaPlayerForward", handle_MediaPlayerForward);
	registerVLCEvent("MediaPlayerBackward", handle_MediaPlayerBackward);		registerVLCEvent("MediaPlayerBackward", handle_MediaPlayerBackward);
Line 472:		Line 477:
	*'''vlc.playlist.togglePause()''': toggle the pause state for the current playlist item		*'''vlc.playlist.togglePause()''': toggle the pause state for the current playlist item
	*'''vlc.playlist.stop()''': stop playing the current playlist item		*'''vlc.playlist.stop()''': stop playing the current playlist item
			*'''vlc.playlist.stop_async()''': (supported in vlc version ≥ 3.0.0) stop playing the current playlist item asynchronously and fire the event MediaPlayerStopAsyncDone, if done
	*'''vlc.playlist.next()''': iterate to the next playlist item		*'''vlc.playlist.next()''': iterate to the next playlist item
	*'''vlc.playlist.prev()''': iterate to the previous playlist item		*'''vlc.playlist.prev()''': iterate to the previous playlist item

Da2424: /* Video object */ Add vlc.video.scale

2020-04-24T19:58:36Z

Video object: Add vlc.video.scale

← Older revision		Revision as of 19:58, 24 April 2020
Line 518:		Line 518:
	*'''vlc.video.fullscreen''': when set to true the video will be displayed in fullscreen mode, when set to false the video will be shown inside the video output size. The property takes a boolean as input.		*'''vlc.video.fullscreen''': when set to true the video will be displayed in fullscreen mode, when set to false the video will be shown inside the video output size. The property takes a boolean as input.
	*'''vlc.video.aspectRatio''': get and set the aspect ratio to use in the video screen. The property takes a string as input value. Typical values are: "1:1", "4:3", "16:9", "16:10", "221:100" and "5:4"		*'''vlc.video.aspectRatio''': get and set the aspect ratio to use in the video screen. The property takes a string as input value. Typical values are: "1:1", "4:3", "16:9", "16:10", "221:100" and "5:4"
			*'''vlc.video.scale''': (supported in vlc version ≥ 3.0.0) get and set the video scaling factor as float. That is the ratio of the number of pixels on screen to the number of pixels in the original decoded video in each dimension. Zero is a special value; it will adjust the video to the output window.
	*'''vlc.video.subtitle''': (supported in vlc version > 0.8.6a) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled.		*'''vlc.video.subtitle''': (supported in vlc version > 0.8.6a) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled.
	*'''vlc.video.crop''': get and set the geometry of the zone to crop. This is set as <width> x <height> + <left offset> + <top offset>. A possible value is: "120x120+10+10"		*'''vlc.video.crop''': get and set the geometry of the zone to crop. This is set as <width> x <height> + <left offset> + <top offset>. A possible value is: "120x120+10+10"