Package uk.co.caprica.vlcj.factory

Class MediaApi

java.lang.Object

uk.co.caprica.vlcj.factory.MediaApi

public final class MediaApi
extends Object

Behaviour pertaining to creation of various types of media and media lists.

Method Summary

Modifier and Type	Method	Description
Media	newMedia(String mrl, String... options)	Create a new Media for a media resource locator.
Media	newMedia(CallbackMedia callbackMedia, String... options)	Create a new Media for callback media.
Media	newMedia(MediaRef mediaRef, String... options)	Create a new Media for an existing MediaRef.
Media	newMedia(Media media, String... options)	Create a new Media for an existing Media.
MediaList	newMediaList()	Create a new media list.
MediaListRef	newMediaListRef()	Create a new MediaListRef.
MediaRef	newMediaRef(String mrl, String... options)	Create a new MediaRef for a media resource locator.
MediaRef	newMediaRef(CallbackMedia callbackMedia, String... options)	Create a new MediaRef for callback media.
MediaRef	newMediaRef(MediaRef mediaRef, String... options)	Create a new MediaRef for an existing MediaRef.
MediaRef	newMediaRef(Media media, String... options)	Create a new MediaRef for an existing Media.

Methods inherited from class java.lang.Object

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

Method Detail

newMediaRef

public MediaRef newMediaRef(String mrl,
                            String... options)

Create a new MediaRef for a media resource locator.

The returned media reference must be freed by the caller when it has no further use for it.

Parameters:

mrl - media resource locator

options - options to add to the media

Returns:

media reference, or null on error

newMediaRef

public MediaRef newMediaRef(CallbackMedia callbackMedia,
                            String... options)

Create a new MediaRef for callback media.

The returned media reference must be freed by the caller when it has no further use for it.

The calling application must make sure to keep a hard references to the callback component to prevent it from being garbage collected, otherwise a fatal JVM crash may occur.

Parameters:

callbackMedia - callback media component

options - options to add to the media

Returns:

media reference, or null on error

newMediaRef

public MediaRef newMediaRef(Media media,
                            String... options)

Create a new MediaRef for an existing Media.

The returned media reference must be freed by the caller when it has no further use for it.

Alternatively Media.newMediaRef() could be used.

Parameters:

media -

options - options to add to the media

Returns:

media reference, or null on error

newMediaRef

public MediaRef newMediaRef(MediaRef mediaRef,
                            String... options)

Create a new MediaRef for an existing MediaRef.

The returned media reference must be freed by the caller when it has no further use for it.

Alternatively MediaRef.newMediaRef() could be used.

Parameters:

mediaRef -

options - options to add to the media

Returns:

media reference, or null on error

newMedia

public Media newMedia(String mrl,
                      String... options)

Create a new Media for a media resource locator.

The returned media must be freed by the caller when it has no further use for it.

Parameters:

mrl - media resource locator

options - options to add to the media

Returns:

media, or null on error

newMedia

public Media newMedia(CallbackMedia callbackMedia,
                      String... options)

Create a new Media for callback media.

The returned media must be freed by the caller when it has no further use for it.

The calling application must make sure to keep a hard references to the callback component to prevent it from being garbage collected, otherwise a fatal JVM crash may occur.

Parameters:

callbackMedia - callback media component

options - options to add to the media

Returns:

media, or null on error

newMedia

public Media newMedia(MediaRef mediaRef,
                      String... options)

Create a new Media for an existing MediaRef.

Alternatively MediaRef.newMedia() could be used.

The returned media must be freed by the caller when it has no further use for it.

Parameters:

mediaRef - media reference

options - options to add to the media

Returns:

media, or null on error

newMedia

public Media newMedia(Media media,
                      String... options)

Create a new Media for an existing Media.

Alternatively Media.newMedia() could be used.

The returned media must be freed by the caller when it has no further use for it.

Parameters:

media - media

options - options to add to the media

Returns:

media, or null on error

newMediaListRef

public MediaListRef newMediaListRef()

Create a new MediaListRef.

Returns:

media list reference, or null on error

newMediaList

public MediaList newMediaList()

Create a new media list.

Returns:

media list, or null on error