Module uk.co.caprica.vlcj

Package uk.co.caprica.vlcj.media

Class ThumbnailApi

java.lang.Object

uk.co.caprica.vlcj.media.ThumbnailApi

public final class ThumbnailApi
extends Object

Behaviour pertaining to media thumbnails.

Method Summary

Modifier and Type	Method	Description
void	cancel(ThumbnailRequest request)	Cancel a thumbnail request.
ThumbnailRequest	requestByPosition(float position, ThumbnailerSeekSpeed speed, int width, int height, PictureType pictureType, long timeout)	Request a thumbnail be created for a particular position within the media.
ThumbnailRequest	requestByTime(long time, ThumbnailerSeekSpeed speed, int width, int height, PictureType pictureType, long timeout)	Request a thumbnail be created for a particular time within the media.

Methods inherited from class java.lang.Object

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

Method Details

requestByTime

public ThumbnailRequest requestByTime(long time,
 ThumbnailerSeekSpeed speed,
 int width,
 int height,
 PictureType pictureType,
 long timeout)

Request a thumbnail be created for a particular time within the media.

Parameters:

time - time from media start, milliseconds

speed - seek speed (fast, or precise)

width - width for the thumbnail

height - height for the thumbnail

pictureType - picture format for the thumbnail

timeout - timeout for thumbnail generation

Returns:

thunbnail request

requestByPosition

public ThumbnailRequest requestByPosition(float position,
 ThumbnailerSeekSpeed speed,
 int width,
 int height,
 PictureType pictureType,
 long timeout)

Request a thumbnail be created for a particular position within the media.

Parameters:

position - position within the media, a percentage (for example, 0.2f is 20%)

speed - seek speed (fast, or precise)

width - width for the thumbnail

height - height for the thumbnail

pictureType - picture format for the thumbnail

timeout - timeout for thumbnail generation

Returns:

thunbnail request

cancel

public void cancel(ThumbnailRequest request)

Cancel a thumbnail request.

Parameters:

request - request to cancel