Package org.opencastproject.waveform.api

Interface WaveformService

All Known Implementing Classes:

WaveformServiceImpl, WaveformServiceRemote

public interface WaveformService

This is an api for a service that will create a waveform image from a track.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JOB_TYPE	Job type

Method Summary

Modifier and Type	Method	Description
Job	createWaveformImage(Track sourceTrack, int pixelPerMinute, int minWidth, int maxWidth, int height, String color)	Takes the given track and returns the job that will create a waveform image.

Field Details

JOB_TYPE

static final String JOB_TYPE

Job type

See Also:

• Constant Field Values

Method Details

createWaveformImage

Job createWaveformImage(Track sourceTrack,
 int pixelPerMinute,
 int minWidth,
 int maxWidth,
 int height,
 String color)
                 throws MediaPackageException,
WaveformServiceException

Takes the given track and returns the job that will create a waveform image.

Parameters:

sourceTrack - the track to create waveform image from

pixelPerMinute - the width of the waveform image in pixels per minute

minWidth - the minimum width of the waveform image

maxWidth - the maximum width of the waveform image

height - the height of the waveform image

color - the color of the waveform image

Returns:

a job that will create a waveform image

Throws:

MediaPackageException - if the serialization of the given track fails

WaveformServiceException - if the job can't be created for any reason