User:Cmathe/sandbox

From VideoLAN Wiki
Jump to navigation Jump to search

Video object

readonly properties

  • vlc.video.subtitleCount: returns the number of subtitle available

methods

  • vlc.video.subtitleName(int i): give the i-th subtitle name


Marquee Object

readonly properties

  • vlc.video.marquee.enable: enable marquee filter
  • vlc.video.marquee.disable: disable marque filter

methods

  • vlc.video.marquee.text("my text"): display my text on the screen
  • vlc.video.marquee.option("option", int val): set a marquee option

options available :

- marq-size : val define the new size for the text displayed on the screen. If the text is bigger than the screen then the text is not displayed.

- marq-color : change the text color. val is the new color to use :

0x000000 : white, 0xFFFFFF : black, 0xFF0000 : red, 0x00FF00 : green, 0x0000FF : blue...

- marq-position : change the text position :

0 : center, 1 : left, 2 : right, 4 : top, 5 : top left, 6 : top right, 8 : bottom, 9 : bottom left, 10 : bottom right

- marq-opacity : change the text opacity, val is defined from 0 (completely transparent) to 255 (completely opaque).

- marq-timeout : change the timeout value. val is defined in ms, but 0 value correspond to unlimited.

- marq-refresh : change the marquee refresh time.

- marq-x : change the text horizontal position.

- marq-y : change the text vertical position.

Some problems may happen because of the VLC asynchronous functioning. To avoid it, after enabling marquee, you have to wait a few time before changing an option.

Audio object

readonly properties

  • vlc.audio.trackCount: returns the number of audio track available

methods

  • vlc.audio.trackName(int i): give the i-th audio track name