Unit test work - added configuration and video tests #9. Updated docs…

…. String interpolation. Exception updates.
techyian · Apr 28, 2017 · d0e232d · d0e232d · techyian · May 2, 2017
1 parent 3b29260
commit d0e232d
Show file tree

Hide file tree

Showing 285 changed files with 9,052 additions and 6,258 deletions.
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Techyian
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/docfx/api/.manifest b/docfx/api/.manifest
diff --git a/docfx/articles/examples.md b/docfx/articles/examples.md
@@ -228,7 +228,9 @@ static void Main(string[] args)
 		
 		//Cleanup any resources used by the old encoder, and attach a new MJPEG encoder using I420 pixel format at 25mb/s bitrate.
 		
-		using (var vidEncoder = new MMALVideoEncoder(vidCaptureHandler, MMALEncoding.MMAL_ENCODING_MJPEG, MMALEncoding.MMAL_ENCODING_I420, 25000000, 25, 90))
+		vidCaptureHandler = new VideoStreamCaptureHandler("/home/pi/videos", "mjpeg");
+		
+		using (var vidEncoder = new MMALVideoEncoder(vidCaptureHandler, MMALEncoding.MMAL_ENCODING_MJPEG, MMALEncoding.MMAL_ENCODING_I420, 25000000, 90, 25))
 		{
 			//Create our component pipeline.         
 			cam

diff --git a/docfx/docfx.json b/docfx/docfx.json
@@ -57,7 +57,7 @@
     "overwrite": [
       {
         "files": [
-          "apidoc/**.md"
+          "api/**.md"
         ],
         "exclude": [
           "obj/**",

diff --git a/docs/api/MMALSharp.AnnotateImage.html b/docs/api/MMALSharp.AnnotateImage.html
diff --git a/docs/api/MMALSharp.ColourEffects.html b/docs/api/MMALSharp.ColourEffects.html
@@ -113,18 +113,18 @@ <h3 id="properties">Properties
               </h3>
               <span class="small pull-right mobile-hide">
                 <span class="divider">|</span>
-                <a href="https://github.com/techyian/MMALSharp/new/dev/apiSpec/new?filename=MMALSharp_ColourEffects_Enable.md&amp;value=---%0Auid%3A%20MMALSharp.ColourEffects.Enable%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
+                <a href="https://github.com/techyian/MMALSharp/new/master/apiSpec/new?filename=MMALSharp_ColourEffects_Enable.md&amp;value=---%0Auid%3A%20MMALSharp.ColourEffects.Enable%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
               </span>
               <span class="small pull-right mobile-hide">
-                <a href="https://github.com/techyian/MMALSharp/blob/dev/src/MMALSharp/MMALCameraConfig.cs/#L196">View Source</a>
+                <a href="https://github.com/techyian/MMALSharp/blob/master/src/MMALSharp/MMALCameraConfig.cs/#L196">View Source</a>
               </span>
               <a id="MMALSharp_ColourEffects_Enable_" data-uid="MMALSharp.ColourEffects.Enable*"></a>
               <h4 id="MMALSharp_ColourEffects_Enable" data-uid="MMALSharp.ColourEffects.Enable">Enable</h4>
               <div class="markdown level1 summary"></div>
               <div class="markdown level1 conceptual"></div>
               <h5 class="decalaration">Declaration</h5>
               <div class="codewrapper">
-                <pre><code class="lang-csharp hljs">public int Enable { get; set; }</code></pre>
+                <pre><code class="lang-csharp hljs">public bool Enable { get; set; }</code></pre>
               </div>
               <h5 class="propertyValue">Property Value</h5>
               <table class="table table-bordered table-striped table-condensed">
@@ -136,25 +136,25 @@ <h5 class="propertyValue">Property Value</h5>
                 </thead>
                 <tbody>
                   <tr>
-                    <td><span class="xref">System.Int32</span></td>
+                    <td><span class="xref">System.Boolean</span></td>
                     <td></td>
                   </tr>
                 </tbody>
               </table>
               <span class="small pull-right mobile-hide">
                 <span class="divider">|</span>
-                <a href="https://github.com/techyian/MMALSharp/new/dev/apiSpec/new?filename=MMALSharp_ColourEffects_U.md&amp;value=---%0Auid%3A%20MMALSharp.ColourEffects.U%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
+                <a href="https://github.com/techyian/MMALSharp/new/master/apiSpec/new?filename=MMALSharp_ColourEffects_U.md&amp;value=---%0Auid%3A%20MMALSharp.ColourEffects.U%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
               </span>
               <span class="small pull-right mobile-hide">
-                <a href="https://github.com/techyian/MMALSharp/blob/dev/src/MMALSharp/MMALCameraConfig.cs/#L197">View Source</a>
+                <a href="https://github.com/techyian/MMALSharp/blob/master/src/MMALSharp/MMALCameraConfig.cs/#L197">View Source</a>
               </span>
               <a id="MMALSharp_ColourEffects_U_" data-uid="MMALSharp.ColourEffects.U*"></a>
               <h4 id="MMALSharp_ColourEffects_U" data-uid="MMALSharp.ColourEffects.U">U</h4>
               <div class="markdown level1 summary"></div>
               <div class="markdown level1 conceptual"></div>
               <h5 class="decalaration">Declaration</h5>
               <div class="codewrapper">
-                <pre><code class="lang-csharp hljs">public uint U { get; set; }</code></pre>
+                <pre><code class="lang-csharp hljs">public int U { get; set; }</code></pre>
               </div>
               <h5 class="propertyValue">Property Value</h5>
               <table class="table table-bordered table-striped table-condensed">
@@ -166,25 +166,25 @@ <h5 class="propertyValue">Property Value</h5>
                 </thead>
                 <tbody>
                   <tr>
-                    <td><span class="xref">System.UInt32</span></td>
+                    <td><span class="xref">System.Int32</span></td>
                     <td></td>
                   </tr>
                 </tbody>
               </table>
               <span class="small pull-right mobile-hide">
                 <span class="divider">|</span>
-                <a href="https://github.com/techyian/MMALSharp/new/dev/apiSpec/new?filename=MMALSharp_ColourEffects_V.md&amp;value=---%0Auid%3A%20MMALSharp.ColourEffects.V%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
+                <a href="https://github.com/techyian/MMALSharp/new/master/apiSpec/new?filename=MMALSharp_ColourEffects_V.md&amp;value=---%0Auid%3A%20MMALSharp.ColourEffects.V%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
               </span>
               <span class="small pull-right mobile-hide">
-                <a href="https://github.com/techyian/MMALSharp/blob/dev/src/MMALSharp/MMALCameraConfig.cs/#L198">View Source</a>
+                <a href="https://github.com/techyian/MMALSharp/blob/master/src/MMALSharp/MMALCameraConfig.cs/#L198">View Source</a>
               </span>
               <a id="MMALSharp_ColourEffects_V_" data-uid="MMALSharp.ColourEffects.V*"></a>
               <h4 id="MMALSharp_ColourEffects_V" data-uid="MMALSharp.ColourEffects.V">V</h4>
               <div class="markdown level1 summary"></div>
               <div class="markdown level1 conceptual"></div>
               <h5 class="decalaration">Declaration</h5>
               <div class="codewrapper">
-                <pre><code class="lang-csharp hljs">public uint V { get; set; }</code></pre>
+                <pre><code class="lang-csharp hljs">public int V { get; set; }</code></pre>
               </div>
               <h5 class="propertyValue">Property Value</h5>
               <table class="table table-bordered table-striped table-condensed">
@@ -196,7 +196,7 @@ <h5 class="propertyValue">Property Value</h5>
                 </thead>
                 <tbody>
                   <tr>
-                    <td><span class="xref">System.UInt32</span></td>
+                    <td><span class="xref">System.Int32</span></td>
                     <td></td>
                   </tr>
                 </tbody>
@@ -209,10 +209,10 @@ <h5 class="propertyValue">Property Value</h5>
               <div class="contribution">
                 <ul class="nav">
                   <li>
-                    <a href="https://github.com/techyian/MMALSharp/new/dev/apiSpec/new?filename=MMALSharp_ColourEffects.md&amp;value=---%0Auid%3A%20MMALSharp.ColourEffects%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
+                    <a href="https://github.com/techyian/MMALSharp/new/master/apiSpec/new?filename=MMALSharp_ColourEffects.md&amp;value=---%0Auid%3A%20MMALSharp.ColourEffects%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
                   </li>
                   <li>
-                    <a href="https://github.com/techyian/MMALSharp/blob/dev/src/MMALSharp/MMALCameraConfig.cs/#L194" class="contribution-link">View Source</a>
+                    <a href="https://github.com/techyian/MMALSharp/blob/master/src/MMALSharp/MMALCameraConfig.cs/#L194" class="contribution-link">View Source</a>
                   </li>
                 </ul>
               </div>