pspdfkit/com.pspdfkit.annotations/SoundAnnotation

SoundAnnotation

open class SoundAnnotation : Annotation

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.

Constructors

SoundAnnotation

constructor(@IntRange(from = 0) pageIndex: Int, @NonNull boundingBox: RectF, @NonNull audioSource: EmbeddedAudioSource)

Creates a new sound annotation.

constructor(@IntRange(from = 0) pageIndex: Int, @NonNull boundingBox: RectF)

Creates a new sound annotation.

constructor(@NonNull properties: AnnotationPropertyManager, markDirty: Boolean, @Nullable resourceId: String)

Intended for internal usage only

constructor(@NonNull propertyMap: AnnotationPropertyManager, markDirty: Boolean, @Nullable soundData: EmbeddedAudioSource)

Intended for internal usage only

Types

@Retention(value = RetentionPolicy.SOURCE)

annotation class IconName

Denotes possible constants for sound annotation icons.

Properties

val ICON_NAME_MIC: String = "Mic"

Icon name for the microphone icon of sound annotations.

ICON_NAME_SPEAKER

val ICON_NAME_SPEAKER: String = "Speaker"

Icon name for the speaker icon of sound annotations.

Functions

open fun getAudioData(): Array<Byte>

Returns audio data from the annotation.

getAudioDataAsync

open fun getAudioDataAsync(): Maybe<Array<Byte>>

Returns audio data from the annotation, asynchronously.

getAudioEncoding

open fun getAudioEncoding(): AudioEncoding

Encoding of the audio data.

open fun getChannels(): Int

The number of audio channels.

@SoundAnnotation.IconName

open fun getIconName(): String

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

open fun getSampleRate(): Int

The number of audio samples for each channel per second.

open fun getSampleSize(): Int

The number of bits per sample value per channel.

open fun getType(): AnnotationType

Gets the annotation type of the annotation.

open fun hasAudioData(): Boolean

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

open fun isLocked(): Boolean

Check if the annotation is locked - i.e.

open fun isResizable(): Boolean

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

open fun setAudioSource(@Nullable soundSource: EmbeddedAudioSource)

Replaces the audio data in this annotation.

open fun setIconName(@SoundAnnotation.IconName iconName: String)

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

updateTransformationProperties

open fun updateTransformationProperties(@NonNull newBoundingBox: RectF, @NonNull oldBoundingBox: RectF)

Annotations may override this method to transform their properties (i.e.