2.0.0.2: Added some comments to configuration file.

git-svn-id: https://casparcg.svn.sourceforge.net/svnroot/casparcg/server/branches/2.0.0.2@791 362d55ac-95cf-4e76-9f9a-cbaa9c17b72d

diff --git a/shell/caspar.config b/shell/caspar.config
index 7932a17fdbee217469f73f60476d335885f241c1..9eb0884d323729acb3e905ffcf182d286063624f 100644 (file)
--- a/shell/caspar.config
+++ b/shell/caspar.config
@@ -8,33 +8,54 @@
     <template-host>cg.fth.18</template-host>\r
   </paths>\r
   <diagnostics>\r
-    <graphs>true</graphs>\r
+    <graphs>true</graphs> <!-- [true/false] Displays diagnostics window with real-time graphs. -->\r
   </diagnostics>\r
   <ffmpeg>\r
     <slice-threads-regex>\r
-      <!-- Use slice threads only for tested codecs.-->\r
+      <!-- Use slice threads only for tested codecs. Some codecs do not like to have multiple multithreaded decoders running simultaneously.-->\r
       <!-- Match the provided regex expression against the codec-id.-->\r
-      2 <!-- mpeg2 --> | 28 <!-- h264 --> | 102 <!-- dnxhd -->\r
+      2 <!-- mpeg2 --> | \r
+      28 <!-- h264 -->\r
     </slice-threads-regex>\r
   </ffmpeg>\r
   <channels>\r
     <channel>\r
+      <!--\r
+        Fully or partially supported video-formats:\r
+          PAL (full support)\r
+          NTSC\r
+          576p2500\r
+          720p2500\r
+          720p5000\r
+          720p5994\r
+          720p6000\r
+          1080p2398\r
+          1080p2400\r
+          1080i5000 (full support)\r
+          1080i5994\r
+          1080i6000\r
+          1080p2500\r
+          1080p2997\r
+          1080p3000\r
+          1080p5000\r
+      -->\r
       <videomode>1080i5000</videomode>\r
       <consumers>\r
         <decklink>\r
-          <device>1</device>\r
-          <embedded-audio>true</embedded-audio>\r
-          <latency>low</latency>\r
-          <key>external</key>\r
-          <output>default</output>\r
+          <device>1</device>                    <!-- [1..] Specifies which device to use. -->\r
+          <embedded-audio>true</embedded-audio> <!-- [true/false] -->\r
+          <latency>low</latency>                <!-- [low/default] - Experimental feature that reduces frame delay by 3 frames or less. -->\r
+          <key>external</key>                   <!-- [internal/external]-->\r
+          <output>default</output>              <!-- [key_only/default] - Copies key into fill channels. -->\r
         </decklink>\r
-        <!--<ogl>\r
+        <!--<ogl>        \r
           <device>1</device>\r
           <stretch>uniform</stretch>\r
           <windowed>true</windowed>\r
           <output>key_only</output>\r
         </ogl>-->\r
-        <!--<audio/>-->\r
+        <!--<audio>\r
+        </audio>-->\r
         <!--<bluefish>\r
           <device>1</device>\r
           <embedded-audio>true</embedded-audio>\r