Package uk.co.caprica.vlcj.factory

Class ApplicationApi

java.lang.Object

uk.co.caprica.vlcj.factory.ApplicationApi

public final class ApplicationApi
extends Object

Behaviour pertaining to the application itself.

Includes features such as the native library version and build information, the application, user agent, id and icon, native log, native clock, codec information, and lists of the available native audio and video modules.

Method Summary

Modifier and Type	Method	Description
List<ModuleDescription>	audioFilters()	Get the available audio filters.
String	changeset()	Get the source code change-set id used to build libvlc.
long	clock()	Get the time as defined by LibVLC.
String	codecDescription(TrackType type, int codec)	Get a description for a particular codec value.
String	compiler()	Get the compiler used to build libvlc.
NativeLog	newLog()	Create a new native log component.
void	setApplicationId(String id, String version, String icon)	Set the application identification information.
void	setUserAgent(String userAgent)	Set the application name.
void	setUserAgent(String userAgent, String httpUserAgent)	Set the application name.
String	version()	Get the libvlc version.
List<ModuleDescription>	videoFilters()	Get the available video filters.

Methods inherited from class java.lang.Object

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

Method Detail

version

public String version()

Get the libvlc version.

Returns:

native library version

compiler

public String compiler()

Get the compiler used to build libvlc.

Returns:

compiler

changeset

public String changeset()

Get the source code change-set id used to build libvlc.

Returns:

change-set

setUserAgent

public void setUserAgent(String userAgent)

Set the application name.

Parameters:

userAgent - application name

setUserAgent

public void setUserAgent(String userAgent,
                         String httpUserAgent)

Set the application name.

Parameters:

userAgent - application name

httpUserAgent - application name for HTTP

setApplicationId

public void setApplicationId(String id,
                             String version,
                             String icon)

Set the application identification information.

Parameters:

id - application id, e.g. com.somecompany.myapp

version - application version

icon - path to application icon

newLog

public NativeLog newLog()

Create a new native log component.

Returns:

native log component, or null if the native log is not available

clock

public long clock()

Get the time as defined by LibVLC.

The time is not meaningful in the sense of what time it is, rather it is a monotonic clock with an arbitrary starting value.

Returns:

current clock time value, in microseconds

codecDescription

public String codecDescription(TrackType type,
                               int codec)

Get a description for a particular codec value.

Parameters:

type - type of track

codec - codec value (or codec FourCC)

Returns:

codec description

audioFilters

public List<ModuleDescription> audioFilters()

Get the available audio filters.

Returns:

collection of audio filter descriptions

videoFilters

public List<ModuleDescription> videoFilters()

Get the available video filters.

Returns:

collection of video filter descriptions