Click or drag to resize

Sound Class

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.
Inheritance Hierarchy
SystemObject
  pdftron.PDF.AnnotsSound

Namespace:  pdftron.PDF.Annots
Assembly:  pdftron (in pdftron.dll) Version: 255.255.255.255
Syntax
public sealed class Sound : IClosable, 
	IAnnot, IMarkup

The Sound type exposes the following members.

Constructors
  NameDescription
Public methodSound
Creates a Sound annotation and initialize it using given Cos/SDF object.
Top
Methods
  NameDescription
Public methodClose
Public methodStatic memberCreate
Creates a new Sound annotation, in the specified document.
Public methodStatic memberCreateWithData
Creates a new Sound annotation in the specified document. Accepts raw audio data, along with a few parameters describing the format of that data
Public methodDeleteCustomData
Deletes custom data associated with the given key.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFlatten
Flatten/Merge the existing annotation appearances with the page content and delete this annotation from a given page. Annotation 'flattening' refers to the operation that changes active annotations (such as markup, widgets, 3D models, etc.) into a static area that is part of the PDF document, just like the other text and images in the document.
Public methodGetAnnotType
Gets the type.
Public methodGetAppearance
Gets the annotation’s appearance for the given combination of annotation and appearance states.
Public methodGetAppearance(AnnotAnnotationState)
Gets the annotation’s appearance for the given combination of annotation and appearance states.
Public methodGetAppearance(AnnotAnnotationState, String)
Gets the annotation’s appearance for the given combination of annotation and appearance states.
Public methodGetBorderEffect
Gets the Border Effect of the Markup Annotation.
Public methodGetBorderEffectIntensity
Sets the Border Effect of the Markup Annotation. (Optional; PDF 1.5 )
Public methodGetBorderStyle
Gets the border style for the annotation. Typically used for Link annotations.
Public methodGetColorAsCMYK
Gets an annotation's color.
Public methodGetColorAsGray
Gets an annotation's color.
Public methodGetColorAsRGB
Gets the annotation’s active appearance state.
Public methodGetColorCompNum
Gets the color space the annotation's color is represented in.
Public methodGetContentRect
Gets the inner bounding rectangle of the Square. (Optional; PDF 1.5)
Public methodGetContents
Gets the contents.
Public methodGetCreationDates
Gets the creation date of the Markup Annotation
Public methodGetCustomData
Returns custom data associated with the given key.
Public methodGetDate
Gets an annotation's last modified date.
Public methodGetFlag
Gets the flag.
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetIcon
Gets the sub type of the Sound annotation.
Public methodGetIconName
Gets the sub type of the Sound annotation.
Public methodGetInteriorColor
Sets the interior color of the Square. (Optional; PDF 1.4 )
Public methodGetInteriorColorCompNum
Gets the number indicating interior color space of the Square.
Public methodGetOpacity
Gets the contant opacity value corresponding to the annotation.
Public methodGetOptionalContent
Gets optional content of an annotation.
Public methodGetPadding
Gets the rectangle difference of the Square. (Optional; PDF 1.5)
Public methodGetPage
Gets the page the annotation is associated with.
Public methodGetPopup
Gets the Popup object associated with this Markup annotation.
Public methodGetRect
Gets the rect.
Public methodGetRotation
Gets the rotation value of the annotation.The Rotation specifies the number of degrees by which the annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90.
Public methodGetSDFObj
Gets the SDFObj.
Public methodGetSoundStream
Gets the initial sound object of the Sound annotation.
Public methodGetStructParent
Gets the struct parent of an annotation. (Required if the annotation is a structural content item; PDF 1.3)
Public methodGetSubject
Gets subject of the Markup Annotation.
Public methodGetTitle
Gets the title of the Markup Annotation.
Public methodGetTriggerAction
Get the Action associated with the selected Annot Trigger event
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUniqueID
Gets the unique ID.
Public methodIsMarkup
Checks if is markup.
Public methodIsValid
Checks if is valid.
Public methodRefreshAppearance
Regenerates the appearance stream for the annotation. This method can be used to auto-generate the annotation appearance after creating or modifying the annotation without providing an explicit appearance or setting the "NeedAppearances" flag in the AcroForm dictionary.
Public methodRefreshAppearance(RefreshOptions)
A version of RefreshAppearance allowing custom options to make slight tweaks in behaviour.
Public methodRemoveAppearance
Removes the annotation's appearance
Public methodRemoveAppearance(AnnotAnnotationState)
Removes the annotation's appearance for the given combination of annotation and appearance states.
Public methodRemoveAppearance(AnnotAnnotationState, String)
Removes the annotation's appearance for the given combination of annotation and appearance states.
Public methodResize
Resize.
Public methodSetAppearance(Obj)
Sets the annotation’s appearance for the given combination of annotation and appearance states. (Optional; PDF 1.2)
Public methodSetAppearance(Obj, AnnotAnnotationState)
Removes the annotation's appearance for the given combination of annotation and appearance states.
Public methodSetAppearance(Obj, AnnotAnnotationState, String)
Sets the annotation’s appearance for the given combination of annotation and appearance states. (Optional; PDF 1.2)
Public methodSetBorderEffectIntensity
Sets the Border Effect Intensity of the Markup Annotation. (Optional; valid only if Border effect is Cloudy)
Public methodSetBorderStyle
Sets the border style for the annotation. Typically used for Link annotations.
Public methodSetColor(ColorPt)
Sets an annotation's color. (Optional; PDF 1.1)
Public methodSetColor(ColorPt, Int32)
Sets an annotation's color. (Optional; PDF 1.1)
Public methodSetContentRect
Sets the inner bounding rectangle of the Square. (Optional; PDF 1.5)
Public methodSetContents
Sets the contents.
Public methodSetCreationDates
Sets the creation date of the Markup Annotation. (Optional; PDF 1.5 )
Public methodSetCustomData
Sets the custom data associated with the specified key.
Public methodSetDate
Sets an annotation's last modified date.
Public methodSetDateToNow
Sets an annotation's modification date and time to the current time. This corresponds to the value of the "M" field of annotation dictionary(PDF 1.1)
Public methodSetFlag
Sets the value of given Flag.
Public methodSetIcon(String)
Sets the sub type of the Sound annotation. (Optional)
Public methodSetIcon(SoundIcon)
Sets the sub type of the Sound annotation. (Optional)
Public methodSetInteriorColor
Gets the interior color of the Square.
Public methodSetOpacity
Sets the contant opacity value corresponding to the annotation. (Optional; PDF 1.4 )
Public methodSetOptionalContent
Sets optional content of an annotation. (Optional, PDF1.5).
Public methodSetPadding
Sets the rectangle difference of the Square. (Optional; PDF 1.5)
Public methodSetPage
Sets the reference to a page the annotation is associated with. (Optional PDF 1.3; not used in FDF files)
Public methodSetPopup
Sets the Popup object associated with this Markup annotation. (Optional; PDF 1.3 )
Public methodSetRect
Sets the size and location of an annotation on its page.
Public methodSetRotation
Sets the rotation value of the annotation.The Rotation specifies the number of degrees by which the annotation shall be rotated counterclockwise relative to the page. The value shall be a multiple of 90. (Optional)
Public methodSetSoundStream
Sets the initial sound object of the Sound annotation.
Public methodSetStructParent
Sets the struct parent of an annotation. (Required if the annotation is a structural content item; PDF 1.3)
Public methodSetSubject
Sets subject of the Markup Annotation. (Optional; PDF 1.5 )
Public methodSetTitle
Sets the title of the Markup Annotation. (Optional; PDF 1.1)
Public methodSetUniqueID
Sets the unique identifier for this annotation.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also