Difference between revisions of "User Guide"

From STX Wiki
Jump to navigation Jump to search
(Tutorials)
 
(27 intermediate revisions by 3 users not shown)
Line 3: Line 3:
 
==Organise your sound files==
 
==Organise your sound files==
  
{{STX}} can play, analyse, annotate and modify wave files. The main application - the [[/Workspace/]] - is where you load your sound files and start your analysis from. Your sound files are organised in a [[/Project/|project]] file. You can use the [[/FindFile/]] application to search for wave files on disk and import them into {{STX}}.
+
{{STX}} can play, analyse, annotate and modify wave files. The main application - the [[User_Guide/Workspace|Workspace]] - is where you load your sound files and start your analysis from. Your sound files are organised in a [[User_Guide/Project|project]] file. You can use the [[User_Guide/FindFile|FindFile]] application to search for wave files on disk and import them into {{STX}}.
  
 
==Analyse a Signal==
 
==Analyse a Signal==
Line 9: Line 9:
 
There are a number of applications for analysing signals in {{STX}}.  
 
There are a number of applications for analysing signals in {{STX}}.  
  
* [[/Real_Time_Analyser/|Real-Time Analyser]] - analyse the current sound input as a spectrum, wave or spectrogram graph
+
* [[User_Guide/Real_Time_Analyser|Real-Time Analyser]] - analyse the current sound input as a spectrum, wave or spectrogram graph
* [[/Waveform and Segmentation Viewer/]] - useful for segmenting signals
+
* [[User Guide/Waveform and Segmentation Viewer|Waveform and Segmentation Viewer]] - useful for segmenting signals
* [[/Spectrogram and Parameter Viewer/]] - calculate, edit and extract parameters from the signal. Segmentation is also easy here.
+
* [[User Guide/Spectrogram and Parameter Viewer|Spectrogram and Parameter Viewer]] - calculate, edit and extract parameters from the signal. Segmentation is also easy here.
* [[/Spectrum Viewer/]] - average the spectra of a signal segment.
+
* [[User Guide/Spectrum Viewer|Spectrum Viewer]] - average the spectra of a signal segment.
* [[/SPExL/]] - an application specifically designed for segmentation.
+
* [[User Guide/Transcription Script|Transcription]] - an application specifically designed for segmentation and transcription.
  
 
==Record a Signal==
 
==Record a Signal==
  
The [[/Recorder/]] can be used to save an input stream to disk and segment on the fly.
+
The [[User Guide/Recorder|Recorder]] can be used to save an input stream to disk and whilst segmenting it on the fly.
  
==[[/Command-Line Parameters/]]==
+
==Command-Line Parameters==
 +
 
 +
There is a minimal set of [[User Guide/Command-Line Parameters|command line parameters]] which can be passed to {{STX}}.
 +
 
 +
==Concepts and Terminology==
 +
 
 +
{{STX}} uses some concepts and terminology which might benefit from some explanation. See [[User Guide/Concepts and Terminology|Concepts and Terminology]].
  
 
==Tutorials==
 
==Tutorials==
  
There are a few tutorials available [[/Tutorials/|here]].
+
There are a few [[User Guide/Tutorials|tutorials available]].
 +
 
 +
* [[User_Guide/Tutorials/Analysing_a_sound_file|Analysing a sound file]]
 +
* [[User_Guide/Tutorials/Opening_the_samples.stxpr_project|Opening the sample project]]
 +
* [[User_Guide/Tutorials/Playing_a_sound_file|Play a sound file]]
 +
* [[User_Guide/Tutorials/Running_an_application|Running an application]]
 +
* [[User_Guide/Tutorials/Setting_the_default_application|Setting the default application]]
 +
* [[User_Guide/Tutorials/Zooming_in_a_Viewer|Zooming in a viewer]]
 +
 
 +
There is also the introductory video about [https://kfsmail.kfs.oeaw.ac.at/owncloud/index.php/s/cbMjVjgQLZGjYk8 the compact workspace].
  
==Scripts, Development, and Extending {{STX}}==
+
==Scripts, Toolboxes, Development, and Extending {{STX}}==
  
{{STX}} comes with a number of [[/Pre-installed scripts/|pre-installed scripts]] - applications written in the {{STX}} scripting language, and loaded and run from a text file. You can write your own {{STX}} scripts, [[/Toolbox/|toolboxes]] and applications. All the functionality that you find in {{STX}} is available to you in the script language. The [[User_Guide/Workspace/Script_Controller#The Console|command line console]], integrated [[/Debugger/|debugger]] and the [[Programmer Guide]] will help you.
+
{{STX}} comes with a number of [[User Guide/Pre-installed scripts|pre-installed scripts]] - applications written in the {{STX}} scripting language, and loaded and run from a text file. You can write your own {{STX}} scripts, [[User Guide/Toolbox|toolboxes]] and applications. All the functionality that you find in {{STX}} is available to you in the script language. The [[User Guide/The_Script_Controller|script controller]] dialog, the [[User Guide/STX_Console|command line console]], the integrated [[User Guide/Debugger|debugger]] and the [[Programmer Guide]] will help you.
  
 
==The Log Window==
 
==The Log Window==
 
The little window up on the left hand corner of the screen is the {{STX}} [[/Log Window/]]. You can start a number of applications from here, change some general {{STX}} settings, and view the log messages.
 
The little window up on the left hand corner of the screen is the {{STX}} [[/Log Window/]]. You can start a number of applications from here, change some general {{STX}} settings, and view the log messages.
 
==[[/Appendix/]]==
 
 
C.G. 20110420: ''Information bitte an geeigneter Stelle unterbringen'':
 
 
* Problem Deutsch-PC - Stereo-Mixer unter Windows 7 - ist leicht zu lösen, ''wennnn'' der Hardwarehersteller ordentliche Treiber ausliefert. Gedankensplitter:
 
:* Für die Medion-PCs lassen sich Treiber ganz einfach von http://www.medion.de/ herniederladen.
 
:* ''Danach'' lässt sich normalerweise schon der Stereo-Mixer aktivieren (rechte Maustaste auf Lautsprechersymbol im Windows-Tray, "Recording Devices" wählen, dort wieder mit der rechten Maustaste in der Geräteliste "Show disabled devices" und "Show disconnected devices" wählen und... schon ist der Mixer "Stereo Mix" da. Den dann einschalten bzw. als Default setzen.)
 
:* Anregungen geben auch (willkürlich herausgegriffen) z.B. http://www.ehow.com/how_6828062_connect-sound-card-output-input.html oder http://forum.audacityteam.org/viewtopic.php?f=12&t=4485#p17655
 

Latest revision as of 12:08, 4 October 2019

Organise your sound files

STx can play, analyse, annotate and modify wave files. The main application - the Workspace - is where you load your sound files and start your analysis from. Your sound files are organised in a project file. You can use the FindFile application to search for wave files on disk and import them into STx.

Analyse a Signal

There are a number of applications for analysing signals in STx.

Record a Signal

The Recorder can be used to save an input stream to disk and whilst segmenting it on the fly.

Command-Line Parameters

There is a minimal set of command line parameters which can be passed to STx.

Concepts and Terminology

STx uses some concepts and terminology which might benefit from some explanation. See Concepts and Terminology.

Tutorials

There are a few tutorials available.

There is also the introductory video about the compact workspace.

Scripts, Toolboxes, Development, and Extending STx

STx comes with a number of pre-installed scripts - applications written in the STx scripting language, and loaded and run from a text file. You can write your own STx scripts, toolboxes and applications. All the functionality that you find in STx is available to you in the script language. The script controller dialog, the command line console, the integrated debugger and the Programmer Guide will help you.

The Log Window

The little window up on the left hand corner of the screen is the STx Log Window. You can start a number of applications from here, change some general STx settings, and view the log messages.