added configuration comments

git-svn-id: https://oreka.svn.sourceforge.net/svnroot/oreka/trunk@67 09dcff7a-b715-0410-9601-b79a96267cd0

2 files changed, 51 insertions, 16 deletions

diff --git a/orkaudio/config-linux-template.xml b/orkaudio/config-linux-template.xml
index 68e314e..10434e7 100644
--- a/orkaudio/config-linux-template.xml
+++ b/orkaudio/config-linux-template.xml
@@ -4,10 +4,6 @@
 
 	<AudioOutputPath>/var/log/orkaudio</AudioOutputPath>
 
-	<TrackerHostname>localhost</TrackerHostname>
-	<EnableReporting>true</EnableReporting>
-	<ClientTimeout>1000</ClientTimeout>
-
 	<!-- Use the following if oreka has been installed (having run "make install") -->
 	<CapturePluginPath>/usr/lib</CapturePluginPath>
 	<CapturePlugin>libvoip.so</CapturePlugin>
@@ -15,14 +11,31 @@
 	<!--<CapturePluginPath>audiocaptureplugins/voip/.libs</CapturePluginPath>-->
 	<!--<CapturePlugin>libvoip.so</CapturePlugin>-->
 
+	<!-- Audio file storage format: choose from: native, gsm, ulaw, alaw -->
 	<StorageAudioFormat>gsm</StorageAudioFormat>
-	<NumBatchThreads></NumBatchThreads>
+
+	<!-- If you want to keep native audio files as well as compressed, change this to "no" -->
 	<DeleteNativeFile>yes</DeleteNativeFile>
+
+	<NumBatchThreads></NumBatchThreads>
+
+	<TrackerHostname>localhost</TrackerHostname>
+	<EnableReporting>true</EnableReporting>
+	<ClientTimeout>1000</ClientTimeout>	
+	
 	<AudioSegmentation>false</AudioSegmentation>
 	<AudioSegmentDuration>10</AudioSegmentDuration>
+	
 	<VoIpPlugin>
-		<Device>eth0</Device>
+		<!-- Unix style network device. Use this if you want to force capture from a given device. -->
+		<!-- All available devices are listed in /etc/orkaudio/orkaudio.log when the service is starting -->
+		<!--<Device>eth0</Device>-->
+		
+		<!-- LanMasks can be ignored if you have standard LAN addresses (192.168.x.x or 10.x.x.x) -->
+		<!-- LanMasks might be used to determine the direction of a call (incoming or outgoing into or from the LAN) -->
 		<!--<LanMasks>10.4.3.4, 1.2.3.4</LanMasks>-->
+		
+		<!-- The following is a csv list of your PBX, PSTN gateway, conferencing server or such "gateway" devices -->
 		<!--<MediaGateways>10.0.0.102</MediaGateways>-->
 	</VoIpPlugin>
 	<GeneratorPlugin>
diff --git a/orkaudio/config-template.xml b/orkaudio/config-template.xml
index 0886994..5599f04 100644
--- a/orkaudio/config-template.xml
+++ b/orkaudio/config-template.xml
@@ -1,24 +1,46 @@
 <config>
-<!-- This is an example configuration file for the Oreka orkaudio capture service -->
-<!-- Copy this to config.xml and modify according to taste -->
+	<!-- This is an example configuration file for the Oreka orkaudio capture service on Windows -->
+	<!-- Copy this to config.xml and modify according to taste -->
+
+	<AudioOutputPath>./AudioRecordings</AudioOutputPath>
+
+	<!-- Uncomment the plugin you want to use -->
+	<CapturePlugin>VoIP.dll</CapturePlugin>
+	<!--<CapturePlugin>Generator.dll</CapturePlugin>-->
+	<!--<CapturePlugin>SoundDevice.dll</CapturePlugin>-->
+	<CapturePluginPath>audiocaptureplugins/</CapturePluginPath>	
+	
+	<!-- Audio file storage format: choose from: native, gsm, ulaw, alaw -->
+	<StorageAudioFormat>gsm</StorageAudioFormat>
+	
+	<!-- If you want to keep native audio files as well as compressed, change this to "no" -->
+	<DeleteNativeFile>yes</DeleteNativeFile>
+	
 	<TrackerHostname>localhost</TrackerHostname>
-	<EnableReporting>true</EnableReporting>
+	<EnableReporting>false</EnableReporting>
 	<ClientTimeout>1000</ClientTimeout>
-	<CapturePluginPath>audiocaptureplugins/</CapturePluginPath>
-	<CapturePlugin>Generator.dll</CapturePlugin>
-	<StorageAudioFormat>gsm</StorageAudioFormat>
+	
 	<NumBatchThreads></NumBatchThreads>
-	<DeleteNativeFile>no</DeleteNativeFile>
+	
 	<AudioSegmentation>false</AudioSegmentation>
 	<AudioSegmentDuration>10</AudioSegmentDuration>
+	
 	<VoIpPlugin>
-		<Device>\Device\NPF_{2FEDB9F0-F584-48A8-B164-117965F80986}</Device>
+		<!-- Microsoft Windows style network device. Use this if you want to force capture from a given device. -->
+		<!-- All available devices are listed in orkaudio.log when the service is starting -->
+		<!--<Device>\Device\NPF_{E0E496FA-DABF-47C1-97C2-DD914DFD3354}</Device>-->
+		
+		<!-- LanMasks can be ignored if you have standard LAN addresses (192.168.x.x or 10.x.x.x) -->
+		<!-- LanMasks might be used to determine the direction of a call (incoming or outgoing into or from the LAN) -->
 		<!--<LanMasks>10.4.3.4, 1.2.3.4</LanMasks>-->
-		<MediaGateways>10.0.0.102</MediaGateways>
+		
+		<!-- The following is a csv list of your PBX, PSTN gateway, conferencing server or such "gateway" devices -->
+		<!-- It is needed to properly detect call direction -->
+		<!--<MediaGateways>10.0.0.102</MediaGateways>-->
 	</VoIpPlugin>
 	<GeneratorPlugin>
 		<NumConcurrentPorts>1</NumConcurrentPorts>
 		<AudioDuration>5</AudioDuration>
 		<AudioFilename>sine.8KHz.pcm.wav</AudioFileName>
 	</GeneratorPlugin>
-</config>
+</config>
\ No newline at end of file