Foxit PDF SDK
foxit.pdf.annots.Sound Class Reference
Inheritance diagram for foxit.pdf.annots.Sound:
foxit.pdf.annots.Markup foxit.pdf.annots.Annot foxit.common.Base

Public Types

enum  SampleEncodingFormat { SampleEncodingFormat.e_SampleEncodingFormatRaw = 0, SampleEncodingFormat.e_SampleEncodingFormatSigned = 1, SampleEncodingFormat.e_SampleEncodingFormatMuLaw = 2, SampleEncodingFormat.e_SampleEncodingFormatALaw = 3 }
 Enumeration for encoding format of sound sample data. More...
 
- Public Types inherited from foxit.pdf.annots.Markup
enum  EndingStyle {
  EndingStyle.e_EndingStyleNone = 0, EndingStyle.e_EndingStyleSquare = 1, EndingStyle.e_EndingStyleCircle = 2, EndingStyle.e_EndingStyleDiamond = 3,
  EndingStyle.e_EndingStyleOpenArrow = 4, EndingStyle.e_EndingStyleClosedArrow = 5, EndingStyle.e_EndingStyleButt = 6, EndingStyle.e_EndingStyleROpenArrow = 7,
  EndingStyle.e_EndingStyleRClosedArrow = 8, EndingStyle.e_EndingStyleSlash = 9
}
 Enumeration for line ending style. More...
 
enum  MeasureType {
  MeasureType.e_MeasureTypeX = 0, MeasureType.e_MeasureTypeY = 1, MeasureType.e_MeasureTypeD = 2, MeasureType.e_MeasureTypeA = 3,
  MeasureType.e_MeasureTypeT = 4, MeasureType.e_MeasureTypeS = 5
}
 Enumeration for annotation's measure type. More...
 
enum  State {
  State.e_StateNone = 0, State.e_StateMarked = 1, State.e_StateUnmarked = 2, State.e_StateAccepted = 3,
  State.e_StateRejected = 4, State.e_StateCancelled = 5, State.e_StateCompleted = 6, State.e_StateDeferred = 7,
  State.e_StateFuture = 8
}
 Enumeration for markup annotation's state. More...
 
enum  StateModel { StateModel.e_StateModelMarked = 1, StateModel.e_StateModelReview = 2 }
 Enumeration for markup annotation's state model. More...
 
- Public Types inherited from foxit.pdf.annots.Annot
enum  AppearanceType { AppearanceType.e_AppearanceTypeNormal = 0, AppearanceType.e_AppearanceTypeRollover = 1, AppearanceType.e_AppearanceTypeDown = 2 }
 Enumeration for the type of annotation's appearance. More...
 
enum  Flags {
  Flags.e_FlagInvisible = 0x0001, Flags.e_FlagHidden = 0x0002, Flags.e_FlagPrint = 0x0004, Flags.e_FlagNoZoom = 0x0008,
  Flags.e_FlagNoRotate = 0x0010, Flags.e_FlagNoView = 0x0020, Flags.e_FlagReadOnly = 0x0040, Flags.e_FlagLocked = 0x0080,
  Flags.e_FlagToggleNoView = 0x0100, Flags.e_FlagLockedContents = 0x0200
}
 Enumeration for PDF annotation flags. More...
 
enum  HighlightingMode {
  HighlightingMode.e_HighlightingNone = 0, HighlightingMode.e_HighlightingInvert = 1, HighlightingMode.e_HighlightingOutline = 2, HighlightingMode.e_HighlightingPush = 3,
  HighlightingMode.e_HighlightingToggle = 4
}
 Enumeration for PDF annotation highlighting mode. More...
 
enum  MKEntry {
  MKEntry.e_MKEntryRotation = 0, MKEntry.e_MKEntryBorderColor = 1, MKEntry.e_MKEntryBackgroundColor = 2, MKEntry.e_MKEntryNormalCaption = 3,
  MKEntry.e_MKEntryRolloverCaption = 4, MKEntry.e_MKEntryDownCaption = 5, MKEntry.e_MKEntryNormalIcon = 6, MKEntry.e_MKEntryRolloverIcon = 7,
  MKEntry.e_MKEntryDownIcon = 8, MKEntry.e_MKEntryIconFit = 9, MKEntry.e_MKEntryIconCaptionRelation = 10
}
 Enumeration for annotation's MK dictionary (an appearance characteristics) entry. More...
 
enum  MKIconCaptionRelation {
  MKIconCaptionRelation.e_MKRelationNoIcon = 0, MKIconCaptionRelation.e_MKRelationNoCaption = 1, MKIconCaptionRelation.e_MKRelationCaptionBelowIcon = 2, MKIconCaptionRelation.e_MKRelationCaptionAboveIcon = 3,
  MKIconCaptionRelation.e_MKRelationCaptionRight = 4, MKIconCaptionRelation.e_MKRelationCaptionLeft = 5, MKIconCaptionRelation.e_MKRelationCaptionOvrlayOnIcon = 6
}
 Enumeration for icon and caption relative position in annotation's MK dictionary. More...
 
enum  Property { Property.e_PropertyModifiedDate = 0, Property.e_PropertyCreationDate = 1, Property.e_PropertyBorderColor = 2, Property.e_PropertyFillColor = 3 }
 Enumeration for some PDF annotation property. More...
 
enum  Type {
  Type.e_UnknownType = 0, Type.e_Note = 1, Type.e_Link = 2, Type.e_FreeText = 3,
  Type.e_Line = 4, Type.e_Square = 5, Type.e_Circle = 6, Type.e_Polygon = 7,
  Type.e_PolyLine = 8, Type.e_Highlight = 9, Type.e_Underline = 10, Type.e_Squiggly = 11,
  Type.e_StrikeOut = 12, Type.e_Stamp = 13, Type.e_Caret = 14, Type.e_Ink = 15,
  Type.e_PSInk = 16, Type.e_FileAttachment = 17, Type.e_Sound = 18, Type.e_Movie = 19,
  Type.e_Widget = 20, Type.e_Screen = 21, Type.e_PrinterMark = 22, Type.e_TrapNet = 23,
  Type.e_Watermark = 24, Type.e_3D = 25, Type.e_Popup = 26, Type.e_Redact = 27,
  Type.e_RichMedia = 28
}
 Enumeration for PDF annotation type. More...
 

Public Member Functions

 Sound ()
 Constructor.
 
 Sound (Annot annot)
 Constructor, with parent class object. More...
 
int GetBits ()
 Get the number of bits per sample value per channel. More...
 
int GetChannelCount ()
 Get the count of sound channels. More...
 
string GetCompressionFormat ()
 Get the name of the sound compression format used on the sample data. More...
 
FileSpec GetFileSpec ()
 Get the file specification object which represents an external sound file. More...
 
Sound.SampleEncodingFormat GetSampleEncodingFormat ()
 Get the encoding format for the sample data. More...
 
float GetSamplingRate ()
 Get the sampling rate, in samples per second. More...
 
PDFStream GetSoundStream ()
 Get the stream of sound data. More...
 
- Public Member Functions inherited from foxit.pdf.annots.Markup
 Markup (Annot annot)
 Constructor, with parent class object. More...
 
 Markup ()
 Constructor.
 
Note AddReply ()
 Add a new reply to the end of reply list. More...
 
void AddRichText (string content, RichTextStyle style)
 Add a new rich text string to the end. More...
 
Note AddStateAnnot (string title, Markup.StateModel model, Markup.State state)
 Add a new state annotation. More...
 
DateTime GetCreationDateTime ()
 Get creation date time. More...
 
MarkupArray GetGroupElements ()
 Get an element (as markup annotation) from the group that current markup annotation belongs to. More...
 
Markup GetGroupHeader ()
 Get the header annotation (as primary annotation) of the group that current markup annotation belongs to. More...
 
string GetIntent ()
 Get intent name. More...
 
float GetOpacity ()
 Get opacity value. More...
 
Popup GetPopup ()
 Get related pop-up annotation. More...
 
Note GetReply (int index)
 Get a reply by index. More...
 
int GetReplyCount ()
 Count all replies. More...
 
string GetRichTextContent (int index)
 Get text string of a rich text string specified by index. More...
 
int GetRichTextCount ()
 Get the count of rich text strings. More...
 
RichTextStyle GetRichTextStyle (int index)
 Get style data of a rich text string specified by index. More...
 
NoteArray GetStateAnnots (Markup.StateModel model)
 Get all state annotations in a specified state model. More...
 
string GetSubject ()
 Get subject string. More...
 
string GetTitle ()
 Get title string. More...
 
void InsertRichText (int index, string content, RichTextStyle style)
 Insert a new rich text string to the place which is specified by index. More...
 
bool IsGrouped ()
 Check whether current markup annotation is in a group or not. More...
 
bool RemoveAllReplies ()
 Remove all the replies. More...
 
bool RemoveAllStateAnnots ()
 Remove all the state annotations. More...
 
bool RemovePopup ()
 Remove related pop-up annotation. More...
 
bool RemoveReply (int index)
 Remove a reply by index. More...
 
void RemoveRichText (int index)
 Remove a rich text string specified by index. More...
 
void SetCreationDateTime (DateTime date_time)
 Set creation date time. More...
 
void SetIntent (string intent)
 Set intent name. More...
 
void SetOpacity (float opacity)
 Set opacity value. More...
 
void SetPopup (Popup popup)
 Set related pop-up annotation. More...
 
void SetRichTextContent (int index, string content)
 Set text string of a rich text string specified by index. More...
 
void SetRichTextStyle (int index, RichTextStyle style)
 Set style data of a rich text string specified by index. More...
 
void SetSubject (string subject)
 Set subject string. More...
 
void SetTitle (string title)
 Set title string. More...
 
bool Ungroup ()
 Ungroup current markup annotation from the group it belongs to. More...
 
- Public Member Functions inherited from foxit.pdf.annots.Annot
 Annot (PDFPage page, PDFDictionary annot_dict)
 Constructor, with PDF page and annotation's PDF dictionary. More...
 
 Annot (Annot annot)
 Constructor, with another annotation object. More...
 
 Annot ()
 Constructor.
 
PDFStream GetAppearanceStream (Annot.AppearanceType type, string appearance_state)
 Get annotation's appearance stream with specified type and state. More...
 
int GetBorderColor ()
 Get border color. More...
 
BorderInfo GetBorderInfo ()
 Get border information. More...
 
string GetContent ()
 Get content. More...
 
RectI GetDeviceRect (Matrix2D matrix)
 Get annotation rectangle in device coordinate system. More...
 
PDFDictionary GetDict ()
 Get annotation's dictionary object. More...
 
Matrix2D GetDisplayMatrix (Matrix2D page_display_matrix)
 Get the display matrix, from PDF coordinate system to targeted device coordinate system. More...
 
int GetFlags ()
 Get annotation flags. More...
 
int GetIndex ()
 Get the index of current annotation in the page which current annotation belongs to. More...
 
DateTime GetModifiedDateTime ()
 Get last modified date time. More...
 
PDFDictionary GetOptionalContent ()
 Get the PDF dictionary of annotation's optional content. More...
 
PDFPage GetPage ()
 Get the related PDF page. More...
 
RectF GetRect ()
 Get rectangle, in PDF coordinate system. More...
 
Annot.Type GetType ()
 Get actual annotation type of current annotation. More...
 
string GetUniqueID ()
 Get unique ID. More...
 
bool HasProperty (Annot.Property property)
 Whether current annotation has the specified annotation's property. More...
 
bool IsEmpty ()
 Check whether current object is empty or not. More...
 
bool IsMarkup ()
 Check if current annotation is a markup annotation. More...
 
bool Move (RectF rect)
 Move current annotation to a new position, specified by a new rectangle in [PDF coordinate system] (foxit.pdf.PDFPage). More...
 
bool Move (RectF rect, bool is_reset_appearance)
 Move current annotation to a new position, specified by a new rectangle in [PDF coordinate system] (foxit.pdf.PDFPage). More...
 
bool RemoveProperty (Annot.Property property)
 Remove a specified annotation's property. More...
 
bool ResetAppearanceStream ()
 Reset appearance stream. More...
 
bool ResetAppearanceStream (bool is_generate_new_appearance_obj)
 Reset appearance stream. More...
 
void SetBorderColor (int color)
 Set border color. More...
 
void SetBorderInfo (BorderInfo border)
 Set border information. More...
 
void SetContent (string content)
 Set content. More...
 
void SetFlags (int flags)
 Set annotation flags. More...
 
void SetModifiedDateTime (DateTime date_time)
 Set last modified date time. More...
 
void SetUniqueID (string unique_id)
 Set unique ID. More...
 

Detailed Description

A sound annotation (PDF 1.2) is 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. Sound annotation is a kind of markup annotation, so class Sound is derived from class Markup . Currently, only support to get the properties or data of a sound annotation. Not support to modify a sound annotation (including reseting appearance) yet.

See also
Markup

Member Enumeration Documentation

◆ SampleEncodingFormat

Enumeration for encoding format of sound sample data.

Values of this enumeration must be used alone.

Enumerator
e_SampleEncodingFormatRaw 

Unspecified or unsigned values in the range 0 to (2^B - 1).

e_SampleEncodingFormatSigned 

Twos-complement values.

e_SampleEncodingFormatMuLaw 

μ-law-encoded samples

e_SampleEncodingFormatALaw 

A-law-encoded samples.

Constructor & Destructor Documentation

◆ Sound()

foxit.pdf.annots.Sound.Sound ( Annot  annot)
inline

Constructor, with parent class object.

Parameters
[in]annotParent class object.

Member Function Documentation

◆ GetBits()

int foxit.pdf.annots.Sound.GetBits ( )
inline

Get the number of bits per sample value per channel.

Returns
The number of bits per sample value per channel.

◆ GetChannelCount()

int foxit.pdf.annots.Sound.GetChannelCount ( )
inline

Get the count of sound channels.

Returns
The count of sound channels.

◆ GetCompressionFormat()

string foxit.pdf.annots.Sound.GetCompressionFormat ( )
inline

Get the name of the sound compression format used on the sample data.

Returns
The name of the sound compression format used on the sample data.

◆ GetFileSpec()

FileSpec foxit.pdf.annots.Sound.GetFileSpec ( )
inline

Get the file specification object which represents an external sound file.

A sound may be defined in an external file (represented by a file specification object). The sound file should be self- describing, containing all information needed to render the sound; no additional information need be present in the PDF file.
In this case, the returned stream object should be ignored.

Returns
A file specification object which represents an external sound file. If the return value of function FileSpec.IsEmpty for the returned file specification object is true, that means no external sound file is used for current sound annotation. In this case, please use function Sound.GetSoundStream to get the sound data.

◆ GetSampleEncodingFormat()

Sound.SampleEncodingFormat foxit.pdf.annots.Sound.GetSampleEncodingFormat ( )
inline

Get the encoding format for the sample data.

Returns
The encoding format for the sample data. Please refer to values starting from foxit.pdf.annots.Sound.SampleEncodingFormat.e_SampleEncodingFormatRaw and this would be one of these values.

◆ GetSamplingRate()

float foxit.pdf.annots.Sound.GetSamplingRate ( )
inline

Get the sampling rate, in samples per second.

Returns
The sampling rate. If there is any error, this function will return -1.

◆ GetSoundStream()

PDFStream foxit.pdf.annots.Sound.GetSoundStream ( )
inline

Get the stream of sound data.

The stream of sound data represents the sound and can be used to be played when the annotation is activated.
Specially, if function Sound.GetFileSpec returns a valid file specification object (whose FileSpec.IsEmpty returns false), please use that file specification object instead of the stream returned by this function.

Returns
The stream of sound data. If there is no "Sound" entry or any error occurs, this function will return null.