Class PDFNet.SoundAnnot

PDFNet.SoundAnnot

Class Summary
Constructor Attributes	Constructor Name and Description
	PDFNet.SoundAnnot(id) A Sound annotation represents a sound recording attached to a point in the PDF document.

Method Summary
Method Attributes	Method Name and Description
<static>	PDFNet.SoundAnnot.create(doc, pos) Constructor
<static>	PDFNet.SoundAnnot.createAtPoint(doc, pos) [Documentation Not Yet Added]
<static>	PDFNet.SoundAnnot.createFromAnnot(ann) creates a Sound annotation and initializes it using given annotation object.
<static>	PDFNet.SoundAnnot.createFromObj(d) creates a Sound annotation and initializes it using given Cos/SDF object.
	getIcon() Returns the Icon of the Sound annotation.
	getIconName() Returns the Icon name of the Sound annotation.
	getSoundStream() Returns the sound object of the Sound annotation.
	setIcon(type) sets the Icon of the Sound annotation.
	setIconName(type) sets the Icon name of the Sound annotation.
	setSoundStream(icon) sets the sound object of the Sound annotation.

Class Detail

PDFNet.SoundAnnot(id)

A Sound annotation represents a sound recording attached to a point in the PDF document. When closed, this annotation appear as an icon; when open and activated, a sound record from the computer's microphone or imported from a file associated with this annotation is played.The icon of this annotation by default is a speaker.

Parameters:
id

Method Detail

<static> {SoundAnnot} PDFNet.SoundAnnot.create(doc, pos)

Constructor

Parameters:
{SDFDoc} doc: (generated documentation)
{rect} pos: (generated documentation)

Returns:: {SoundAnnot} A promise that resolves to an object of type: "SoundAnnot" (generated documentation)

<static> {SoundAnnot} PDFNet.SoundAnnot.createAtPoint(doc, pos)

[Documentation Not Yet Added]

Parameters:
{SDFDoc} doc: (generated documentation)
{point} pos: (generated documentation)

Returns:: {SoundAnnot} A promise that resolves to an object of type: "SoundAnnot" (generated documentation)

<static> {SoundAnnot} PDFNet.SoundAnnot.createFromAnnot(ann)

creates a Sound annotation and initializes it using given annotation object.

Parameters:
{Annot} ann: Annot object used to initialize the Sound annotation.

Returns:: {SoundAnnot} A promise that resolves to an object of type: "SoundAnnot" (generated documentation)

<static> {SoundAnnot} PDFNet.SoundAnnot.createFromObj(d)

creates a Sound annotation and initializes it using given Cos/SDF object.

Parameters:
{Obj} d: The Cos/SDF object to initialze the annotation with.

Returns:: {SoundAnnot} A promise that resolves to an object of type: "SoundAnnot" (generated documentation)

{number} getIcon()

Returns the Icon of the Sound annotation.

Return value enum:
PDFNet.SoundAnnot.Icon = {
	e_Speaker : 0
	e_Mic : 1
	e_Unknown : 2
}

Returns:: {number} A promise that resolves to a value of the "Icon" enum. Default value: e_Speaker.

{string} getIconName()

Returns the Icon name of the Sound annotation.

Returns:: {string} A promise that resolves to a string denoting the Icon name of the Sound annotation.

{Obj} getSoundStream()

Returns the sound object of the Sound annotation.

Returns:: {Obj} A promise that resolves to an SDF object representing a sound stream.

setIcon(type)

sets the Icon of the Sound annotation. (Optional)

Parameters:
{number} type: A value of the "Icon" enumeration type. Default value: e_Speaker.

setIconName(type)

sets the Icon name of the Sound annotation. (Optional)

Parameters:
{string} type: A string denoting the Icon name of the Sound annotation.

setSoundStream(icon)

sets the sound object of the Sound annotation.

Parameters:
{Obj} icon: An SDF object representing a sound stream.

WebViewer HTML5 API Reference v2.2.1.49322

Classes

Class PDFNet.SoundAnnot