# HG changeset patch
# User Nicholas Jillings <nicholas.jillings@eecs.qmul.ac.uk>
# Date 1427366129 0
# Node ID 59c7ed077dd39654712d2aa6ec23b4d2ceedd6d3
# Parent  05327691d28c4e837a3d77783f134cd7f573bb19
Updated the ProjectSpecificationDocument to reflect track sample rate detection

diff -r 05327691d28c -r 59c7ed077dd3 docs/ProjectSpecificationDocument.pdf
Binary file docs/ProjectSpecificationDocument.pdf has changed
diff -r 05327691d28c -r 59c7ed077dd3 docs/ProjectSpecificationDocument.tex
--- a/docs/ProjectSpecificationDocument.tex	Wed Mar 25 13:31:54 2015 +0000
+++ b/docs/ProjectSpecificationDocument.tex	Thu Mar 26 10:35:29 2015 +0000
@@ -1,6 +1,7 @@
 \documentclass{article}
 
 \usepackage[margin=2cm]{geometry}
+\usepackage{listings}
 
 \begin{document}
 
@@ -44,6 +45,8 @@
 \subsection{Attributes}
 \begin{itemize}
 \item \texttt{hostURL} - Optional. If all tracks are hosted from the same folder on a server, you can put in the lead here. For instance, if loading http://test.com/tracks/track1.wav and http://test.com/tracks/track2.wav, this could equal http://test.com/tracks/ and the url attribute in the track tag can be track1.wav or track2.wav. Equally http://test.com/ and then using tracks/track1.wav and tracks/track2.wav is valid.
+\item \texttt{sampleRate} - Optional. If your test requires a specific sample rate, this should be set to the desired sample rate in Hertz. This does not set the browser to the correct sample rate, but allows for checking if the sample rates match.
+\item \texttt{sampleRateExplicit} - Optional. A true/false to determine if the sample rate given in the attribute \texttt{sampleRate} must be matched by the system. If the web audio API does not match, a browser alert is called and the rest of the interface loading is discarded. Media files are also not downloaded until this check can be corrected.
 \end{itemize}
 
 \subsection{Elements}
@@ -60,19 +63,29 @@
 
 \section{Example}
 
-Here is an example XML structure. Apologies for LATEX formatting!
+Here is an example XML structure
 
-\texttt{
-<?xml version="1.0" encoding="UTF-8"?> \\
-<BrowserEvalProjectDocument> \\
-<setup interface="APE" projectReturn="http://project.return.url/goes/here" />\\
-    <tracks hostURL="http://apeTest.qmul.ac.uk/tracks/"> \\
-        <track url = "track1.wav"/> \\
-        <track url = "track2.wav"/> \\
-        <track url = "track3.wav"/> \\
-    </tracks> \\
+\begin{lstlisting}
+<?xml version="1.0" encoding="utf-8"?>
+<BrowserEvalProjectDocument>
+	<setup interface="APE" projectReturn="null" />
+	<tracks hostURL="example_eval/" sampleRate="44100"
+	sampleRateExplicit="true">
+		<track url="0.wav"/>
+		<track url="1.wav"/>
+		<track url="2.wav"/>
+		<track url="3.wav"/>
+		<track url="4.wav"/>
+		<track url="5.wav"/>
+		<track url="6.wav"/>
+		<track url="7.wav"/>
+		<track url="8.wav"/>
+		<track url="9.wav"/>
+		<track url="10.wav"/>
+	</tracks>
 </BrowserEvalProjectDocument>
-}
+\end{lstlisting}
+
 
 
 \end{document}
diff -r 05327691d28c -r 59c7ed077dd3 example_eval/project.xml
--- a/example_eval/project.xml	Wed Mar 25 13:31:54 2015 +0000
+++ b/example_eval/project.xml	Thu Mar 26 10:35:29 2015 +0000
@@ -1,3 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
 <BrowserEvalProjectDocument>
 	<setup interface="APE" projectReturn="null" />
 	<tracks hostURL="example_eval/" sampleRate="44100" sampleRateExplicit="true">