@database SFX-ARexx

Copyright (c) 1994 Stefan Kost
All Rights Reserved

@Remark $VER: SFX-ARexx.guide 3.0 (13.1.95)
@Remark AmigaGuide-OnLine-Hilfe für SoundFX 3.0

@master progdir:guides/sfx-arexx.guide
@index progdir:sfx.guide/main

@node Charpter3.1 "3.1 Einführung"

3.1 Einführung
--------------

SoundFX besitz seit der Version 2.85 einen AREXX-Port. Dieser hat allerdings
noch nicht besonders viele Befehle und Funktionen. Das liegt daran, daß ich mir
zur Zeit noch Gedanken über das Konzept des Ports mache. Ein großer Teil der
Operatoren besitzt sehr viele Parameter. Wenn man diese alle beim Aufruf über-
geben müßte, wäre das zu umständlich. Eine mögliche Lösung sehe ich zur Zeit in
einem Verfahren mit Tag-Listen.
Wenn die Implementierung fertig ist, wird sich SFX komplett fernsteuern lassen
und somit noch besser mit anderen Programmen zusammenarbeiten.
@endnode

@node Charpter3.2 "3.2 Allgemeine Funktionen"

3.2 Allgemeine Funktionen
-------------------------

	@{" 3.2.1 ActivateSFX        " link AREXX_ActivateSFX }
	@{" 3.2.2 ExitSFX            " link AREXX_ExitSFX }
	@{" 3.2.3 RenameActiveBuffer " link AREXX_RenameActiveBuffer }
	@{" 3.2.4 SetActiveBuffer    " link AREXX_SetActiveBuffer }
@endnode

@node Charpter3.3 "3.3 I/O Funktionen"

3.2 I/O Funktionen
------------------

	@{" 3.3.1 GetSample          " link AREXX_GetSample }
	@{" 3.3.2 LoadSample         " link AREXX_LoadSample }
	@{" 3.3.3 PutSample          " link AREXX_PutSample }
	@{" 3.3.4 SaveSample         " link AREXX_SaveSample }
	@{" 3.3.5 SelLoader          " link AREXX_SelLoader }
	@{" 3.3.6 SelPlayer          " link AREXX_SelPlayer }
	@{" 3.3.7 SelSaver           " link AREXX_SelSaver }
@endnode


@node AREXX_ActivateSFX "3.2.1 ActivateSFX"

3.2.1 ActivateSFX
-----------------

Aufruf :
	ActivateSFX

Funktion :
	Bringt den SoundFX-Screen in den Vordergrund
@endnode

@node AREXX_ExitSFX "3.2.2 ExitSFX"

3.2.2 ExitSFX
-------------

Aufruf :
	ExitSFX

Funktion :
	Beendet SoundFX ohne Sicherheitsabfrage.
@endnode

@node AREXX_RenameActiveBuffer "3.2.3 RenameActiveBuffer"

3.2.3 RenameActiveBuffer
------------------------

Aufruf :
	RenameActiveBuffer 'nname'

Funktion :
	Ändert den Namen eines Puffers.

Parameter :
	nname	neuer Name
@endnode

@node AREXX_SetActiveBuffer "3.2.3 SetActiveBuffer"

3.2.3 SetActiveBuffer
---------------------

Aufruf :
	SetActiveBuffer 'bname'

Funktion :
	Wählt den entsprechenden Buffer als aktiven aus.

Parameter :
	bname	Name des Samplepuffers
@endnode

@node AREXX_GetSample "3.3.1 GetSample"

3.3.1 GetSample
---------------

Aufruf :
	GetSample 'adresse typ'

Funktion :
	Läd ein Sample aus SFX in einem Puffer. Hiermit kann ein Programm ein
	Sample aus SFX herausladen.

Parameter :
	adresse	Speicherbereich, in den das Sample geladen werden soll. Man
		sollte sicherstellen, daß dieser korrekt allokiert wurden, da
		SFX dies nicht prüft.
	typ	Noch nicht unterstützt - bitte '0' angeben.

@endnode

@node AREXX_LoadSample "3.3.2 LoadSample"

3.3.2 LoadSample
----------------

Aufruf :
	LoadSample 'fname'

Funktion :
	Läd ein Sample mit dem aktuellen Loader. Dieser kann mit @{" SelLoader " link AREXX_SelLoader}
	ausgeählt werden.

Parameter :
	fname	Dateiname incl. vollständigem Pfad.
@endnode

@node AREXX_PutSample "3.3.3 PutSample"

3.3.3 PutSample
---------------

Aufruf :
	PutSample 'adresse länge name typ'

Funktion :
	Läd ein Sample aus einem Puffer in SFX. Hiermit kann ein Programm ein
	Sample in SFX hineinladen.

Parameter :
	adresse	Speicherbereich, aus dem das Sample geladen werden soll. Man sol-
		lte sicherstellen, daß dieser korrekt allokiert wurden, da SFX
		dies nicht prüft.
	länge	Länge des Samples, welches geladen wird.
	name	Bezeichnung, die das Sample in SFX haben soll.
	typ	Noch nicht unterstützt - bitte '0' angeben.

@endnode

@node AREXX_SaveSample "3.3.4 SaveSample"

3.3.4 SaveSample
----------------

Aufruf :
	SaveSample 'fname'

Funktion :
	Speichert das Sample im aktuellen Puffer mit dem aktuellen Saver.
	Dieser kann mit @{" SelSaver " link AREXX_SelSaver} ausgeählt werden.

Parameter :
	fname	Dateiname incl. vollständigem Pfad.
@endnode

@node AREXX_SelLoader "3.3.5 SelLoader"

3.3.5 SelLoader
---------------

Aufruf :
	SelLoader 'lname'

Funktion :
	Wählt den entsprechenden Loader als aktuellen aus.

Parameter :
	lname	Name des Loaders
@endnode

@node AREXX_SelPlayer "3.3.6 SelPlayer"

3.3.6 SelPlayer
---------------

Aufruf :
	SelPlayer 'pname'

Funktion :
	Wählt den entsprechenden Player als aktuellen aus.

Parameter :
	pname	Name des Player
@endnode

@node AREXX_SelSaver "3.3.7 SelSaver"

3.3.7 SelSaver
--------------

Aufruf :
	SelSaver 'sname'

Funktion :
	Wählt den entsprechenden Saver als aktuellen aus.

Parameter :
	sname	Name des Savers
@endnode