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.

read/write properties

none

methods

  • vlc.video.subtitleName(int i): give the i-th subtitle name.
  • vlc.video.deinterlaceEnable("my_mode"): enable deinterlacing with my_mode. You can enable it with "blend" or "x" mode.
  • vlc.video.deinterlaceDisable(): disable deinterlacing.
Marquee Object

readonly properties

none


read/write properties

none

methods

  • vlc.video.marquee.enable(): enable marquee filter
  • vlc.video.marquee.disable(): disable marque filter
  • 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 (WHITE=0x000000, BLACK=0xFFFFFF, RED=0xFF0000, GREEN=0x00FF00, BLUE=0x0000FF...)

- marq-position : change the text position (CENTER=0, LEFT=1, RIGHT=2, TOP=4, TOP-LEFT=5, TOP-RIGHT=6, BOTTOM=8, BOTTOM-LEFT=9, BOTTOM_RIGHT=10)

- 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.


Equalizer object

readonly properties

  • vlc.audio.equalizer.enable: enable equalizer.
  • vlc.audio.equalizer.disable: disable equalizer.

read/write properties

  • vlc.audio.equalizer.preset: set an equalizer preset.

methods

  • vlc.audio.equalizer.name(int i): give the i-th preset name.
  • vlc.audio.equalizer.band(int i): if i is an int value from 0 to 9 it gives the i-th band value. If i value is -1 it gives the preamp value, and if i value is -2 it gives the number of band.
  • vlc.audio.equalizer.setBand(int i, double amp): set amp as new value of the i-th band (-1 for the preamp , from 0 to 9 for the 60 Hz to 16 kHz band)