Module uk.co.caprica.vlcj
Package uk.co.caprica.vlcj.player.base

Class MarqueeApi

java.lang.Object
uk.co.caprica.vlcj.player.base.MarqueeApi
public final class MarqueeApi extends Object
Behaviour pertaining to the marquee.

  • Method Details

    • enable

      public void enable(boolean enable)
      Enable/disable the marquee.

      The marquee will not be enabled if there is currently no video being played.

      Parameters:
      enable - true to show the marquee, false to hide it

    • setText

      public void setText(String text)
      Set the marquee text.

      Format variables are available, some examples: 

       Time related:
  %Y = year
  %d = day
  %H = hour
  %M = minute
  %S = second
      See http://wiki.videolan.org/index.php?title=Documentation:Modules/marq.

      You can use any format specifiers used by the strftime C function ("man strftime" for more information).

      If you want to use new-lines in the marquee text make sure you use the "\r\n" escape sequence - "\n" on its own will not work.

      Parameters:
      text - text

    • setColour

      public void setColour(Color colour)
      Set the marquee colour.
      Parameters:
      colour - colour, any alpha component will be masked off

    • setColour

      public void setColour(int colour)
      Set the marquee colour.
      Parameters:
      colour - RGB colour value

    • setOpacity

      public void setOpacity(int opacity)
      Set the marquee opacity.
      Parameters:
      opacity - opacity in the range 0 to 100 where 255 is fully opaque

    • setOpacity

      public void setOpacity(float opacity)
      Set the marquee opacity.
      Parameters:
      opacity - opacity percentage in the range 0.0 to 1.0 where 1.0 is fully opaque

    • setSize

      public void setSize(int size)
      Set the marquee size.
      Parameters:
      size - size, height of the marquee text in pixels

    • setTimeout

      public void setTimeout(int timeout)
      Set the marquee timeout.
      Parameters:
      timeout - timeout, in milliseconds

    • setLocation

      public void setLocation(int x, int y)
      Set the marquee location.
      Parameters:
      x - x co-ordinate for the top left of the marquee
      y - y co-ordinate for the top left of the marquee

    • setPosition

      public void setPosition(MarqueePosition position)
      Set the marquee position.
      Parameters:
      position - position

    • setRefresh

      public void setRefresh(int refresh)
      Set the delay before refreshing the marquee text.
      Parameters:
      refresh - refresh delay, milliseconds

    • set

      public void set(Marquee marquee)
      Set a marquee from a builder.
      Parameters:
      marquee - marquee builder