Class PdfSoundAnnotation

java.lang.Object

com.itextpdf.kernel.pdf.PdfObjectWrapper<PdfDictionary>

com.itextpdf.kernel.pdf.annot.PdfAnnotation

com.itextpdf.kernel.pdf.annot.PdfMarkupAnnotation

com.itextpdf.kernel.pdf.annot.PdfSoundAnnotation

public class PdfSoundAnnotation
extends PdfMarkupAnnotation

Nested Class Summary

Nested classes/interfaces inherited from class PdfAnnotation

PdfAnnotation.PdfUnknownAnnotation

Field Summary

Fields inherited from class PdfMarkupAnnotation

inReplyTo, popup

Fields inherited from class PdfAnnotation

Accepted, Canceled, Completed, HIDDEN, HIGHLIGHT_INVERT, HIGHLIGHT_NONE, HIGHLIGHT_OUTLINE, HIGHLIGHT_PUSH, HIGHLIGHT_TOGGLE, INVISIBLE, LOCKED, LOCKED_CONTENTS, Marked, MarkedModel, NO_ROTATE, NO_VIEW, NO_ZOOM, None, page, PRINT, READ_ONLY, Rejected, ReviewModel, STYLE_BEVELED, STYLE_DASHED, STYLE_INSET, STYLE_SOLID, STYLE_UNDERLINE, TOGGLE_NO_VIEW, Unmarked

Constructor Summary

Constructors

Modifier	Constructor	Description
	PdfSoundAnnotation(Rectangle rect, PdfStream sound)	Creates a new Sound annotation.
protected	PdfSoundAnnotation(PdfDictionary pdfObject)	Instantiates a new PdfSoundAnnotation instance based on PdfDictionary instance, that represents existing annotation object in the document.
	PdfSoundAnnotation(PdfDocument document, Rectangle rect, InputStream soundStream, float sampleRate, PdfName encoding, int channels, int sampleSizeInBits)	Creates a sound annotation.

Method Summary

Modifier and Type	Method	Description
private static InputStream	correctWavFile(InputStream is)
PdfName	getIconName()	The name of an icon that is used in displaying the annotation.
PdfStream	getSound()
PdfName	getSubtype()	Gets a PdfName which value is a subtype of this annotation.
PdfSoundAnnotation	setIconName(PdfName name)	The name of an icon that is used in displaying the annotation.

Methods inherited from class PdfMarkupAnnotation

getCreationDate, getExternalData, getInReplyTo, getInReplyToObject, getIntent, getOpacity, getPopup, getPopupObject, getReplyType, getRichText, getSubject, getText, setCreationDate, setExternalData, setInReplyTo, setIntent, setOpacity, setPopup, setReplyType, setRichText, setSubject, setText

Methods inherited from class PdfAnnotation

addAssociatedFile, flush, getAppearanceDictionary, getAppearanceObject, getAppearanceState, getAssociatedFiles, getBlendMode, getBorder, getColorObject, getContents, getDate, getDownAppearanceObject, getFlags, getLang, getName, getNonStrokingOpacity, getNormalAppearanceObject, getPage, getPageObject, getRectangle, getRolloverAppearanceObject, getStrokingOpacity, getStructParentIndex, getTitle, hasFlag, isWrappedObjectMustBeIndirect, makeAnnotation, put, remove, resetFlag, setAppearance, setAppearance, setAppearanceState, setBlendMode, setBorder, setBorder, setColor, setColor, setColor, setContents, setContents, setDate, setDownAppearance, setDownAppearance, setFlag, setFlags, setLang, setLayer, setName, setNonStrokingOpacity, setNormalAppearance, setNormalAppearance, setPage, setRectangle, setRolloverAppearance, setRolloverAppearance, setStrokingOpacity, setStructParentIndex, setTitle

Methods inherited from class PdfObjectWrapper

ensureObjectIsAddedToDocument, ensureUnderlyingObjectHasIndirectReference, getPdfObject, isFlushed, makeIndirect, makeIndirect, markObjectAsIndirect, setForbidRelease, setModified, setPdfObject, unsetForbidRelease

Methods inherited from class Object

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

Constructor Details

PdfSoundAnnotation

public PdfSoundAnnotation(Rectangle rect,
 PdfStream sound)

Creates a new Sound annotation. There is a problem playing *.wav files via internal player in Acrobat. The first byte of the audio stream data should be deleted, then wav file will be played correctly. Otherwise it will be broken. Other supporting file types don't have such problem. Sound annotations are deprecated in PDF 2.0.

Parameters:

rect - the rectangle that specifies annotation position and bounds on page

sound - the PdfStream with sound

PdfSoundAnnotation

protected PdfSoundAnnotation(PdfDictionary pdfObject)

Instantiates a new PdfSoundAnnotation instance based on PdfDictionary instance, that represents existing annotation object in the document.

Parameters:

pdfObject - the PdfDictionary representing annotation object

See Also:

• PdfAnnotation.makeAnnotation(PdfObject)

PdfSoundAnnotation

public PdfSoundAnnotation(PdfDocument document,
 Rectangle rect,
 InputStream soundStream,
 float sampleRate,
 PdfName encoding,
 int channels,
 int sampleSizeInBits)
                   throws IOException

Creates a sound annotation. Sound annotations are deprecated in PDF 2.0.

Parameters:

document - the PdfDocument to which annotation will be added

rect - the rectangle that specifies annotation position and bounds on page

soundStream - the PdfStream with sound

sampleRate - the sampling rate, in samples per second

encoding - the encoding format for the sample data

channels - the number of sound channels

sampleSizeInBits - the number of bits per sample value per channel

Throws:

IOException - in case of corrupted data or source stream problems

Method Details

getSubtype

public PdfName getSubtype()

Description copied from class: PdfAnnotation

Gets a PdfName which value is a subtype of this annotation. See ISO-320001 12.5.6, "Annotation Types" for the reference to the possible types.

Specified by:

getSubtype in class PdfAnnotation

Returns:

subtype of this annotation.

getSound

public PdfStream getSound()

correctWavFile

private static InputStream correctWavFile(InputStream is)
                                   throws IOException

Throws:

IOException

getIconName

public PdfName getIconName()

The name of an icon that is used in displaying the annotation. Possible values are different for different annotation types. See setIconName(PdfName).

Returns:

a PdfName that specifies the icon for displaying annotation, or null if icon name is not specified.

setIconName

public PdfSoundAnnotation setIconName(PdfName name)

The name of an icon that is used in displaying the annotation.

Parameters:

name - a PdfName that specifies the icon for displaying annotation. Possible values are different for different annotation types:

• Speaker
• Mic

Additional names may be supported as well.

Returns:

this PdfSoundAnnotation instance.