com.qoppa.pdf.annotations

Interface Sound

All Superinterfaces:

Annotation

public interface Sound
extends Annotation

Interface representing a Sound annotation in a PDF document. Sound annotations are displayed using a speaker icon and can be double-clicked to play back the audio content.

Author:

Qoppa Software

Field Summary

Fields inherited from interface com.qoppa.pdf.annotations.Annotation

BORDERSTYLE_BEVELED, BORDERSTYLE_CLOUD, BORDERSTYLE_DASHED, BORDERSTYLE_INSETS, BORDERSTYLE_SOLID, BORDERSTYLE_UNDERLINE, FLAGS_HIDDEN, FLAGS_INVISIBLE, FLAGS_LOCKED, FLAGS_LOCKEDCONTENTS, FLAGS_NOROTATE, FLAGS_NOVIEW, FLAGS_NOZOOM, FLAGS_PRINTABLE, FLAGS_READONLY

Method Summary

Modifier and Type	Method and Description
byte[]	getContent() Return this sound annotation's sound content as a byte array.
Date	getCreationDate() Returns the date and time when the annotation was created.
AudioFormat	getFormat() Return this annotation's audio format.
void	setAudio(AudioInputStream audioStream) Sets the audio content of this Sound annotation.
void	setContent(byte[] content, AudioFormat format) Sets the audio content of this Sound annotation.

Methods inherited from interface com.qoppa.pdf.annotations.Annotation

getActions, getAnnotationComponent, getBorderStyle, getBorderWidth, getCheckmarkStatus, getColor, getComponent, getContents, getCreator, getFlags, getIRTAnnotation, getModifiedDate, getName, getOpacity, getPageIndex, getRectangle, getReviewHistory, getSubject, getSubtype, getTriggerActions, isHidden, isInvisible, isIRTGroup, isLocked, isLockedContents, isNoRotate, isNoView, isNoZoom, isPrintable, isReadOnly, paint, print, revalidate, setActions, setBorderStyle, setBorderWidth, setColor, setComponent, setComponentVisible, setCreator, setFlags, setHidden, setInvisible, setLayer, setLocked, setLockedContents, setModifiedDate, setName, setNoRotate, setNoView, setNoZoom, setOpacity, setPrintable, setReadOnly, setRectangle, setSubject, setTriggerActions, shiftRectangle

Method Detail

setAudio

void setAudio(AudioInputStream audioStream)
       throws IOException

Sets the audio content of this Sound annotation.

Parameters:

audioStream - Stream containing the sound content.

Throws:

IOException

getContent

byte[] getContent()

Return this sound annotation's sound content as a byte array. The format of the content is specified by the AudioFormat object returned by getAudioFormat()

Returns:

A byte array containing the sound content.

getFormat

AudioFormat getFormat()

Return this annotation's audio format.

Returns:

The audio format.

setContent

void setContent(byte[] content,
                AudioFormat format)

Sets the audio content of this Sound annotation.

Parameters:

content - A byte array containing the sound content

format - the audio format

getCreationDate

Date getCreationDate()

Returns the date and time when the annotation was created. Milliseconds are always zero since the PDF date format doesn't support milliseconds.

Returns:

The date and time when the annotation was created.