Module uk.co.caprica.vlcj

Package uk.co.caprica.vlcj.media

Class OptionsApi

java.lang.Object

uk.co.caprica.vlcj.media.OptionsApi

public final class OptionsApi
extends Object

Behaviour pertaining to media options.

Generally there is no need to specify option flags, by default the option will be OptionFlag.TRUSTED and OptionFlag.UNIQUE although it is possible to use different flag values if required.

Method Summary

Modifier and Type	Method	Description
boolean	add(String... options)	Add options to the media.
boolean	add(String[] options, OptionFlag... flags)	Add options, with flags, to the media.
boolean	add(String option, OptionFlag... flags)	Add an option to the media.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

add

public boolean add(String... options)

Add options to the media.

Parameters:

options - options to add

Returns:

true if successful; false on error

add

public boolean add(String[] options,
 OptionFlag... flags)

Add options, with flags, to the media.

Parameters:

options - options to add

flags - option flags

Returns:

true if successful; false on error

add

public boolean add(String option,
 OptionFlag... flags)

Add an option to the media.

Parameters:

option - option to add

flags - option flags

Returns:

true if successful; false on error