Module uk.co.caprica.vlcj

Package uk.co.caprica.vlcj.player.list

Class ListApi

java.lang.Object

uk.co.caprica.vlcj.player.list.ListApi

public final class ListApi
extends Object

Behaviour pertaining to the list of media items.

Method Summary

Modifier and Type	Method	Description
EventApi	events()	Delegated behaviour pertaining to the associated media list events.
boolean	isValid()	Is the media list valid?
MediaApi	media()	Delegated behaviour pertaining to the associated media list items.
MediaList	newMediaList()	Create a new MediaList for the associated media list.
MediaListRef	newMediaListRef()	Create a new MediaListRef for the associated media list.
void	setMediaList(MediaListRef mediaListRef)	Set a new media list.

Methods inherited from class java.lang.Object

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

Method Details

setMediaList

public void setMediaList(MediaListRef mediaListRef)

Set a new media list.

The supplied MediaListRef is not kept by this component and must be released by the caller when the caller no longer has any use for it.

Parameters:

mediaListRef - media list

isValid

public boolean isValid()

Is the media list valid?

This method could be used to check there is a list before using the various behaviours.

Returns:

true if there is a valid list; false if there is not

events

public EventApi events()

Delegated behaviour pertaining to the associated media list events.

Returns:

events behaviour, may be null if there is currently no media list

media

public MediaApi media()

Delegated behaviour pertaining to the associated media list items.

Returns:

item behaviour, may be null if there is currently no media list

newMediaList

public MediaList newMediaList()

Create a new MediaList for the associated media list.

The caller must release the returned MediaList when it has no further use for it.

Returns:

media list reference

newMediaListRef

public MediaListRef newMediaListRef()

Create a new MediaListRef for the associated media list.

The caller must release the returned MediaListRef when it has no further use for it.

Returns:

media list reference