Aspose::Pdf::Annotations::SoundData Class Referencefinal

Represents a sound data defining the sound to be played when the annotation is activated. More...

Inherits System::Object.

Public Member Functions

ASPOSE_PDF_SHARED_API int32_t get_Rate ()
 Gets the sampling rate, in samples per second. More...
 
ASPOSE_PDF_SHARED_API void set_Rate (int32_t value)
 Sets the sampling rate, in samples per second. More...
 
ASPOSE_PDF_SHARED_API int32_t get_Channels ()
 Gets the number of sound channels. More...
 
ASPOSE_PDF_SHARED_API void set_Channels (int32_t value)
 Sets the number of sound channels. More...
 
ASPOSE_PDF_SHARED_API int32_t get_Bits ()
 Gets the number of bits per sample value per channel. More...
 
ASPOSE_PDF_SHARED_API void set_Bits (int32_t value)
 Sets the number of bits per sample value per channel. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::IO::Streamget_Contents ()
 Gets stream of the sound to be played when the annotation is activated. More...
 
ASPOSE_PDF_SHARED_API SoundEncoding get_Encoding ()
 Gets the encoding format for the sample data. More...
 
ASPOSE_PDF_SHARED_API void set_Encoding (SoundEncoding value)
 Sets the encoding format for the sample data. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDataStream > get_EngineStm () const
 
 SoundData (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDataStream > engineStm)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (SoundData, CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDataStream > engineStm))
 
 SoundData (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > parent, System::String soundFile)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (SoundData, CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > parent, System::String soundFile))
 
 SoundData (System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > parent, System::String soundFile, System::SharedPtr< SoundSampleData > soundSampleData)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (SoundData, CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > parent, System::String soundFile, System::SharedPtr< SoundSampleData > soundSampleData))
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Represents a sound data defining the sound to be played when the annotation is activated.

Constructor & Destructor Documentation

◆ SoundData() [1/3]

Aspose::Pdf::Annotations::SoundData::SoundData ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDataStream >  engineStm)
protected

◆ SoundData() [2/3]

Aspose::Pdf::Annotations::SoundData::SoundData ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >  parent,
System::String  soundFile 
)
protected

Parameters
parent
soundFile

◆ SoundData() [3/3]

Aspose::Pdf::Annotations::SoundData::SoundData ( System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject >  parent,
System::String  soundFile,
System::SharedPtr< SoundSampleData soundSampleData 
)
protected

Parameters
parent
soundFile
soundSampleData

Member Function Documentation

◆ get_Bits()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::SoundData::get_Bits ( )

Gets the number of bits per sample value per channel.

◆ get_Channels()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::SoundData::get_Channels ( )

Gets the number of sound channels.

◆ get_Contents()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::IO::Stream> Aspose::Pdf::Annotations::SoundData::get_Contents ( )

Gets stream of the sound to be played when the annotation is activated.

◆ get_Encoding()

ASPOSE_PDF_SHARED_API SoundEncoding Aspose::Pdf::Annotations::SoundData::get_Encoding ( )

Gets the encoding format for the sample data.

◆ get_EngineStm()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDataStream> Aspose::Pdf::Annotations::SoundData::get_EngineStm ( ) const
protected

◆ get_Rate()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Annotations::SoundData::get_Rate ( )

Gets the sampling rate, in samples per second.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [1/3]

Aspose::Pdf::Annotations::SoundData::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( SoundData  ,
CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDataStream > engineStm)   
)
protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [2/3]

Aspose::Pdf::Annotations::SoundData::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( SoundData  ,
CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > parent, System::String soundFile)   
)
protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [3/3]

Aspose::Pdf::Annotations::SoundData::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( SoundData  ,
CODEPORTING_ARGS(System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfObject > parent, System::String soundFile, System::SharedPtr< SoundSampleData > soundSampleData)   
)
protected

◆ set_Bits()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::SoundData::set_Bits ( int32_t  value)

Sets the number of bits per sample value per channel.

◆ set_Channels()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::SoundData::set_Channels ( int32_t  value)

Sets the number of sound channels.

◆ set_Encoding()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::SoundData::set_Encoding ( SoundEncoding  value)

Sets the encoding format for the sample data.

◆ set_Rate()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Annotations::SoundData::set_Rate ( int32_t  value)

Sets the sampling rate, in samples per second.