uk.co.caprica.vlcj.player

Interface MediaMeta

public interface MediaMeta

Specification for local media meta data.

It is possible that any particular meta data value may be null.

It may be necessary for the media to be parsed before any meta data is available.

When invoking setter methods to change media meta data then that change is not applied to the media file. It is necessary to call save() to commit the changes to the media file.

Media meta data instances should be explicitly cleaned up by using release(), otherwise a native memory leak may occur.

The media may contain meta data over and above that exposed here - this interface provides access to the meta data that vlc can provide.

It is not possible to re-read (or re-parse) the media meta data after it has already been parsed - this means that when invoking a setter method on a media meta instance it is not possible to undo that and restore the old value without obtaining a new media instance.

Not all media types can be parsed (e.g. network streams) - parsing such media may cause fatal errors or application hangs.

The media length is provided if it is available - for some media types the length is not available until some short time after the media has been played.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAlbum() Get the album meta data.
String	getArtist() Get the artist meta data.
BufferedImage	getArtwork() Load the artwork associated with this media.
String	getArtworkUrl() Get the artwork URL meta data.
String	getCopyright() Get the copyright meta data.
String	getDate() Get the date meta data.
String	getDescription() Get the description meta data.
String	getEncodedBy() Get the encoded by meta data.
String	getGenre() Get the genre meta data.
String	getLanguage() Get the language meta data.
long	getLength() Get the media length, if available.
String	getNowPlaying() Get the now playing meta data.
String	getPublisher() Get the publisher meta data.
String	getRating() Get the rating meta data.
String	getSetting() Get the setting meta data.
String	getTitle() Get the title meta data.
String	getTrackId() Get the track id meta data.
String	getTrackNumber() Get the track number meta data.
String	getUrl() Get the URL meta data.
void	parse() Parse the media to load meta data.
void	release() Release the resources associated with this meta data instance.
void	save() Write the meta data to the media.
void	setAlbum(String album) Set the album meta data.
void	setArtist(String artist) Set the artist meta data.
void	setArtworkUrl(String artworkUrl) Set the artwork URL meta data.
void	setCopyright(String copyright) Set the copyright meta data.
void	setDate(String date) Set the date meta data.
void	setDescription(String description) Set the description meta data.
void	setEncodedBy(String encodedBy) Set the encoded by meta data.
void	setGenre(String genre) Set the genre meta data.
void	setLanguage(String language) Set the language meta data.
void	setNowPlaying(String nowPlaying) Set the now playing meta data.
void	setPublisher(String publisher) Set the publisher meta data.
void	setRating(String rating) Set the rating meta data.
void	setSetting(String setting) Set the setting meta data.
void	setTitle(String title) Set the title meta data.
void	setTrackId(String trackId) Set the track id meta data.
void	setTrackNumber(String trackNumber) Set the track number meta data.
void	setUrl(String url) Set the URL meta data.

Method Detail

parse

void parse()

Parse the media to load meta data.

If the media is already parsed this will have no effect. If the media is not already parsed then it will be parsed synchronously.

getTitle

String getTitle()

Get the title meta data.

Returns:

title

setTitle

void setTitle(String title)

Set the title meta data.

Parameters:

title - title

getArtist

String getArtist()

Get the artist meta data.

Returns:

artits

setArtist

void setArtist(String artist)

Set the artist meta data.

Parameters:

artist - artist

getGenre

String getGenre()

Get the genre meta data.

Returns:

genre

setGenre

void setGenre(String genre)

Set the genre meta data.

Parameters:

genre - genre

getCopyright

String getCopyright()

Get the copyright meta data.

Returns:

copyright

setCopyright

void setCopyright(String copyright)

Set the copyright meta data.

Parameters:

copyright - copyright

getAlbum

String getAlbum()

Get the album meta data.

Returns:

album

setAlbum

void setAlbum(String album)

Set the album meta data.

Parameters:

album - album

getTrackNumber

String getTrackNumber()

Get the track number meta data.

Returns:

track number

setTrackNumber

void setTrackNumber(String trackNumber)

Set the track number meta data.

Parameters:

trackNumber - track number

getDescription

String getDescription()

Get the description meta data.

Returns:

description

setDescription

void setDescription(String description)

Set the description meta data.

Parameters:

description - description

getRating

String getRating()

Get the rating meta data.

Returns:

rating

setRating

void setRating(String rating)

Set the rating meta data.

Parameters:

rating - rating

getDate

String getDate()

Get the date meta data.

Returns:

date

setDate

void setDate(String date)

Set the date meta data.

Parameters:

date - date

getSetting

String getSetting()

Get the setting meta data.

Returns:

setting

setSetting

void setSetting(String setting)

Set the setting meta data.

Parameters:

setting - setting

getUrl

String getUrl()

Get the URL meta data.

Returns:

url

setUrl

void setUrl(String url)

Set the URL meta data.

Parameters:

url - url

getLanguage

String getLanguage()

Get the language meta data.

Returns:

language

setLanguage

void setLanguage(String language)

Set the language meta data.

Parameters:

language - language

getNowPlaying

String getNowPlaying()

Get the now playing meta data.

Returns:

now playing

setNowPlaying

void setNowPlaying(String nowPlaying)

Set the now playing meta data.

Parameters:

nowPlaying - now playing

getPublisher

String getPublisher()

Get the publisher meta data.

Returns:

publisher

setPublisher

void setPublisher(String publisher)

Set the publisher meta data.

Parameters:

publisher - publisher

getEncodedBy

String getEncodedBy()

Get the encoded by meta data.

Returns:

encoded by

setEncodedBy

void setEncodedBy(String encodedBy)

Set the encoded by meta data.

Parameters:

encodedBy - encoded by

getArtworkUrl

String getArtworkUrl()

Get the artwork URL meta data.

Invoking this method may trigger an HTTP request to download the artwork.

Returns:

artwork URL

setArtworkUrl

void setArtworkUrl(String artworkUrl)

Set the artwork URL meta data.

Parameters:

artworkUrl -

getTrackId

String getTrackId()

Get the track id meta data.

Returns:

track id

setTrackId

void setTrackId(String trackId)

Set the track id meta data.

Parameters:

trackId - track id

getArtwork

BufferedImage getArtwork()

Load the artwork associated with this media.

Invoking this method may trigger an HTTP request to download the artwork.

Returns:

artwork image, or null if no artwork available

getLength

long getLength()

Get the media length, if available.

Some media must be played before the length becomes available.

Returns:

length (milliseconds)

save

void save()

Write the meta data to the media.

release

void release()

Release the resources associated with this meta data instance.

If release() is not invoked before this instance is discarded, a native memory leak may occur.