com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

com.aspose.pdf

Class SoundAnnotation

  • All Implemented Interfaces:
    com.aspose.ms.System.ICloneable, com.aspose.pdf.engine.ITitledAnnotation


    public final class SoundAnnotation
    extends MarkupAnnotation

    Represents a sound annotation that contains sound recorded from the computer's microphone or imported from a file.

    • Constructor Detail

      • SoundAnnotation

        public SoundAnnotation(Page page,
                       Rectangle rect,
                       String soundFile)

        Creates new Sound annotation on the specified page.

        Parameters:
        page - The document's page where annotation should be created.
        rect - The annotation rectangle, defining the location of the annotation on the page.
        soundFile - A sound file defining the sound to be played when the annotation is activated.
      • SoundAnnotation

        public SoundAnnotation(Page page,
                       Rectangle rect,
                       String soundFile,
                       SoundSampleData soundSampleData)

        Creates new Sound annotation on the specified page.

        Parameters:
        page - The document's page where annotation should be created.
        rect - The annotation rectangle, defining the location of the annotation on the page.
        soundFile - A sound file defining the sound to be played when the annotation is activated.
        soundSampleData - A sound sample data contains extra of sound parameters such as sampling rate, bits per sample and so on.
    • Method Detail

      • getIcon

        public int getIcon()

        Gets an icon to be used in displaying the annotation.

        Returns:
        SoundIcon value
        See Also:
        SoundIcon
      • setIcon

        public void setIcon(int value)

        Sets an icon to be used in displaying the annotation.

        Parameters:
        value - SoundIcon value
        See Also:
        SoundIcon
      • getSoundData

        public SoundData getSoundData()

        Gets a sound object defining the sound to be played when the annotation is activated.

        Returns:
        SoundData value
      • getAnnotationType

        public int getAnnotationType()

        Gets type of annotation.

        Specified by:
        getAnnotationType in class Annotation
        Returns:
        AnnotationType value
        See Also:
        AnnotationType
      • accept

        public void accept(AnnotationSelector visitor)

        Accepts visitor object to process the annotation.

        Specified by:
        accept in class Annotation
        Parameters:
        visitor - Visitor object.