\doxysection{pygaze.\+\_\+sound.\+basesound.\+Base\+Sound Class Reference}
\hypertarget{classpygaze_1_1__sound_1_1basesound_1_1_base_sound}{}\label{classpygaze_1_1__sound_1_1basesound_1_1_base_sound}\index{pygaze.\_sound.basesound.BaseSound@{pygaze.\_sound.basesound.BaseSound}}
Inheritance diagram for pygaze.\+\_\+sound.\+basesound.\+Base\+Sound\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classpygaze_1_1__sound_1_1basesound_1_1_base_sound}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_a181b340ae3143f472e84021c197ac4c0}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_ac1e3007ecd94dae7847123815ae6cace}{pan}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_adf39a8f5c31e423781887eaaffa7cd45}{play}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_abd9b7a31246acfc53747df16afd7d1b5}{stop}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_a20581535e2cab46ccce5f51164032094}{set\+\_\+volume}} (self)
\end{DoxyCompactItemize}


\doxysubsection{Detailed Description}
\begin{DoxyVerb}A Sound class for creating and playing sounds\end{DoxyVerb}
 

\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_a181b340ae3143f472e84021c197ac4c0}\index{pygaze.\_sound.basesound.BaseSound@{pygaze.\_sound.basesound.BaseSound}!\_\_init\_\_@{\_\_init\_\_}}
\index{\_\_init\_\_@{\_\_init\_\_}!pygaze.\_sound.basesound.BaseSound@{pygaze.\_sound.basesound.BaseSound}}
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_a181b340ae3143f472e84021c197ac4c0} 
pygaze.\+\_\+sound.\+basesound.\+Base\+Sound.\+\_\+\+\_\+init\+\_\+\+\_\+ (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Initializes a Sound Instance
        
        arguments

        None
        
        keyword arguments
        
        osc     --  type of oscillator; allowed: 'sine', 'saw', 'square',
                    'whitenoise' (default = SOUNDOSCILLATOR)
        freq        --  sound frequency in Herz, either float or integer
                    (default = SOUNDFREQUENCY)
        length  --  sound length in milliseconds (default = 
                    SOUNDLENGTH)
        attack  --  sound attack ('fade in') in milliseconds (default = 
                    SOUNDATTACK)
        decay       --  sound decay ('fade out') in milliseconds (default =
                    SOUNDDECAY)
        soundfile   --  full path to soundfile with .ogg or .wav extension
                    or None for no file; if a file is specified, all
                    other keyword arguments will be ignored (default =
                    None)
\end{DoxyVerb}
 

\doxysubsection{Member Function Documentation}
\Hypertarget{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_ac1e3007ecd94dae7847123815ae6cace}\index{pygaze.\_sound.basesound.BaseSound@{pygaze.\_sound.basesound.BaseSound}!pan@{pan}}
\index{pan@{pan}!pygaze.\_sound.basesound.BaseSound@{pygaze.\_sound.basesound.BaseSound}}
\doxysubsubsection{\texorpdfstring{pan()}{pan()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_ac1e3007ecd94dae7847123815ae6cace} 
pygaze.\+\_\+sound.\+basesound.\+Base\+Sound.\+pan (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Sets the panning of a sound (the volume of the 'unpanned'
        channel decreases, while the other channel remaines the same)
        
        arguments

        panning --  either a float between -1 and 1, 'left' or 'right':
                    'left': full panning to left (same as -1)
                    < 0:    panning to left
                    0:      no panning
                    > 0:    panning to right
                    'right':    full panning to left (same as 1)
        
        keyword arguments
        
        None
        
        returns
        
        None        -- self.sound is panned
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a636de101bf919bef0145f81e24ed3b8e}{pygaze.\+\_\+sound.\+pygamesound.\+Py\+Game\+Sound}}.

\Hypertarget{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_adf39a8f5c31e423781887eaaffa7cd45}\index{pygaze.\_sound.basesound.BaseSound@{pygaze.\_sound.basesound.BaseSound}!play@{play}}
\index{play@{play}!pygaze.\_sound.basesound.BaseSound@{pygaze.\_sound.basesound.BaseSound}}
\doxysubsubsection{\texorpdfstring{play()}{play()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_adf39a8f5c31e423781887eaaffa7cd45} 
pygaze.\+\_\+sound.\+basesound.\+Base\+Sound.\+play (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Plays specified sound (keyword argument loops specifies how many
        repeats after being played once, -1 is infinite); function does not
        wait for playback end, but returns immediately
        
        arguments

        None
        
        keyword arguments
        
        repeats --  specifies the amount of repeats after being played
                    once (-1 is infinite) (default = 0)
        
        returns
        
        None        --  self.sound is played
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a2d28b36a1ebea57e03143ca2352f0bf3}{pygaze.\+\_\+sound.\+pygamesound.\+Py\+Game\+Sound}}.

\Hypertarget{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_a20581535e2cab46ccce5f51164032094}\index{pygaze.\_sound.basesound.BaseSound@{pygaze.\_sound.basesound.BaseSound}!set\_volume@{set\_volume}}
\index{set\_volume@{set\_volume}!pygaze.\_sound.basesound.BaseSound@{pygaze.\_sound.basesound.BaseSound}}
\doxysubsubsection{\texorpdfstring{set\_volume()}{set\_volume()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_a20581535e2cab46ccce5f51164032094} 
pygaze.\+\_\+sound.\+basesound.\+Base\+Sound.\+set\+\_\+volume (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Set the playback volume (loudness) to specified value
        
        arguments
        
        volume  --  float between 0 and 1
        
        keyword arguments
        
        None
        
        returns
        
        None        --  sets self.sound volume to specified value
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a716f4cfa4cbddfaf83215a92259c506b}{pygaze.\+\_\+sound.\+pygamesound.\+Py\+Game\+Sound}}.

\Hypertarget{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_abd9b7a31246acfc53747df16afd7d1b5}\index{pygaze.\_sound.basesound.BaseSound@{pygaze.\_sound.basesound.BaseSound}!stop@{stop}}
\index{stop@{stop}!pygaze.\_sound.basesound.BaseSound@{pygaze.\_sound.basesound.BaseSound}}
\doxysubsubsection{\texorpdfstring{stop()}{stop()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_abd9b7a31246acfc53747df16afd7d1b5} 
pygaze.\+\_\+sound.\+basesound.\+Base\+Sound.\+stop (\begin{DoxyParamCaption}\item[{}]{self}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Stops sound playback
        
        arguments

        None
        
        keyword arguments
        
        None
        
        returns
        
        None        --  self.sound stops playing
\end{DoxyVerb}
 

Reimplemented in \mbox{\hyperlink{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a0e987aab64bfb0cc30f8035dce360591}{pygaze.\+\_\+sound.\+pygamesound.\+Py\+Game\+Sound}}.



The documentation for this class was generated from the following file\+:\begin{DoxyCompactItemize}
\item 
C\+:/\+Users/lurax/eyetracking\+Tobii/pygaze/\+\_\+sound/\mbox{\hyperlink{basesound_8py}{basesound.\+py}}\end{DoxyCompactItemize}
