\doxysection{pygaze.\+\_\+sound.\+pygamesound.\+Py\+Game\+Sound Class Reference}
\hypertarget{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound}{}\label{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound}\index{pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}}
Inheritance diagram for pygaze.\+\_\+sound.\+pygamesound.\+Py\+Game\+Sound\+:\begin{figure}[H]
\begin{center}
\leavevmode
\includegraphics[height=2.000000cm]{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound}
\end{center}
\end{figure}
\doxysubsubsection*{Public Member Functions}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a10faed54cf9299e3b51f156c9a9a467b}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self, osc=settings.\+SOUNDOSCILLATOR, freq=settings.\+SOUNDFREQUENCY, length=settings.\+SOUNDLENGTH, attack=settings.\+SOUNDATTACK, decay=settings.\+SOUNDDECAY, soundfile=None)
\item 
\mbox{\hyperlink{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_ae39ff89fa8382d6c12c9d04ecbcaf40b}{saw}} (self, phase)
\item 
\mbox{\hyperlink{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_aac36ec7c3916e6f5807ea97bd63757a4}{square}} (self, phase)
\item 
\mbox{\hyperlink{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_aba086fb063fcd9fbfd717d44d254fd48}{white\+\_\+noise}} (self, phase)
\item 
\mbox{\hyperlink{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a636de101bf919bef0145f81e24ed3b8e}{pan}} (self, panning)
\item 
\mbox{\hyperlink{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a2d28b36a1ebea57e03143ca2352f0bf3}{play}} (self, repeats=0)
\item 
\mbox{\hyperlink{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a0e987aab64bfb0cc30f8035dce360591}{stop}} (self)
\item 
\mbox{\hyperlink{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a716f4cfa4cbddfaf83215a92259c506b}{set\+\_\+volume}} (self, volume)
\end{DoxyCompactItemize}
\doxysubsection*{Public Member Functions inherited from \mbox{\hyperlink{classpygaze_1_1__sound_1_1basesound_1_1_base_sound}{pygaze.\+\_\+sound.\+basesound.\+Base\+Sound}}}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_a181b340ae3143f472e84021c197ac4c0}{\+\_\+\+\_\+init\+\_\+\+\_\+}} (self)
\end{DoxyCompactItemize}
\doxysubsubsection*{Public Attributes}
\begin{DoxyCompactItemize}
\item 
\mbox{\hyperlink{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_ad34bfed0d045a7ac0eeb40b8a55c8c24}{sound}} = pygame.\+mixer.\+Sound(soundfile)
\end{DoxyCompactItemize}


\doxysubsection{Constructor \& Destructor Documentation}
\Hypertarget{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a10faed54cf9299e3b51f156c9a9a467b}\index{pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}!\_\_init\_\_@{\_\_init\_\_}}
\index{\_\_init\_\_@{\_\_init\_\_}!pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}}
\doxysubsubsection{\texorpdfstring{\_\_init\_\_()}{\_\_init\_\_()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a10faed54cf9299e3b51f156c9a9a467b} 
pygaze.\+\_\+sound.\+pygamesound.\+Py\+Game\+Sound.\+\_\+\+\_\+init\+\_\+\+\_\+ (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{osc}{ = {\ttfamily settings.SOUNDOSCILLATOR}, }\item[{}]{freq}{ = {\ttfamily settings.SOUNDFREQUENCY}, }\item[{}]{length}{ = {\ttfamily settings.SOUNDLENGTH}, }\item[{}]{attack}{ = {\ttfamily settings.SOUNDATTACK}, }\item[{}]{decay}{ = {\ttfamily settings.SOUNDDECAY}, }\item[{}]{soundfile}{ = {\ttfamily None}}\end{DoxyParamCaption})}



\doxysubsection{Member Function Documentation}
\Hypertarget{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a636de101bf919bef0145f81e24ed3b8e}\index{pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}!pan@{pan}}
\index{pan@{pan}!pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}}
\doxysubsubsection{\texorpdfstring{pan()}{pan()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a636de101bf919bef0145f81e24ed3b8e} 
pygaze.\+\_\+sound.\+pygamesound.\+Py\+Game\+Sound.\+pan (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{panning}{}\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 from \mbox{\hyperlink{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_ac1e3007ecd94dae7847123815ae6cace}{pygaze.\+\_\+sound.\+basesound.\+Base\+Sound}}.

\Hypertarget{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a2d28b36a1ebea57e03143ca2352f0bf3}\index{pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}!play@{play}}
\index{play@{play}!pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}}
\doxysubsubsection{\texorpdfstring{play()}{play()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a2d28b36a1ebea57e03143ca2352f0bf3} 
pygaze.\+\_\+sound.\+pygamesound.\+Py\+Game\+Sound.\+play (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{repeats}{ = {\ttfamily 0}}\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 from \mbox{\hyperlink{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_adf39a8f5c31e423781887eaaffa7cd45}{pygaze.\+\_\+sound.\+basesound.\+Base\+Sound}}.

\Hypertarget{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_ae39ff89fa8382d6c12c9d04ecbcaf40b}\index{pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}!saw@{saw}}
\index{saw@{saw}!pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}}
\doxysubsubsection{\texorpdfstring{saw()}{saw()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_ae39ff89fa8382d6c12c9d04ecbcaf40b} 
pygaze.\+\_\+sound.\+pygamesound.\+Py\+Game\+Sound.\+saw (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{phase}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Returns a point in a saw wave (for internal use)
        
        arguments
        
        phase       --  phase of the wave
        
        keyword arguments
        
        None
        
        returns
        
        p       --  point in a saw wave
\end{DoxyVerb}
 \Hypertarget{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a716f4cfa4cbddfaf83215a92259c506b}\index{pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}!set\_volume@{set\_volume}}
\index{set\_volume@{set\_volume}!pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}}
\doxysubsubsection{\texorpdfstring{set\_volume()}{set\_volume()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a716f4cfa4cbddfaf83215a92259c506b} 
pygaze.\+\_\+sound.\+pygamesound.\+Py\+Game\+Sound.\+set\+\_\+volume (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{volume}{}\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 from \mbox{\hyperlink{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_a20581535e2cab46ccce5f51164032094}{pygaze.\+\_\+sound.\+basesound.\+Base\+Sound}}.

\Hypertarget{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_aac36ec7c3916e6f5807ea97bd63757a4}\index{pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}!square@{square}}
\index{square@{square}!pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}}
\doxysubsubsection{\texorpdfstring{square()}{square()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_aac36ec7c3916e6f5807ea97bd63757a4} 
pygaze.\+\_\+sound.\+pygamesound.\+Py\+Game\+Sound.\+square (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{phase}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Returns a point in a square wave (for internal use)
        
        arguments
        
        phase       --  phase of the wave
        
        keyword arguments
        
        None
        
        returns
        p       --  point in a square wave
\end{DoxyVerb}
 \Hypertarget{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a0e987aab64bfb0cc30f8035dce360591}\index{pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}!stop@{stop}}
\index{stop@{stop}!pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}}
\doxysubsubsection{\texorpdfstring{stop()}{stop()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_a0e987aab64bfb0cc30f8035dce360591} 
pygaze.\+\_\+sound.\+pygamesound.\+Py\+Game\+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 from \mbox{\hyperlink{classpygaze_1_1__sound_1_1basesound_1_1_base_sound_abd9b7a31246acfc53747df16afd7d1b5}{pygaze.\+\_\+sound.\+basesound.\+Base\+Sound}}.

\Hypertarget{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_aba086fb063fcd9fbfd717d44d254fd48}\index{pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}!white\_noise@{white\_noise}}
\index{white\_noise@{white\_noise}!pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}}
\doxysubsubsection{\texorpdfstring{white\_noise()}{white\_noise()}}
{\footnotesize\ttfamily \label{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_aba086fb063fcd9fbfd717d44d254fd48} 
pygaze.\+\_\+sound.\+pygamesound.\+Py\+Game\+Sound.\+white\+\_\+noise (\begin{DoxyParamCaption}\item[{}]{self}{, }\item[{}]{phase}{}\end{DoxyParamCaption})}

\begin{DoxyVerb}        Returns a point in random noise (for internal use)
        
        arguments
        
        phase       --  phase of the sound (ignored, but necessary for
                    internal reasons; see __init__)
        
        keyword arguments
        
        None
        
        returns
        
        p       --  random number (i.e. a point in white noise sound)
\end{DoxyVerb}
 

\doxysubsection{Member Data Documentation}
\Hypertarget{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_ad34bfed0d045a7ac0eeb40b8a55c8c24}\index{pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}!sound@{sound}}
\index{sound@{sound}!pygaze.\_sound.pygamesound.PyGameSound@{pygaze.\_sound.pygamesound.PyGameSound}}
\doxysubsubsection{\texorpdfstring{sound}{sound}}
{\footnotesize\ttfamily \label{classpygaze_1_1__sound_1_1pygamesound_1_1_py_game_sound_ad34bfed0d045a7ac0eeb40b8a55c8c24} 
pygaze.\+\_\+sound.\+pygamesound.\+Py\+Game\+Sound.\+sound = pygame.\+mixer.\+Sound(soundfile)}



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