DsPdfJS API v9.1.0

DsPdfJS API / SoundAnnotationProperties

Type Alias: SoundAnnotationProperties

SoundAnnotationProperties = MarkupAnnotationProperties & object

Defines properties of a SoundAnnotation.

Type Declaration

icon?

optional icon: SoundAnnotationIcon

The string specifying the name of an icon used to display the annotation.

The PDF specification provides a predefined set of icons: "Speaker", "Mic" or "Ear".

sound?

optional sound: SoundObject | SoundObjectProperties

The SoundObject or SoundObjectProperties defining the sound to be played when the annotation is activated.

type

type: "sound"