• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • kdegraphics
  • Sitemap
  • Contact Us
 

okular

Okular::Sound

Okular::Sound Class Reference

#include <sound.h>

List of all members.

Detailed Description

Contains information about a sound object.

This class encapsulates the information about a sound object which is used for links on enter/leave page event.

Definition at line 26 of file sound.h.


Public Types

enum  SoundType { External, Embedded }
enum  SoundEncoding { Raw, Signed, muLaw, ALaw }

Public Member Functions

 Sound (const QByteArray &data)
 Sound (const QString &filename)
 ~Sound ()
SoundType soundType () const
QString url () const
QByteArray data () const
void setSamplingRate (double rate)
double samplingRate () const
void setChannels (int channels)
int channels () const
void setBitsPerSample (int rate)
int bitsPerSample () const
void setSoundEncoding (SoundEncoding encoding)
SoundEncoding soundEncoding () const

Member Enumeration Documentation

enum Okular::Sound::SoundType

Describes where the sound is stored.

Enumerator:
External  Is stored at external resource (e.g. url).
Embedded  Is stored embedded in the document.

Definition at line 32 of file sound.h.

enum Okular::Sound::SoundEncoding

Describes the encoding of the sound data.

Enumerator:
Raw  Is not encoded.
Signed  Is encoded with twos-complement values.
muLaw  Is ยต-law encoded.
ALaw  Is A-law encoded.

Definition at line 40 of file sound.h.

Constructor & Destructor Documentation

Sound::Sound ( const QByteArray &  data  )  [explicit]

Creates a new sound object with the given embedded sound data.

Definition at line 49 of file sound.cpp.

Sound::Sound ( const QString &  filename  )  [explicit]

Creates a new sound object with the given external filename.

Definition at line 54 of file sound.cpp.

Sound::~Sound (  ) 

Destroys the sound object.

Definition at line 59 of file sound.cpp.

Member Function Documentation

Sound::SoundType Sound::soundType (  )  const

Returns the type of the sound object.

Definition at line 64 of file sound.cpp.

QString Sound::url (  )  const

Returns the external storage url of the sound data.

Definition at line 69 of file sound.cpp.

QByteArray Sound::data (  )  const

Returns the embedded sound data.

Definition at line 74 of file sound.cpp.

void Sound::setSamplingRate ( double  rate  ) 

Sets the sampling rate.

Definition at line 84 of file sound.cpp.

double Sound::samplingRate (  )  const

Returns the sampling rate.

Definition at line 79 of file sound.cpp.

void Sound::setChannels ( int  channels  ) 

Sets the number of channels.

Definition at line 94 of file sound.cpp.

int Sound::channels (  )  const

Returns the number of channels.

Definition at line 89 of file sound.cpp.

void Sound::setBitsPerSample ( int  rate  ) 

Sets the bits per sample rate.

Definition at line 104 of file sound.cpp.

int Sound::bitsPerSample (  )  const

Returns the bits per sample rate.

Definition at line 99 of file sound.cpp.

void Sound::setSoundEncoding ( Sound::SoundEncoding  soundEncoding  ) 

Sets the type of sound encoding.

Definition at line 114 of file sound.cpp.

Sound::SoundEncoding Sound::soundEncoding (  )  const

Returns the sound encoding.

Definition at line 109 of file sound.cpp.

The documentation for this class was generated from the following files:
  • sound.h
  • sound.cpp

okular

Skip menu "okular"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdegraphics

Skip menu "kdegraphics"
  • okular
Generated for kdegraphics by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal