public class

SoundAnnotation

extends Annotation

java.lang.Object
↳	com.pspdfkit.annotations.Annotation
	↳	com.pspdfkit.annotations.SoundAnnotation

Class Overview

Represents an audio file added to a page. Sound annotations can be created from recording audio using the device's microphone or by importing an existing audio file. Sound annotations are stored inside the PDF file itself. On a page, SoundAnnotations are represented by an icon, similar to NoteAnnotations. PSPDFKit will always render sound annotations at a fixed size, centered in the provided boundingBox.

Summary

Nested Classes
@interface	SoundAnnotation.IconName	Denotes possible constants for sound annotation icons.

Constants
String	ICON_NAME_MIC	Icon name for the microphone icon of sound annotations.
String	ICON_NAME_SPEAKER	Icon name for the speaker icon of sound annotations.

[Expand]

Inherited Constants

From class com.pspdfkit.annotations.Annotation

[Expand]

Inherited Fields

From class com.pspdfkit.annotations.Annotation

Public Constructors
	SoundAnnotation(int pageIndex, RectF boundingBox, EmbeddedAudioSource audioSource) Creates a new sound annotation.
	SoundAnnotation(int pageIndex, RectF boundingBox) Creates a new sound annotation.

Public Methods
byte[]	getAudioData() Returns audio data from the annotation.
Maybe<byte[]>	getAudioDataAsync() Returns audio data from the annotation, asynchronously.
AudioEncoding	getAudioEncoding() Encoding of the audio data.
int	getChannels() The number of audio channels.
String	getIconName() Returns the name of the icon that should be displayed for this annotation.
int	getSampleRate() The number of audio samples for each channel per second.
int	getSampleSize() The number of bits per sample value per channel.
AnnotationType	getType() Gets the annotation type of the annotation.
boolean	hasAudioData() Checks if the annotation contains valid audio data in supported encoding.
boolean	isLocked() Check if the annotation is locked - i.e.
boolean	isResizable() Check if the annotation is resizable, or if this is a non-resizable annotation.
void	setAudioSource(EmbeddedAudioSource soundSource) Replaces the audio data in this annotation.
void	setIconName(String iconName) Sets the name of the icon that should be displayed for this annotation.
void	updateTransformationProperties(RectF newBoundingBox, RectF oldBoundingBox) Annotations may override this method to transform their properties (i.e.

[Expand]

Inherited Methods

From class com.pspdfkit.annotations.Annotation

void	attachBinaryInstantJsonAttachment(DataProvider dataProvider, String mimeType) Attaches a binary instant JSON attachment to the annotation.
boolean	equals(Object o)
String	fetchBinaryInstantJsonAttachment(OutputStream outputStream) If this annotation has a binary instant JSON attachment, this will write it into the provided OutputStream.
void	generateAppearanceStream() Regenerates the annotation's appearance stream if necessary.
Completable	generateAppearanceStreamAsync() Regenerates the annotation's appearance stream if necessary.
float	getAlpha() Returns the annotation's alpha.
AppearanceStreamGenerator	getAppearanceStreamGenerator() Returns custom appearance stream generator that overrides appearance stream generation of this annotation.
BlendMode	getBlendMode() Returns currently set blend mode.
int	getBorderColor() Returns the border color of this annotation or `Color#TRANSPARENT` if no color is set.
List<Integer>	getBorderDashArray() Returns currently set dash array or `null` if no pattern is set.
BorderEffect	getBorderEffect() Returns the current border effect on the annotation or `NO_EFFECT` if none is set.
float	getBorderEffectIntensity() Returns the current border effect intensity.
BorderStyle	getBorderStyle() Returns the current border style on the annotation or `NONE` if none is set.
float	getBorderWidth() Returns the border line width / thickness.
RectF	getBoundingBox(RectF rect) Position of this annotation on the page.
RectF	getBoundingBox() Position of this annotation on the page.
int	getColor() Returns a color associated with this annotation or `Color#TRANSPARENT` if no color is set.
String	getContents() Returns text contents of the annotation.
Annotation	getCopy(int pageIndex) Creates a copy of this annotation that isn't attached to the document with the page index set to given index.
Date	getCreatedDate() Returns the creation date of the annotation.
String	getCreator() Returns the name of the creator of this annotation.
JSONObject	getCustomData() Retrieves custom data for the annotation.
int	getFillColor() Returns a fill color associated with this object or `Color#TRANSPARENT` if no color is set.
EnumSet<AnnotationFlags>	getFlags() Annotation flags set.
Annotation	getInReplyTo() Retrieves the annotation this annotation replies to, or `null` it this annotation is not a reply or the license doesn't support replies feature.
Maybe<Annotation>	getInReplyToAsync() Retrieves the annotation this annotation replies to asynchronously.
String	getInstantRecordGroup() Gets instant record group of the annotation, or `null` if this annotation is detached.
MeasurementInfo	getMeasurementInfo() Returns `MeasurementInfo` when the annotation is a measurement annotation (see `isMeasurement()`, `null` if not.
MeasurementLabelValue	getMeasurementLabelValue(MeasurementProperties measurementProperties) Return the measurement label and value for this annotation if it is a measurement.
Size	getMinimumSize() Returns the minimum size of the annotation.
Date	getModifiedDate() Returns the date when this annotation was last modified.
String	getName() Returns the content of Title/Name field of this annotation.
int	getObjectNumber() The object number of this annotation inside the PDF document file.
int	getPageIndex() The page number to which this annotation belongs.
String	getRichText() Returns rich text contents of the annotation.
String	getSubject() Returns the subject of this annotation.
abstract AnnotationType	getType() Gets the annotation type of the annotation.
String	getUuid() A unique in-memory identifier for each annotation.
boolean	hasBinaryInstantJsonAttachment() Checks if this annotation has a binary instant JSON attachment.
boolean	hasFlag(AnnotationFlags flag) Test annotation flag.
boolean	hasLockedContents() Check if the annotation has locked contents - i.e.
int	hashCode()
boolean	isAttached() Tells whether this annotation is attached to a document.
boolean	isLocked() Check if the annotation is locked - i.e.
boolean	isMeasurement() Returns `true` when the annotation is a measurement annotation.
boolean	isModified() Returns whether the annotation is modified or not.
boolean	isReply() Whether the annotations is a reply to another annotation.
boolean	isResizable() Check if the annotation is resizable, or if this is a non-resizable annotation.
boolean	isSignature() Returns `true` when the annotation is a signature annotation.
void	renderToBitmap(Bitmap bitmap) Renders the appearance of this annotation into the passed bitmap.
void	renderToBitmap(Bitmap bitmap, AnnotationRenderConfiguration configuration) Renders the appearance of this annotation into the passed bitmap.
Single<Bitmap>	renderToBitmapAsync(Bitmap bitmap) Asynchronously renders the appearance of this annotation into the passed bitmap.
Single<Bitmap>	renderToBitmapAsync(Bitmap bitmap, AnnotationRenderConfiguration configuration) Asynchronously renders the appearance of this annotation into the passed bitmap.
void	setAlpha(float alpha) Sets the annotations' alpha value.
void	setAppearanceStreamGenerator(AppearanceStreamGenerator appearanceStreamGenerator) Sets custom appearance stream generator that overrides appearance stream generation of this annotation.
void	setBlendMode(BlendMode blendMode) Sets the blend mode used when generating annotation's appearance stream.
void	setBorderColor(int color) Sets the border color for this annotation.
void	setBorderDashArray(List<Integer> dashes) Sets a dash style for the border.
void	setBorderEffect(BorderEffect borderEffect) Sets a border effect for current annotation.
void	setBorderEffectIntensity(float borderEffectIntensity) Sets border effect intensity.
void	setBorderStyle(BorderStyle borderStyle) Sets a border style for current annotation.
void	setBorderWidth(float borderWidth) Sets border line width / thickness.
void	setBoundingBox(RectF newBoundingBox) Sets the position and size of this annotation on the page.
void	setColor(int color) Sets the color for this annotation.
void	setContents(String contents) Sets text contents of the annotation.
void	setCreatedDate(Date createdDate) Sets created date for this annotation.
void	setCreator(String creator) Sets the creator of this annotation.
void	setCustomData(JSONObject customData) Sets custom data to the annotation.
void	setFillColor(int color) Sets the fill color for this annotation.
void	setFlags(EnumSet<AnnotationFlags> flags) Sets annotation flags.
void	setInReplyTo(Annotation annotation) Sets the annotation that this annotation replies to.
void	setModifiedDate(Date modifiedDate) Sets last modified date for this annotation.
void	setName(String name) Sets Title / Name field for this annotation
void	setRichText(String richText) Sets rich text contents of the annotation.
void	setSubject(String subject) Sets the subject of this annotation.
String	toInstantJson() Produces Instant JSON representation of this annotation.
String	toString()
abstract void	updateTransformationProperties(RectF newBoundingBox, RectF oldBoundingBox) Annotations may override this method to transform their properties (i.e.

From class java.lang.Object

Constants

public static final String ICON_NAME_MIC

Icon name for the microphone icon of sound annotations.

Constant Value: "Mic"

public static final String ICON_NAME_SPEAKER

Icon name for the speaker icon of sound annotations.

Constant Value: "Speaker"

Public Constructors

public SoundAnnotation (int pageIndex, RectF boundingBox, EmbeddedAudioSource audioSource)

Creates a new sound annotation.

Parameters

pageIndex	Page to which this annotation will be attached to.
boundingBox	Annotation's bounding box on the page in PDF coordinates.
audioSource	Source of audio data that should be attached to the annotation.

public SoundAnnotation (int pageIndex, RectF boundingBox)

Creates a new sound annotation.

Parameters

pageIndex	Page to which this annotation will be attached to.
boundingBox	Annotation's bounding box on the page in PDF coordinates.

Public Methods

public byte[] getAudioData ()

Returns audio data from the annotation. This could take a while and should be executed on background thread.

Returns

Byte array with raw audio data in getAudioEncoding() encoding and Big-endian byte order. Returns null if audio data could not be read or the annotation is not attached to the document.

public Maybe<byte[]> getAudioDataAsync ()

Returns audio data from the annotation, asynchronously.

Returns

Maybe emitting byte array with raw audio data with getAudioEncoding() encoding and Big-endian byte order. Empty/error events are emitted when audio data could not be read or the annotation is not attached to the document.

public AudioEncoding getAudioEncoding ()

Encoding of the audio data.

Returns

Encoding used for audio data samples.

public int getChannels ()

The number of audio channels.

Returns

Number of channels in the audio data.

public String getIconName ()

Returns the name of the icon that should be displayed for this annotation.

Returns

Icon name, {@value ICON_NAME_SPEAKER} by default.

public int getSampleRate ()

The number of audio samples for each channel per second.

Returns

Sampling rate of the audio data in Hz.

public int getSampleSize ()

The number of bits per sample value per channel. 8 or 16 bits per channel are supported.

Returns

Number of bits per sample value in the audio data.

public AnnotationType getType ()

Gets the annotation type of the annotation.

Returns

The type of the annotation. Makes down casting easier.

public boolean hasAudioData ()

Checks if the annotation contains valid audio data in supported encoding.

Returns

true when sound annotation is attached to the document and contains audio data.

public boolean isLocked ()

Check if the annotation is locked - i.e. annotation can't be deleted or modified (except contents).

Returns

true if the annotation is locked or false if it can be freely modified.

public boolean isResizable ()

Check if the annotation is resizable, or if this is a non-resizable annotation.

Returns

true if the annotation can be resized (e.g. ink annotation) or false if it is a non-resizable one (e.g. note annotation).

public void setAudioSource (EmbeddedAudioSource soundSource)

Replaces the audio data in this annotation.

If the getDescription() is not-null, it will be set as new annotation contents (via setContents(String)). If the description is null, the original contents will be kept.

Parameters

soundSource	Source for the embedded sound data.

public void setIconName (String iconName)

Sets the name of the icon that should be displayed for this annotation.

Parameters

iconName	Icon name to be set.

public void updateTransformationProperties (RectF newBoundingBox, RectF oldBoundingBox)

Annotations may override this method to transform their properties (i.e. points, rects, sizes) whenever the bounding box of the annotation changed.

Parameters

newBoundingBox	New bounding box of the annotation (in PDF points).
oldBoundingBox	Old bounding box of the annotation (in PDF points).

Interfaces

Classes

Annotations

Enums

SoundAnnotation

Class Overview

Summary

Constants

public static final String ICON_NAME_MIC

public static final String ICON_NAME_SPEAKER

Public Constructors

public SoundAnnotation (int pageIndex, RectF boundingBox, EmbeddedAudioSource audioSource)

Parameters

public SoundAnnotation (int pageIndex, RectF boundingBox)

Parameters

Public Methods

public byte[] getAudioData ()

Returns

public Maybe<byte[]> getAudioDataAsync ()

Returns

public AudioEncoding getAudioEncoding ()

Returns

public int getChannels ()

Returns

public String getIconName ()

Returns

public int getSampleRate ()

Returns

public int getSampleSize ()

Returns

public AnnotationType getType ()

Returns

public boolean hasAudioData ()

Returns

public boolean isLocked ()

Returns

public boolean isResizable ()

Returns

public void setAudioSource (EmbeddedAudioSource soundSource)

Parameters

public void setIconName (String iconName)

Parameters

public void updateTransformationProperties (RectF newBoundingBox, RectF oldBoundingBox)

Parameters