All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Sound.h
Go to the documentation of this file.
1 //---------------------------------------------------------------------------------------
2 // Copyright (c) 2001-2021 by PDFTron Systems Inc. All Rights Reserved.
3 // Consult legal.txt regarding legal and license information.
4 //---------------------------------------------------------------------------------------
5 #ifndef PDFTRON_H_CPPPDFAnnotsSound
6 #define PDFTRON_H_CPPPDFAnnotsSound
7 
8 #include <PDF/Annots/Markup.h>
9 
10 namespace pdftron {
11  namespace PDF {
12  namespace Annots {
20 class Sound : public Markup
21 {
22  public:
26  enum Icon
27  {
31  };
32 
39  Sound(SDF::Obj d = 0);
40 
47  Sound(const Annot& ann) : Markup(ann.GetSDFObj()) {}
48 
57  static Sound Create(SDF::SDFDoc& doc, const Rect& pos, Icon icon = e_Speaker );
58 
73  static Sound CreateWithData(SDF::SDFDoc& doc, const Rect& pos, Filters::Filter source_data, int bits_per_sample, int sample_freq, int num_channels, Icon icon = e_Speaker );
74 
83  static Sound Create(SDF::SDFDoc& doc, const Point& pos, Icon icon = e_Speaker );
84 
92  SDF::Obj GetSoundStream() const;
93 
101  void SetSoundStream(SDF::Obj icon);
102 
112  Icon GetIcon() const;
113 
124  void SetIcon(Icon type=e_Speaker);
125 
140  const char* GetIconName() const;
141 
157  void SetIcon(const char* type);
158 
159 // @cond PRIVATE_DOC
160 #ifndef SWIGHIDDEN
161 Sound(TRN_Annot sound);
162 #endif
163 // @endcond
164 
165 }; //class Sound
166  }; //namespace Annot
167  }; //namespace PDF
168 }; //namespace pdftron
169 #include <Impl/Page.inl>
170 
171 #endif // PDFTRON_H_CPPPDFAnnotsSound
SDF::Obj GetSDFObj() const
Sound(const Annot &ann)
Definition: Sound.h:47
const char * GetIconName() const
Invalid or non-standard.
Definition: Sound.h:30
SDF::Obj GetSoundStream() const
static Sound Create(SDF::SDFDoc &doc, const Rect &pos, Icon icon=e_Speaker)
static Sound CreateWithData(SDF::SDFDoc &doc, const Rect &pos, Filters::Filter source_data, int bits_per_sample, int sample_freq, int num_channels, Icon icon=e_Speaker)
void SetSoundStream(SDF::Obj icon)
void SetIcon(Icon type=e_Speaker)