|
Foxit PDF SDK
|
Public Member Functions | |
| Sound () | |
| Constructor. | |
| Sound (const Annot &annot) | |
| Constructor, with parent class object. More... | |
| ~Sound () | |
| Destructor. | |
| int | GetBits () const |
| Get the number of bits per sample value per channel. More... | |
| int | GetChannelCount () const |
| Get the count of sound channels. More... | |
| String | GetCompressionFormat () const |
| Get the name of the sound compression format used on the sample data. More... | |
| FileSpec | GetFileSpec () const |
| Get the file specification object which represents an external sound file. More... | |
| SampleEncodingFormat | GetSampleEncodingFormat () const |
| Get the encoding format for the sample data. More... | |
| float | GetSamplingRate () const |
| Get the sampling rate, in samples per second. More... | |
| objects::PDFStream * | GetSoundStream () const |
| Get the stream of sound data. More... | |
Public Member Functions inherited from foxit::pdf::annots::Markup | |
| Markup () | |
| Constructor. | |
| Markup (const Annot &annot) | |
| Constructor, with parent class object. More... | |
| ~Markup () | |
| Destructor. | |
| Note | AddReply () |
| Add a new reply to the end of reply list. More... | |
| void | AddRichText (const WString &content, const RichTextStyle &style) |
| Add a new rich text string to the end. More... | |
| Note | AddStateAnnot (const WString &title, StateModel model, State state) |
| Add a new state annotation. More... | |
| float | GetBorderOpacity () const |
| Get the border opacity of the annotation. More... | |
| DateTime | GetCreationDateTime () const |
| Get creation date time. More... | |
| float | GetFillOpacity () const |
| Get the fill opacity of the annotation. 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 () const |
| Get intent name. More... | |
| float | GetOpacity () const |
| Get opacity value. More... | |
| Popup | GetPopup () |
| Get related pop-up annotation. More... | |
| Note | GetReply (int index) const |
| Get a reply by index. More... | |
| int | GetReplyCount () |
| Count all replies. More... | |
| WString | GetRichTextContent (int32 index) |
| Get text string of a rich text string specified by index. More... | |
| int32 | GetRichTextCount () |
| Get the count of rich text strings. More... | |
| RichTextStyle | GetRichTextStyle (int32 index) |
| Get style data of a rich text string specified by index. More... | |
| NoteArray | GetStateAnnots (StateModel model) |
| Get all state annotations in a specified state model. More... | |
| WString | GetSubject () const |
| Get subject string. More... | |
| WString | GetTitle () const |
| Get title string. More... | |
| void | InsertRichText (int32 index, const WString &content, const 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 | SetBorderOpacity (float opacity) |
| Set the border opacity of the annotation. More... | |
| void | SetCreationDateTime (const DateTime &date_time) |
| Set creation date time. More... | |
| void | SetFillOpacity (float opacity) |
| Set the fill opacity of the annotation. More... | |
| void | SetIntent (const String &intent) |
| Set intent name. More... | |
| void | SetOpacity (float opacity) |
| Set opacity value. More... | |
| void | SetPopup (const Popup &popup) |
| Set related pop-up annotation. More... | |
| void | SetRichTextContent (int32 index, const WString &content) |
| Set text string of a rich text string specified by index. More... | |
| void | SetRichTextStyle (int32 index, const RichTextStyle &style) |
| Set style data of a rich text string specified by index. More... | |
| void | SetSubject (const WString &subject) |
| Set subject string. More... | |
| void | SetTitle (const WString &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 () | |
| Constructor. | |
| Annot (const Annot &annot) | |
| Constructor, with another annotation object. More... | |
| Annot (const PDFPage &page, objects::PDFDictionary *annot_dict) | |
| Constructor, with PDF page and annotation's PDF dictionary. More... | |
| virtual | ~Annot () |
| Destructor. | |
| objects::PDFStream * | GetAppearanceStream (AppearanceType type, const char *appearance_state="") const |
| Get annotation's appearance stream with specified type and state. More... | |
| RGB | GetBorderColor () const |
| Get border color. More... | |
| BorderInfo | GetBorderInfo () const |
| Get border information. More... | |
| WString | GetContent () const |
| Get content. More... | |
| RectI | GetDeviceRect (const Matrix &matrix) |
| Get annotation rectangle in device coordinate system. More... | |
| objects::PDFDictionary * | GetDict () const |
| Get annotation's dictionary object. More... | |
| Matrix | GetDisplayMatrix (const Matrix &page_display_matrix) |
| Get the display matrix, from PDF coordinate system to targeted device coordinate system. More... | |
| uint32 | GetFlags () const |
| Get annotation flags. More... | |
| int | GetIndex () const |
| Get the index of current annotation in the page which current annotation belongs to. More... | |
| DateTime | GetModifiedDateTime () const |
| Get last modified date time. More... | |
| objects::PDFDictionary * | GetOptionalContent () const |
| Get the PDF dictionary of annotation's optional content. More... | |
| PDFPage | GetPage () const |
| Get the related PDF page. More... | |
| RectF | GetRect () const |
| Get rectangle, in PDF coordinate system. More... | |
| Type | GetType () const |
| Get actual annotation type of current annotation. More... | |
| WString | GetUniqueID () const |
| Get unique ID. More... | |
| bool | HasProperty (Property property) const |
| Whether current annotation has the specified annotation's property. More... | |
| bool | IsEmpty () const |
| Check whether current object is empty or not. More... | |
| bool | IsMarkup () const |
| Check if current annotation is a markup annotation. More... | |
| bool | Move (const RectF &rect) |
| Move current annotation to a new position, specified by a new rectangle in PDF coordinate system. More... | |
| bool | Move (const RectF &rect, bool is_reset_appearance) |
| Move current annotation to a new position, specified by a new rectangle in PDF coordinate system. More... | |
| bool | operator!= (const Annot &other) const |
| Not equal operator. More... | |
| Annot & | operator= (const Annot &annot) |
| Assign operator. More... | |
| bool | operator== (const Annot &other) const |
| Equal operator. More... | |
| bool | RemoveProperty (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 (RGB color) |
| Set border color. More... | |
| void | SetBorderInfo (const BorderInfo &border) |
| Set border information. More... | |
| void | SetContent (const WString &content) |
| Set content. More... | |
| void | SetFlags (uint32 flags) |
| Set annotation flags. More... | |
| void | SetModifiedDateTime (const DateTime &date_time) |
| Set last modified date time. More... | |
| void | SetUniqueID (const WString &unique_id) |
| Set unique ID. More... | |
Public Member Functions inherited from foxit::Base | |
| FS_HANDLE | Handle () const |
| Get the handle of current object. More... | |
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.
Enumeration for encoding format of sound sample data.
Values of this enumeration must be used alone.
|
explicit |
Constructor, with parent class object.
| [in] | annot | Parent class object. |
| int foxit::pdf::annots::Sound::GetBits | ( | ) | const |
Get the number of bits per sample value per channel.
| int foxit::pdf::annots::Sound::GetChannelCount | ( | ) | const |
Get the count of sound channels.
| String foxit::pdf::annots::Sound::GetCompressionFormat | ( | ) | const |
Get the name of the sound compression format used on the sample data.
| FileSpec foxit::pdf::annots::Sound::GetFileSpec | ( | ) | const |
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.
| SampleEncodingFormat foxit::pdf::annots::Sound::GetSampleEncodingFormat | ( | ) | const |
Get the encoding format for the sample data.
| float foxit::pdf::annots::Sound::GetSamplingRate | ( | ) | const |
Get the sampling rate, in samples per second.
| objects::PDFStream* foxit::pdf::annots::Sound::GetSoundStream | ( | ) | const |
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.