public class

Sound

extends Markup

java.lang.Object
↳	com.pdftron.pdf.Annot
	↳	com.pdftron.pdf.annots.Markup
		↳	com.pdftron.pdf.annots.Sound

Class Overview

A sound annotation (PDF 1.2) shall analogous to a text annotation except that instead of a text note, it contains sound recorded from the computer's microphone or imported from a file. When the annotation is activated, the sound shall be played. The annotation shall behave like a text annotation in most ways, with a different icon (by default, a speaker) to indicate that it represents a sound.

Summary

Constants
int	e_Mic	The Constant e_Mic.
int	e_Speaker	This integer list represents sub type of the Sound annotation.
int	e_Unknown	The Constant e_Unknown.

[Expand]

Inherited Constants

From class com.pdftron.pdf.annots.Markup

From class com.pdftron.pdf.Annot

int	e_3D	The Constant e_3D.
int	e_Caret	The Constant e_Caret.
int	e_Circle	The Constant e_Circle.
int	e_FileAttachment	The Constant e_FileAttachment.
int	e_FreeText	The Constant e_FreeText.
int	e_Highlight	The Constant e_Highlight.
int	e_Ink	The Constant e_Ink.
int	e_Line	The Constant e_Line.
int	e_Link	The Constant e_Link.
int	e_Movie	The Constant e_Movie.
int	e_Polygon	The Constant e_Polygon.
int	e_Polyline	The Constant e_Polyline.
int	e_Popup	The Constant e_Popup.
int	e_PrinterMark	The Constant e_PrinterMark.
int	e_Projection	The Constant e_Projection.
int	e_Redact	The Constant e_Redact.
int	e_RichMedia	The Constant e_RichMedia.
int	e_Screen	The Constant e_Screen.
int	e_Sound	The Constant e_Sound.
int	e_Square	The Constant e_Square.
int	e_Squiggly	The Constant e_Squiggly.
int	e_Stamp	The Constant e_Stamp.
int	e_StrikeOut	The Constant e_StrikeOut.
int	e_Text	PDF supports the standard annotation types listed in the following enumeration (plug-in extensions may add new annotation types):.
int	e_TrapNet	The Constant e_TrapNet.
int	e_Underline	The Constant e_Underline.
int	e_Unknown	The Constant e_Unknown.
int	e_Watermark	The Constant e_Watermark.
int	e_Widget	The Constant e_Widget.
int	e_action_trigger_activate	Triggered when the annotation is activated.
int	e_action_trigger_annot_blur	Triggered when the annotation loses the input focus
int	e_action_trigger_annot_down	Triggered when the mouse button is pressed inside the annotation's active area
int	e_action_trigger_annot_enter	Triggered when the cursor enters the annotation's active area
int	e_action_trigger_annot_exit	Triggered when the cursor exits the annotation's active area
int	e_action_trigger_annot_focus	Triggered when the annotation receives the input focus
int	e_action_trigger_annot_page_close	Triggered when the page containing the annotation is closed
int	e_action_trigger_annot_page_invisible	Triggered when the page containing the annotation is no longer visible in the interactive PDF processor's user interface
int	e_action_trigger_annot_page_open	Triggered when the page containing the annotation is opened
int	e_action_trigger_annot_page_visible	Triggered when the page containing the annotation becomes visible
int	e_action_trigger_annot_up	Triggered when the mouse button is released inside the annotation's active area
int	e_down	The Constant e_down.
int	e_hidden	The Constant e_hidden.
int	e_invisible	Flags specifying various characteristics of the annotation.
int	e_locked	The Constant e_locked.
int	e_locked_contents	The Constant e_locked_contents.
int	e_no_rotate	The Constant e_no_rotate.
int	e_no_view	The Constant e_no_view.
int	e_no_zoom	The Constant e_no_zoom.
int	e_normal	An annotation can define as many as three separate appearances: The normal appearance is used when the annotation is not interacting with the user.
int	e_print	The Constant e_print.
int	e_read_only	The Constant e_read_only.
int	e_rollover	The Constant e_rollover.
int	e_toggle_no_view	The Constant e_toggle_no_view.

Public Constructors
	Sound(Obj d) Creates a Sound annotation and initialize it using given Cos/SDF object.
	Sound() Creates an empty Sound annoitation.
	Sound(Annot annot) Creates a Sound annotation and initialize it using given annotation object.

Public Methods
static Sound	create(Doc doc, Rect pos) Creates a new Sound annotation, in the specified document.
static Sound	createWithData(Doc doc, Rect pos, Filter source_data, int bits_per_sample, int sample_freq, int num_channels) Creates a new Sound annotation in the specified document.
int	getIcon() Get the sub type of the Sound annotation.
String	getIconName() Get the sub type of the Sound annotation.
Obj	getSoundStream() Get the initial sound object of the Sound annotation.
void	setIcon(int type) Set the sub type of the Sound annotation.
void	setIcon(String type) Set the sub type of the Sound annotation.
void	setSoundStream(Obj sound_stream) Set the initial sound object of the Sound annotation.

[Expand]

Inherited Methods

From class com.pdftron.pdf.annots.Markup

int	getBorderEffect() Gets the Border Effect of the Markup Annotation.
double	getBorderEffectIntensity() Gets the Border Effect Intensity of the Markup Annotation.
Rect	getContentRect() Gets the inner bounding rectangle of the Square.
Date	getCreationDates() Gets the creation date of the Markup Annotation.
ColorPt	getInteriorColor() Gets the interior color of the Square.
int	getInteriorColorCompNum() Gets the number indicating interior color space of the Square.
double	getOpacity() Gets the contant opacity value corresponding to the annotation.
Rect	getPadding() Gets the rectangle difference of the Square.
Popup	getPopup() Gets the Popup object associated with this Markup annotation.
String	getSubject() Gets subject of the Markup Annotation.
String	getTitle() Gets the title of the Markup Annotation.
void	rotateAppearance(double angle) Rotates the appearance of the Markup Annotation.
void	setBorderEffect(int effect) Sets the Border Effect of the Markup Annotation.
void	setBorderEffectIntensity(double intensity) Sets the Border Effect Intensity of the Markup Annotation.
void	setContentRect(Rect cr) Sets the inner bounding rectangle of the Square.
void	setCreationDates(Date date) Sets the creation date of the Markup Annotation.
void	setInteriorColor(ColorPt cpt, int comp_num) Sets the interior color of the Square.
void	setOpacity(double opacity) Sets the contant opacity value corresponding to the annotation.
void	setPadding(double padding) Sets the rectangle difference of the Square.
void	setPadding(Rect rd) Sets the rectangle difference of the Square.
void	setPopup(Popup popup) Sets the Popup object associated with this Markup annotation.
void	setSubject(String title) Sets subject of the Markup Annotation.
void	setTitle(String title) Sets the title of the Markup Annotation.

From class com.pdftron.pdf.Annot

int	GetStructParent() Get the struct parent of an annotation.
static Annot	__Create(long impl, Object ref)
long	__GetHandle()
Object	__GetRefHandle()
static Annot	create(Doc doc, int type, Rect pos) Creates a new annotation of a given type, in the specified document.
void	deleteCustomData(String key) Deletes custom data associated with the given key.
boolean	equals(Object d) Compares two annotations for equality.
void	flatten(Page page) Flatten/Merge the existing annotation appearances with the page content and delete this annotation from a given page.
String	getActiveAppearanceState() Get the annotation's active appearance state.
Obj	getAppearance(int annot_state, String app_state) Get the annotation's appearance for the given combination of annotation and appearance states.
Obj	getAppearance() Get the annotation's appearance for the given combination of annotation and appearance states.
Obj	getAppearance(int annot_state) Get the annotation's appearance for the given combination of annotation and appearance states.
Annot.BorderStyle	getBorderStyle() Get the border style for the annotation.
ColorPt	getColorAsCMYK() Get an annotation's color.
ColorPt	getColorAsGray() Get an annotation's color.
ColorPt	getColorAsRGB() Get an annotation's color.
int	getColorCompNum() Get the color space the annotation's color is represented in.
String	getContents() Get the annotation contents.
String	getCustomData(String key) Returns custom data associated with the given key.
Date	getDate() Gets an annotation's last modified date.
boolean	getFlag(int flag) Determine if the give flag is marked flagged
Obj	getOptionalContent() Get optional content of an annotation.
Page	getPage() Get the page the annotation is associated with.
Rect	getRect() Get annoation bound rectangle
int	getRotation() Get the rotation value of the annotation.
Obj	getSDFObj() Get the SDFObj.
Obj	getTriggerAction(int trigger) Get the Action associated with the selected Annot Trigger event.
int	getType() Get the annotation type.
Obj	getUniqueID() Get the annotiation unique ID.
Rect	getVisibleContentBox() It is possible during viewing that GetRect does not return the most accurate bounding box of what is actually rendered.
int	hashCode()
boolean	isMarkup() Checks if annoation is markup.
boolean	isValid() Checks if Annot is valid.
void	refreshAppearance() Regenerates the appearance stream for the annotation.
void	refreshAppearance(RefreshOptions opts) A version of RefreshAppearance allowing custom options to make slight tweaks in behaviour.
void	removeAppearance() Removes the annotation's default appearance.
void	removeAppearance(int annot_state, String app_state) Removes the annotation's appearance for the given combination of annotation and appearance states.
void	resize(Rect pos) Resize annotation
void	setActiveAppearanceState(String astate) Set the annotation's active appearance state.
void	setAppearance(Obj app_stream, int annot_state) Set the annotation's appearance for the given combination of annotation and appearance states.
void	setAppearance(Obj app_stream) Set the annotation's appearance for the given combination of annotation and appearance states.
void	setAppearance(Obj app_stream, int annot_state, String app_state) Set the annotation's appearance for the given combination of annotation and appearance states.
void	setBorderStyle(Annot.BorderStyle bs) Set the border style for the annotation.
void	setColor(ColorPt cpt) Set an annotation's color.
void	setColor(ColorPt cpt, int comp_num) Set an annotation's color.
void	setContents(String ct) Set annotation contents.
void	setCustomData(String key, String value) Sets the custom data associated with the specified key.
void	setDate(Date date) Sets an annotation's last modified date.
void	setDateToNow() Sets an annotation's last modified date to the current time.
void	setFlag(int flag, boolean value) Set the value of given Flag.
void	setOptionalContent(Obj oc) Set optional content of an annotation.
void	setPage(Page page) Set the reference to a page the annotation is associated with.
void	setRect(Rect pos) Set the size and location of an annotation on its page.
void	setRotation(int rot) Set the rotation value of the annotation.
void	setStructParent(int keyval) Set the struct parent of an annotation.
void	setUniqueID(String icon_name) Set the unique identifier for this annotation.

From class java.lang.Object

Constants

public static final int e_Mic

The Constant e_Mic.

Constant Value: 1 (0x00000001)

public static final int e_Speaker

This integer list represents sub type of the Sound annotation. e_Speaker - Speaker Sound. e_Mic - Mic Sound. e_Unknow - User defined or Invalid. Default value: e_Speaker.

Constant Value: 0 (0x00000000)

public static final int e_Unknown

The Constant e_Unknown.

Constant Value: 2 (0x00000002)

Public Constructors

public Sound (Obj d)

Creates a Sound annotation and initialize it using given Cos/SDF object.

Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.

Parameters

d	the input Cos/SDF object

public Sound ()

Creates an empty Sound annoitation.

public Sound (Annot annot)

Creates a Sound annotation and initialize it using given annotation object.

Note: The constructor does not copy any data, but is instead the logical equivalent of a type cast.

Parameters

annot	the input annotation object

Throws

PDFNetException

Public Methods

public static Sound create (Doc doc, Rect pos)

Creates a new Sound annotation, in the specified document.

Parameters

doc	A document to which the annotation is added.
pos	A rectangle specifying the annotation's bounds, specified in user space coordinates.

Returns

A newly created blank Sound annotation.

Throws

PDFNetException

public static Sound createWithData (Doc doc, Rect pos, Filter source_data, int bits_per_sample, int sample_freq, int num_channels)

Creates a new Sound annotation in the specified document. Accepts raw audio data, along with a few parameters describing the format of that data

Parameters

doc	A document to which the annotation is added.
pos	A rectangle specifying the annotation's bounds in default user space units.
source_data	The raw sound data for the newly created annot
bits_per_sample	The number of bits per sample in source data
sample_freq	The number of samples per second present in source data
num_channels	The number of audio channels in source_data

Returns

A newly created blank Sound annotation.

Throws

PDFNetException

public int getIcon ()

Get the sub type of the Sound annotation.

Note: The Icon indicates name of an icon that shall be used in displaying the annotation. Conforming readers shall provide predefined icon appearances for at least the standard types e_Speaker and e_Mic. Additional types may be supported as well. However, user defined sub types has to be represented by string, in the enum"Icon", it will just show as "e_Unknow". Default value: e_Speaker. The annotation dictionary's AP entry, if present, shall take precedence over the Name entry; see Table 168 and 12.5.5, "Appearance Streams."

Returns

An entry in the "GetIcon" enum indicating the subtype of the Sound annotation.

Throws

PDFNetException

public String getIconName ()

Get the sub type of the Sound annotation.

Note: The Icon indicates a name of an icon that shall be used in displaying the annotation. Conforming readers shall provide predefined icon appearances for at least the standard types Speaker and Mic. Additional types may be supported as well. Default value: Speaker. The annotation dictionary's AP entry, if present, shall take precedence over the Name entry; see Table 168 and 12.5.5, "Appearance Streams."

Returns

A string indicating the subtype of the Sound annotation.

Throws

PDFNetException

public Obj getSoundStream ()

Get the initial sound object of the Sound annotation.

Note: The sound stream is a sound object defining the sound that shall be played when the annotation is activated.

Returns

An SDF object representing a sound stream.

Throws

PDFNetException

public void setIcon (int type)

Set the sub type of the Sound annotation. (Optional)

Note: The Icon indicates name of an icon that shall be used in displaying the annotation. Conforming readers shall provide predefined icon appearances for at least the standard types e_Speaker and e_Mic. Additional types may be supported as well. However, user defined sub types has to be represented by string. In the enum"Icon", it will just show as "e_Unknow". Default value: e_Speaker. The annotation dictionary's AP entry, if present, shall take precedence over the Name entry; see Table 168 and 12.5.5, "Appearance Streams."

Parameters

type	An entry in the "GetIcon" enum indicating the subtype of the Sound annotation.

Throws

PDFNetException

public void setIcon (String type)

Set the sub type of the Sound annotation. (Optional)

Note: The Icon indicates a name of an icon that shall be used in displaying the annotation. Conforming readers shall provide predefined icon appearances for at least the standard types Speaker and Mic. Additional types may be supported as well. Default value: Speaker. The annotation dictionary's AP entry, if present, shall take precedence over the Name entry; see Table 168 and 12.5.5, "Appearance Streams."

Parameters

type	- A string indicating the subtype of the Sound annotation.

Throws

PDFNetException

public void setSoundStream (Obj sound_stream)

Set the initial sound object of the Sound annotation.

Note: The sound stream is a sound object defining the sound that shall be played when the annotation is activated.

Parameters

sound_stream	- An SDF object representing a sound stream.

Throws

PDFNetException

Classes

Enums

Sound

Class Overview

Summary

Constants

public static final int e_Mic

public static final int e_Speaker

public static final int e_Unknown

Public Constructors

public Sound (Obj d)

Parameters

public Sound ()

public Sound (Annot annot)

Parameters

Throws

Public Methods

public static Sound create (Doc doc, Rect pos)

Parameters

Returns

Throws

public static Sound createWithData (Doc doc, Rect pos, Filter source_data, int bits_per_sample, int sample_freq, int num_channels)

Parameters

Returns

Throws

public int getIcon ()

Returns

Throws

public String getIconName ()

Returns

Throws

public Obj getSoundStream ()

Returns

Throws

public void setIcon (int type)

Parameters

Throws

public void setIcon (String type)

Parameters

Throws

public void setSoundStream (Obj sound_stream)

Parameters

Throws