![]() |
#include <Sound.h>
Public Types | |
enum | Icon { e_Speaker, e_Mic, e_Unknown } |
The Icon of the Sound annotation. More... | |
Public Member Functions | |
Sound (SDF::Obj d=0) | |
Creates a Sound annotation and initializes it using given Cos/SDF object. | |
Sound (const Annot &ann) | |
Creates a Sound annotation and initializes it using given annotation object. | |
SDF::Obj | GetSoundStream () const |
Returns the sound object of the Sound annotation. | |
void | SetSoundStream (SDF::Obj sound_stream) |
Sets the sound object of the Sound annotation. | |
Icon | GetIcon () const |
Returns the Icon of the Sound annotation. | |
void | SetIcon (Icon type=e_Speaker) |
Sets the Icon of the Sound annotation. | |
const char * | GetIconName () const |
Returns the Icon name of the Sound annotation. | |
void | SetIcon (const char *type) |
Sets the Icon name of the Sound annotation. | |
Static Public Member Functions | |
static Sound | Create (SDF::SDFDoc &doc, const Rect &pos, Icon icon=e_Speaker) |
Creates a new Sound annotation in the specified document. | |
static Sound | Create (SDF::SDFDoc &doc, const Point &pos, Icon icon=e_Speaker) |
Creates a new Sound annotation in the specified 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.
The Icon of the Sound annotation.
pdftron::PDF::Annots::Sound::Sound | ( | SDF::Obj | d = 0 |
) |
Creates a Sound annotation and initializes it using given Cos/SDF object.
pdftron::PDF::Annots::Sound::Sound | ( | const Annot & | ann | ) | [inline] |
Creates a Sound annotation and initializes it using given annotation object.
static Sound pdftron::PDF::Annots::Sound::Create | ( | SDF::SDFDoc & | doc, | |
const Rect & | pos, | |||
Icon | icon = e_Speaker | |||
) | [static] |
static Sound pdftron::PDF::Annots::Sound::Create | ( | SDF::SDFDoc & | doc, | |
const Point & | pos, | |||
Icon | icon = e_Speaker | |||
) | [static] |
SDF::Obj pdftron::PDF::Annots::Sound::GetSoundStream | ( | ) | const |
void pdftron::PDF::Annots::Sound::SetSoundStream | ( | SDF::Obj | sound_stream | ) |
Icon pdftron::PDF::Annots::Sound::GetIcon | ( | ) | const |
void pdftron::PDF::Annots::Sound::SetIcon | ( | Icon | type = e_Speaker |
) |
const char* pdftron::PDF::Annots::Sound::GetIconName | ( | ) | const |
Returns the Icon name of the Sound annotation.
void pdftron::PDF::Annots::Sound::SetIcon | ( | const char * | type | ) |
Sets the Icon name of the Sound annotation.
(Optional)
type | A string denoting the Icon name of the Sound annotation. |