java.lang.Object
uk.co.caprica.vlcj.player.base.Logo
-
Method Summary
Modifier and TypeMethodDescriptionvoid
apply
(MediaPlayer mediaPlayer) Apply the logo to the media player.disable()
Disable the logo.duration
(int duration) Set the amount of time the logo will be displayed before displaying the next in sequence (if there is one).enable()
Enable the logo.enable
(boolean enable) Apply the initial enabled/disabled state.Apply the logo file.Apply the logo file.Get the duration for the logo.boolean
Get the enabled flag.getFile()
Get the file name.Get the opacity if set as float.getImage()
Get the image.Get the opacity if set as integer.Get the position.getX()
Get the location x co-ordinate.getY()
Get the location y co-ordinate.image
(RenderedImage image) Apply the logo image.location
(int x, int y) Apply the logo position in video co-ordinates.static Logo
logo()
Create a logo.opacity
(float opacity) Apply a logo opacity.opacity
(int opacity) Apply a logo opacity.position
(LogoPosition position) Apply the logo position.repeat
(int repeat) Set the number of times the logo sequence will repeat.toString()
-
Method Details
-
logo
-
duration
Set the amount of time the logo will be displayed before displaying the next in sequence (if there is one).- Parameters:
duration
- duration, milliseconds- Returns:
- this
-
opacity
Apply a logo opacity.- Parameters:
opacity
- opacity, from 0 to 255, where 255 is fully opaque- Returns:
- this
-
opacity
Apply a logo opacity.- Parameters:
opacity
- opacity, from 0.0 to 1.0, where 1.0 is fully opaque- Returns:
- this
-
location
Apply the logo position in video co-ordinates.- Parameters:
x
- x ordinatey
- y ordinate- Returns:
- this
-
position
Apply the logo position.- Parameters:
position
- position enumeration value- Returns:
- this
-
repeat
Set the number of times the logo sequence will repeat.Note that with current versions of VLC you may need to set a repeat count one more than you might expect - this is because on the last loop iteration it appears to stop after only the first logo has been displayed.
- Parameters:
repeat
- number of times to repeat the sequence of logos, or -1 for indefinite, or 0 for no looping.- Returns:
- this
-
file
Apply the logo file.It is possible to simply specify the name of the file, or the extended syntax supported by libvlc - e.g. "file,d,t;file,d,t;...", see
file(String, Integer, Integer)
.- Parameters:
file
- name of the file- Returns:
- this
-
file
-
file
-
file
-
image
Apply the logo image.This is not optimal as the image must first be written to disk in a temporary file.
- Parameters:
image
- logo image- Returns:
- this
-
enable
Apply the initial enabled/disabled state.- Parameters:
enable
-true
to enable the logo;false
to disable it- Returns:
- this
-
enable
-
disable
-
getDuration
-
getIntegerOpacity
-
getFloatOpacity
-
getX
-
getY
-
getPosition
-
getFile
-
getImage
-
getEnable
public boolean getEnable()Get the enabled flag.- Returns:
- enabled/disabled
-
apply
Apply the logo to the media player.All previously applied properties will be set on the media player.
- Parameters:
mediaPlayer
- media player
-
toString
-