org.deepsymmetry.beatlink.data

Class WaveformPreview

java.lang.Object

org.deepsymmetry.beatlink.data.WaveformPreview

public class WaveformPreview
extends Object

Gives a birds-eye view of the audio content of a track, and offers a Swing component for rendering that view as part of a user interface, along with annotations showing the current playback position and cue points, if the appropriate metadata is available.

Author:

James Elliott

Field Summary

Fields

Modifier and Type	Field and Description
DataReference	dataReference The unique identifier that was used to request this waveform preview.
Message	rawMessage The message holding the preview as it was read over the network.

Constructor Summary

Constructors

Constructor and Description
WaveformPreview(DataReference reference, Message message) Constructor when reading from the network or a cache file.

Method Summary

Modifier and Type	Method and Description
JComponent	createViewComponent(TrackMetadata metadata) Create a standard Swing component which can be added to a user interface that will draw this waveform preview, optionally including annotations like the current playback position and minute markers (if you supply TrackMetadata so the total length can be determined), and cue markers (if you also supply a CueList).
ByteBuffer	getData() Get the raw bytes of the waveform preview data
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

dataReference

public final DataReference dataReference

The unique identifier that was used to request this waveform preview.

rawMessage

public final Message rawMessage

The message holding the preview as it was read over the network. This can be used to analyze fields that have not yet been reliably understood, and is also used for storing the cue list in a cache file.

Constructor Detail

WaveformPreview

public WaveformPreview(DataReference reference,
                       Message message)

Constructor when reading from the network or a cache file.

Parameters:

reference - the unique database reference that was used to request this waveform preview

message - the response that contains the preview

Method Detail

getData

public ByteBuffer getData()

Get the raw bytes of the waveform preview data

Returns:

the bytes from which the preview can be drawn, as described in Section 5.8 of the Packet Analysis document.

createViewComponent

public JComponent createViewComponent(TrackMetadata metadata)

Create a standard Swing component which can be added to a user interface that will draw this waveform preview, optionally including annotations like the current playback position and minute markers (if you supply TrackMetadata so the total length can be determined), and cue markers (if you also supply a CueList). The playback position can be

Parameters:

metadata - Information about the track whose waveform we are drawing, so we can translate times into positions

Returns:

the component which will draw the annotated waveform preview

toString

public String toString()

Overrides:

toString in class Object