Difference between revisions of "User Guide"

From STX Wiki
Jump to navigation Jump to search
(The Log Window)
(Tutorials)
 
(3 intermediate revisions by the same user not shown)
Line 23: Line 23:
 
There is a minimal set of [[User Guide/Command-Line Parameters|command line parameters]] which can be passed to {{STX}}.
 
There is a minimal set of [[User Guide/Command-Line Parameters|command line parameters]] which can be passed to {{STX}}.
  
==Concepts / Terminology==
+
==Concepts and Terminology==
  
 
{{STX}} uses some concepts and terminology which might benefit from some explanation. See [[User Guide/Concepts and Terminology|Concepts and Terminology]].
 
{{STX}} uses some concepts and terminology which might benefit from some explanation. See [[User Guide/Concepts and Terminology|Concepts and Terminology]].
Line 29: Line 29:
 
==Tutorials==
 
==Tutorials==
  
There are a few tutorials available [[User Guide/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, Toolboxes, Development, and Extending {{STX}}==
 
==Scripts, Toolboxes, Development, and Extending {{STX}}==
Line 37: Line 46:
 
==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.
 
==Glossary==
 
 
We've collated some terms which we use in STx into a [[User_Guide/Glossary|glossary]].
 

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.