Sound.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2025 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPPDFAnnotsSound
#define PDFTRON_H_CPPPDFAnnotsSound
 
#include <PDF/Annots/Markup.h>
 
namespace pdftron { 
        namespace PDF {
            namespace Annots {
class Sound : public Markup
{
    public:
    enum Icon
    {
        e_Speaker, 
        e_Mic,     
        e_Unknown  
    };
    
    Sound(SDF::Obj d = 0);

    Sound(const Annot& ann) : Markup(ann.GetSDFObj()) {}

    static Sound Create(SDF::SDFDoc& doc, const Rect& pos, Icon icon = e_Speaker );
    static Sound CreateAnnot(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 );

    static Sound Create(SDF::SDFDoc& doc, const Point& pos, Icon icon = e_Speaker );
    static Sound CreateAnnot(SDF::SDFDoc& doc, const Point& pos, Icon icon = e_Speaker);

    SDF::Obj GetSoundStream() const;

    void SetSoundStream(SDF::Obj icon);
    
    Icon GetIcon() const;

    void SetIcon(Icon type=e_Speaker);

    const char* GetIconName() const;
    
    void SetIcon(const char* type);
 
// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
Sound(TRN_Annot sound);
#endif
// @endcond
 
}; //class Sound
            }; //namespace Annot
        }; //namespace PDF
}; //namespace pdftron
#include <Impl/Page.inl>
 
#endif // PDFTRON_H_CPPPDFAnnotsSound