From 5dfcb7ef4cb74cf9fb046be9f54c7e17fbbcd70a Mon Sep 17 00:00:00 2001
From: mihaiparvu <mihai-catalin.parvu@nokia.com>
Date: Fri, 31 May 2019 11:06:40 +0300
Subject: [PATCH] Preparation for 1.3.0 release

---
 docs/ScreenCapLibrary-1.3.0.rst | 69 +++++++++++++++++++++++++++++++++
 docs/ScreenCapLibrary.html      |  2 +-
 src/ScreenCapLibrary/library.py |  2 +-
 src/ScreenCapLibrary/version.py |  2 +-
 4 files changed, 72 insertions(+), 3 deletions(-)
 create mode 100644 docs/ScreenCapLibrary-1.3.0.rst

diff --git a/docs/ScreenCapLibrary-1.3.0.rst b/docs/ScreenCapLibrary-1.3.0.rst
new file mode 100644
index 0000000..009b24f
--- /dev/null
+++ b/docs/ScreenCapLibrary-1.3.0.rst
@@ -0,0 +1,69 @@
+======================
+ScreenCapLibrary 1.3.0
+======================
+
+
+.. default-role:: code
+
+
+ScreenCapLibrary is a `Robot Framework`_ test library for taking screenshots on the machine where tests are run.
+ScreenCapLibrary 1.3.0 is a new release is a new release with WebM video capture support and background capturing.
+All issues targeted for ScreenCapLibrary v1.3.0 can be found from
+the `issue tracker`_.
+
+If you have pip_ installed, just run
+
+::
+
+   pip install --upgrade robotframework-screencaplibrary
+
+to install the latest release or use
+
+::
+
+   pip install robotframework-screencaplibrary==1.3.0
+
+to install exactly this version. Alternatively you can download the source
+distribution from PyPI_ and install it manually.
+
+ScreenCapLibrary 1.3.0 was released on Friday May 31, 2019.
+
+.. _Robot Framework: http://robotframework.org
+.. _ScreenCapLibrary: https://github.com/mihaiparvu/ScreenCapLibrary
+.. _pip: http://pip-installer.org
+.. _PyPI: https://pypi.python.org/pypi/robotframework-screencaplibrary
+.. _issue tracker: https://github.com/mihaiparvu/ScreenCapLibrary/issues?q=milestone%3Av1.3.0
+
+
+.. contents::
+   :depth: 2
+   :local:
+
+Most important update
+=====================
+
+- The most important issue is the WebM video capture support (`#20`_).
+
+Full list of fixes and enhancements
+===================================
+
+.. list-table::
+    :header-rows: 1
+
+    * - ID
+      - Type
+      - Priority
+      - Summary
+    * - `#20`_
+      - enhancement
+      - high
+      - Possibility for video screen capture
+    * - `#18`_
+      - enhancement
+      - high
+      - Run keywords in background
+
+Altogether 2 issues. View on the `issue tracker <https://github.com/mihaiparvu/ScreenCapLibrary/issues?q=milestone%3Av1.3.0>`__.
+
+.. _#20: https://github.com/mihaiparvu/ScreenCapLibrary/issues/20
+.. _#18: https://github.com/mihaiparvu/ScreenCapLibrary/issues/18
diff --git a/docs/ScreenCapLibrary.html b/docs/ScreenCapLibrary.html
index 975e8e9..e21dba5 100644
--- a/docs/ScreenCapLibrary.html
+++ b/docs/ScreenCapLibrary.html
@@ -547,7 +547,7 @@
 jQuery.extend({highlight:function(e,t,n,r){if(e.nodeType===3){var i=e.data.match(t);if(i){var s=document.createElement(n||"span");s.className=r||"highlight";var o=e.splitText(i.index);o.splitText(i[0].length);var u=o.cloneNode(true);s.appendChild(u);o.parentNode.replaceChild(s,o);return 1}}else if(e.nodeType===1&&e.childNodes&&!/(script|style)/i.test(e.tagName)&&!(e.tagName===n.toUpperCase()&&e.className===r)){for(var a=0;a<e.childNodes.length;a++){a+=jQuery.highlight(e.childNodes[a],t,n,r)}}return 0}});jQuery.fn.unhighlight=function(e){var t={className:"highlight",element:"span"};jQuery.extend(t,e);return this.find(t.element+"."+t.className).each(function(){var e=this.parentNode;e.replaceChild(this.firstChild,this);e.normalize()}).end()};jQuery.fn.highlight=function(e,t){var n={className:"highlight",element:"span",caseSensitive:false,wordsOnly:false};jQuery.extend(n,t);if(e.constructor===String){e=[e]}e=jQuery.grep(e,function(e,t){return e!=""});e=jQuery.map(e,function(e,t){return e.replace(/[-[\]{}()*+?.,\\^$|#\s]/g,"\\$&")});if(e.length==0){return this}var r=n.caseSensitive?"":"i";var i="("+e.join("|")+")";if(n.wordsOnly){i="\\b"+i+"\\b"}var s=new RegExp(i,r);return this.each(function(){jQuery.highlight(this,s,n.element,n.className)})}
 </script>
 <script type="text/javascript">
-libdoc = {"all_tags":[],"contains_tags":false,"doc":"<p>Test Library for taking screenshots on the machine where tests are run.\x3c/p>\n<p>Note that successfully taking screenshots requires tests to be run with a physical or virtual display.\x3c/p>\n<h2 id=\"Usage\">Usage\x3c/h2>\n<p>How screenshots are taken when using Python depends on the chosen format. There are several supported formats: PNG, JPG/JPEG, GIF and WebP. If no format is specified the screenshots will have the PNG format.\x3c/p>\n<p>For taking screenshots the following modules are used:\x3c/p>\n<ul>\n<li><a href=\"https://python-mss.readthedocs.io\">mss\x3c/a> a fast cross-platform module used for taking screenshots and saving them in PNG format.\x3c/li>\n\x3c/ul>\n<ul>\n<li><a href=\"https://pillow.readthedocs.io\">Pillow\x3c/a> used on top of <code>mss\x3c/code> in order to save the screenshots in JPG/JPEG/WebP format.\x3c/li>\n\x3c/ul>\n<ul>\n<li><a href=\"http://pygtk.org/\">PyGTK\x3c/a> is an alternative to <code>mss\x3c/code> for taking screenshots when using VNC.\x3c/li>\n\x3c/ul>\n<p>For video recording, <a href=\"https://github.com/skvark/opencv-python/blob/master/README.md\">OpenCV-Python\x3c/a> is used and the output file is in WebM format.\x3c/p>\n<h2 id=\"Where screenshots are saved\">Where screenshots are saved\x3c/h2>\n<p>By default screenshots are saved into the same directory where the Robot Framework log file is written. If no log is created, screenshots are saved into the directory where the XML output file is written.\x3c/p>\n<p>It is possible to specify a custom location for screenshots using <code>screenshot_directory\x3c/code> argument when <a href=\"#Importing\" class=\"name\">importing\x3c/a> the library and using <a href=\"#Set%20Screenshot%20Directory\" class=\"name\">Set Screenshot Directory\x3c/a> keyword during execution. It is also possible to save screenshots using an absolute path.\x3c/p>\n<h2 id=\"Time format\">Time format\x3c/h2>\n<p>All delays and time intervals can be given as numbers considered seconds (e.g. <code>0.5\x3c/code> or <code>42\x3c/code>) or in Robot Framework's time syntax (e.g. <code>1.5 seconds\x3c/code> or <code>1 min 30 s\x3c/code>). For more information about the time syntax see the <a href=\"http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#time-format\">Robot Framework User Guide\x3c/a>.\x3c/p>\n<h2 id=\"Boolean arguments\">Boolean arguments\x3c/h2>\n<p>Some keywords accept arguments that are handled as Boolean values true or false. If such an argument is given as a string, it is considered false if it is either an empty string or case-insensitively equal to <code>false\x3c/code>, <code>none\x3c/code> or <code>no\x3c/code>. Other strings are considered true regardless their value, and other argument types are tested using the same <a href=\"http://docs.python.org/2/library/stdtypes.html#truth-value-testing\">rules as in Python\x3c/a>.\x3c/p>\n<p>True examples:\x3c/p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Take%20Partial%20Screenshot\" class=\"name\">Take Partial Screenshot\x3c/a>\x3c/td>\n<td>embed=True\x3c/td>\n<td># Strings are generally true.\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Partial%20Screenshot\" class=\"name\">Take Partial Screenshot\x3c/a>\x3c/td>\n<td>embed=yes\x3c/td>\n<td># Same as the above.\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Partial%20Screenshot\" class=\"name\">Take Partial Screenshot\x3c/a>\x3c/td>\n<td>embed=${TRUE}\x3c/td>\n<td># Python <code>True\x3c/code> is true.\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Partial%20Screenshot\" class=\"name\">Take Partial Screenshot\x3c/a>\x3c/td>\n<td>embed=${42}\x3c/td>\n<td># Numbers other than 0 are true.\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p>False examples:\x3c/p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Take%20Partial%20Screenshot\" class=\"name\">Take Partial Screenshot\x3c/a>\x3c/td>\n<td>embed=False\x3c/td>\n<td># String <code>false\x3c/code> is false.\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Partial%20Screenshot\" class=\"name\">Take Partial Screenshot\x3c/a>\x3c/td>\n<td>embed=no\x3c/td>\n<td># Also string <code>no\x3c/code> is false.\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Partial%20Screenshot\" class=\"name\">Take Partial Screenshot\x3c/a>\x3c/td>\n<td>embed=${EMPTY}\x3c/td>\n<td># Empty string is false.\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Partial%20Screenshot\" class=\"name\">Take Partial Screenshot\x3c/a>\x3c/td>\n<td>embed=${FALSE}\x3c/td>\n<td># Python <code>False\x3c/code> is false.\x3c/td>\n\x3c/tr>\n\x3c/table>","generated":"2019-05-29 10:48:49","inits":[{"args":["screenshot_module=None","screenshot_directory=None","format=png","quality=50","delay=0","fps=8"],"doc":"<p><code>screenshot_module\x3c/code> specifies the module or tool to use when taking screenshots using this library. If no tool or module is specified, <code>mss\x3c/code> will be used by default. For running on Linux with VNC, use <code>PyGTK\x3c/code>.\x3c/p>\n<p>To configure where screenshots are saved use <code>screenshot_directory\x3c/code>. If no value is given, screenshots are saved into same directory as the log file. The directory can also be set using <a href=\"#Set%20Screenshot%20Directory\" class=\"name\">Set Screenshot Directory\x3c/a> keyword.\x3c/p>\n<p><code>format\x3c/code> specifies the format in which the screenshots will be saved. Possible values are <code>png\x3c/code>,  <code>jpeg\x3c/code>, <code>jpg\x3c/code> and <code>webp\x3c/code>, case-insensitively. If no value is given the format is set by default to <code>png\x3c/code>.\x3c/p>\n<p><code>quality\x3c/code> can take values in range [0, 100]. Value 0 is lowest quality, while value 100 is maximum quality. The quality is directly proportional with file size. Because PNG uses lossless compression its size may be larger than the size of the JPG file. The default value is 50.\x3c/p>\n<p><code>delay\x3c/code> specifies the waiting time before taking a screenshot. See <a href=\"#Time%20format\" class=\"name\">Time format\x3c/a> section for more information. By default the delay is 0.\x3c/p>\n<p>Examples (use only one of these):\x3c/p>\n<table border=\"1\">\n<tr>\n<th>Setting\x3c/th>\n<th>Value\x3c/th>\n<th>Value\x3c/th>\n\x3c/tr>\n<tr>\n<td>Library\x3c/td>\n<td>Screenshot\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Library\x3c/td>\n<td>Screenshot\x3c/td>\n<td>PyGTK\x3c/td>\n\x3c/tr>\n<tr>\n<td>Library\x3c/td>\n<td>Screenshot\x3c/td>\n<td>screenshot_directory=${TEMPDIR}\x3c/td>\n\x3c/tr>\n<tr>\n<td>Library\x3c/td>\n<td>Screenshot\x3c/td>\n<td>format=jpg\x3c/td>\n\x3c/tr>\n<tr>\n<td>Library\x3c/td>\n<td>Screenshot\x3c/td>\n<td>quality=0\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Init","shortdoc":"``screenshot_module`` specifies the module or tool to use when taking screenshots using this library. If no tool or module is specified, ``mss`` will be used by default. For running on Linux with VNC, use ``PyGTK``.","tags":[]}],"keywords":[{"args":["path"],"doc":"<p>Sets the directory where screenshots are saved.\x3c/p>\n<p>It is possible to use <code>/\x3c/code> as a path separator in all operating systems. Path to the old directory is returned.\x3c/p>\n<p>The directory can also be set in <a href=\"#Importing\" class=\"name\">importing\x3c/a>.\x3c/p>","matched":true,"name":"Set Screenshot Directory","shortdoc":"Sets the directory where screenshots are saved.","tags":[]},{"args":["name=screenshot","size_percentage=0.5","embed=True","embed_width=800px"],"doc":"<p>Starts the recording of a GIF in the background with the specified <code>name\x3c/code>. The recording can be stopped by calling the <a href=\"#Stop%20Gif%20Recording\" class=\"name\">Stop Gif Recording\x3c/a> keyword.\x3c/p>\n<p><code>name\x3c/code> specifies the name by which the screenshot will be saved.\x3c/p>\n<p><code>size_percentage\x3c/code> is used to reduce the size of the GIFs a resize of the screencaptures. It will specify how much this reduction is with respect to screen resolution. By default this parameter is set to resize the images to 0.5 of the screen resolution.\x3c/p>\n<p><code>embed\x3c/code> specifies if the screenshot should be embedded in the log file or not. See <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments\x3c/a> section for more details.\x3c/p>\n<p><code>embed_width\x3c/code> specifies the size of the screenshot that is embedded in the log file.\x3c/p>\n<p>Examples:\x3c/p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Gif%20Recording\" class=\"name\">Start Gif Recording\x3c/a>\x3c/td>\n<td>\x3c/td>\n<td># Starts the GIF recording in background\x3c/td>\n\x3c/tr>\n<tr>\n<td><span class=\"name\">Sleep\x3c/span>\x3c/td>\n<td>10 seconds\x3c/td>\n<td># Here should be the actions that will be recorded\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Stop%20Gif%20Recording\" class=\"name\">Stop Gif Recording\x3c/a>\x3c/td>\n<td>\x3c/td>\n<td># Will create the GIF containing the screen recording         since <a href=\"#Start%20Gif%20Recording\" class=\"name\">Start Gif Recording\x3c/a> was called.\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p><b>Note:\x3c/b> Recommended GIF duration is 100 seconds or lower depending on system memory.\x3c/p>","matched":true,"name":"Start Gif Recording","shortdoc":"Starts the recording of a GIF in the background with the specified ``name``. The recording can be stopped by calling the `Stop Gif Recording` keyword.","tags":[]},{"args":["name=recording","fps=8","embed=True","embed_width=800px"],"doc":"<p>Starts the recording of a video in the background with the specified <code>name\x3c/code>. The recording can be stopped by calling the <a href=\"#Stop%20Video%20Recording\" class=\"name\">Stop Video Recording\x3c/a> keyword.\x3c/p>\n<p><code>name\x3c/code> specifies the name by which the record will be saved.\x3c/p>\n<p><code>fps\x3c/code> specifies the frame rate at which the video is displayed. By default frame rate is 8.\x3c/p>\n<p><code>embed\x3c/code> specifies if the record should be embedded in the log file or not. See <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments\x3c/a> section for more details.\x3c/p>\n<p><code>embed_width\x3c/code> specifies the size of the video record that is embedded in the log file.\x3c/p>\n<p>Examples:\x3c/p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Video%20Recording\" class=\"name\">Start Video Recording\x3c/a>\x3c/td>\n<td>\x3c/td>\n<td># Starts the video recording in background\x3c/td>\n\x3c/tr>\n<tr>\n<td><span class=\"name\">Sleep\x3c/span>\x3c/td>\n<td>10 seconds\x3c/td>\n<td># Here should be the actions that will be recorded\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Stop%20Video%20Recording\" class=\"name\">Stop Video Recording\x3c/a>\x3c/td>\n<td>\x3c/td>\n<td># Will create the video containing the screen recording         since <a href=\"#Start%20Video%20Recording\" class=\"name\">Start Video Recording\x3c/a> was called.\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p><b>Note:\x3c/b> Be aware that during recording the number of the collected frames are dependent on the performance of your system. Check different values for <code>fps\x3c/code> to find optimal results.(e.g. for a 15 seconds recording the output might be a 2 second video with 30 fps).\x3c/p>","matched":true,"name":"Start Video Recording","shortdoc":"Starts the recording of a video in the background with the specified ``name``. The recording can be stopped by calling the `Stop Video Recording` keyword.","tags":[]},{"args":[],"doc":"<p>Stops the GIF recording and generates the file. If <code>embed\x3c/code> argument was set to <code>True\x3c/code> the GIF will be displayed in the log file.\x3c/p>","matched":true,"name":"Stop Gif Recording","shortdoc":"Stops the GIF recording and generates the file. If ``embed`` argument was set to ``True`` the GIF will be displayed in the log file.","tags":[]},{"args":[],"doc":"<p>Stops the video recording and generates the file in WebM format. If <code>embed\x3c/code> argument was set to <code>True\x3c/code> the video will be displayed in the log file.\x3c/p>","matched":true,"name":"Stop Video Recording","shortdoc":"Stops the video recording and generates the file in WebM format. If ``embed`` argument was set to ``True`` the video will be displayed in the log file.","tags":[]},{"args":["name=screenshot","format=None","quality=None","screenshot_number=2","delay_time=0"],"doc":"<p>Takes the specified number of screenshots in the specified format at library import and embeds it into the log file (PNG by default).\x3c/p>\n<p>This keyword is similar with <a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a> but has some extra parameters listed below:\x3c/p>\n<p><code>screenshot_number\x3c/code> specifies the number of screenshots to be taken. By default this number is 2.\x3c/p>\n<p><code>delay_time\x3c/code> specifies the waiting time before taking another screenshot. See <a href=\"#Time%20format\" class=\"name\">Time format\x3c/a> section for more information. By default the delay time is 0.\x3c/p>","matched":true,"name":"Take Multiple Screenshots","shortdoc":"Takes the specified number of screenshots in the specified format at library import and embeds it into the log file (PNG by default).","tags":[]},{"args":["name=screenshot","format=None","quality=None","left=0","top=0","width=700","height=300","embed=True","embed_width=800px"],"doc":"<p>Takes a partial screenshot in the specified format and dimensions at library import and embeds it into the log file (PNG by default).\x3c/p>\n<p>This keyword is similar with <a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a> but has some extra parameters listed below:.\x3c/p>\n<p><code>left\x3c/code> specifies the cropping distance on the X axis from the left of the screen capture.\x3c/p>\n<p><code>top\x3c/code> specifies the cropping distance on the Y axis from the top of the screen capture.\x3c/p>\n<p><code>width\x3c/code> specifies the width of a screen capture when using partial screen captures.\x3c/p>\n<p><code>height\x3c/code> specifies the height of a screen capture when using partial screen captures.\x3c/p>\n<p><code>embed\x3c/code> specifies if the screenshot should be embedded in the log file or not. See <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments\x3c/a> section for more details.\x3c/p>\n<p><code>embed_width\x3c/code> specifies the size of the screenshot that is embedded in the log file.\x3c/p>","matched":true,"name":"Take Partial Screenshot","shortdoc":"Takes a partial screenshot in the specified format and dimensions at library import and embeds it into the log file (PNG by default).","tags":[]},{"args":["name=screenshot","format=None","quality=None","width=800px","delay=0"],"doc":"<p>Takes a screenshot in the specified format at library import and embeds it into the log file (PNG by default).\x3c/p>\n<p>Name of the file where the screenshot is stored is derived from the given <code>name\x3c/code>. If the <code>name\x3c/code> ends with extension <code>.jpg\x3c/code>, <code>.jpeg\x3c/code>, <code>.png\x3c/code> or <code>.webp\x3c/code>, the screenshot will be stored with that exact name. Otherwise a unique name is created by adding an underscore, a running index and an extension to the <code>name\x3c/code>.\x3c/p>\n<p>The name will be interpreted to be relative to the directory where the log file is written. It is also possible to use absolute paths. Using <code>/\x3c/code> as a path separator works in all operating systems.\x3c/p>\n<p><code>format\x3c/code> specifies the format in which the screenshot is saved. If no format is provided the library import value will be used which is <code>png\x3c/code> by default. Can be either <code>jpg\x3c/code>, <code>jpeg\x3c/code>, <code>png\x3c/code>, or <code>webp\x3c/code>, case insensitive.\x3c/p>\n<p><code>quality\x3c/code> can take values in range [0, 100]. In case of JPEG format it can drastically reduce the file size of the image.\x3c/p>\n<p><code>width\x3c/code> specifies the size of the screenshot in the log file.\x3c/p>\n<p><code>delay\x3c/code> specifies the waiting time before taking a screenshot. See <a href=\"#Time%20format\" class=\"name\">Time format\x3c/a> section for more information. By default the delay is 0.\x3c/p>\n<p>Examples: (LOGDIR is determined automatically by the library)\x3c/p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td># LOGDIR/screenshot_1.png (index automatically incremented)\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a>\x3c/td>\n<td>mypic\x3c/td>\n<td>\x3c/td>\n<td># LOGDIR/mypic_1.png (index automatically incremented)\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a>\x3c/td>\n<td>${TEMPDIR}/mypic\x3c/td>\n<td>\x3c/td>\n<td># /tmp/mypic_1.png (index automatically incremented)\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a>\x3c/td>\n<td>pic.jpg\x3c/td>\n<td>\x3c/td>\n<td># LOGDIR/pic.jpg (always uses this file)\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a>\x3c/td>\n<td>images/login.jpg\x3c/td>\n<td>300px\x3c/td>\n<td># Specify both name and width.\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a>\x3c/td>\n<td>width=550px\x3c/td>\n<td>\x3c/td>\n<td># Specify only width.\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a>\x3c/td>\n<td>format=jpg\x3c/td>\n<td>quality=15\x3c/td>\n<td># Specify both image format and quality\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p>The path where the screenshot is saved is returned.\x3c/p>","matched":true,"name":"Take Screenshot","shortdoc":"Takes a screenshot in the specified format at library import and embeds it into the log file (PNG by default).","tags":[]},{"args":["name=screenshot","format=None","quality=None","delay=0"],"doc":"<p>Takes a screenshot and links it from the log file. This keyword is otherwise identical to <a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a> but the saved screenshot is not embedded into the log file. The screenshot is linked so it is nevertheless easily available.\x3c/p>","matched":true,"name":"Take Screenshot Without Embedding","shortdoc":"Takes a screenshot and links it from the log file. This keyword is otherwise identical to `Take Screenshot` but the saved screenshot is not embedded into the log file. The screenshot is linked so it is nevertheless easily available.","tags":[]}],"name":"ScreenCapLibrary","named_args":true,"scope":"test case","version":"1.3.0rc2"};
+libdoc = {"all_tags":[],"contains_tags":false,"doc":"<p>Test Library for taking screenshots on the machine where tests are run.\x3c/p>\n<p>Note that successfully taking screenshots requires tests to be run with a physical or virtual display.\x3c/p>\n<h2 id=\"Usage\">Usage\x3c/h2>\n<p>How screenshots are taken when using Python depends on the chosen format. There are several supported formats: PNG, JPG/JPEG, GIF and WebP. If no format is specified the screenshots will have the PNG format.\x3c/p>\n<p>For taking screenshots the following modules are used:\x3c/p>\n<ul>\n<li><a href=\"https://python-mss.readthedocs.io\">mss\x3c/a> a fast cross-platform module used for taking screenshots and saving them in PNG format.\x3c/li>\n\x3c/ul>\n<ul>\n<li><a href=\"https://pillow.readthedocs.io\">Pillow\x3c/a> used on top of <code>mss\x3c/code> in order to save the screenshots in JPG/JPEG/WebP format.\x3c/li>\n\x3c/ul>\n<ul>\n<li><a href=\"http://pygtk.org/\">PyGTK\x3c/a> is an alternative to <code>mss\x3c/code> for taking screenshots when using VNC.\x3c/li>\n\x3c/ul>\n<p>For video recording, <a href=\"https://github.com/skvark/opencv-python/blob/master/README.md\">OpenCV-Python\x3c/a> is used and the output file is in WebM format.\x3c/p>\n<h2 id=\"Where screenshots are saved\">Where screenshots are saved\x3c/h2>\n<p>By default screenshots are saved into the same directory where the Robot Framework log file is written. If no log is created, screenshots are saved into the directory where the XML output file is written.\x3c/p>\n<p>It is possible to specify a custom location for screenshots using <code>screenshot_directory\x3c/code> argument when <a href=\"#Importing\" class=\"name\">importing\x3c/a> the library and using <a href=\"#Set%20Screenshot%20Directory\" class=\"name\">Set Screenshot Directory\x3c/a> keyword during execution. It is also possible to save screenshots using an absolute path.\x3c/p>\n<h2 id=\"Time format\">Time format\x3c/h2>\n<p>All delays and time intervals can be given as numbers considered seconds (e.g. <code>0.5\x3c/code> or <code>42\x3c/code>) or in Robot Framework's time syntax (e.g. <code>1.5 seconds\x3c/code> or <code>1 min 30 s\x3c/code>). For more information about the time syntax see the <a href=\"http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#time-format\">Robot Framework User Guide\x3c/a>.\x3c/p>\n<h2 id=\"Boolean arguments\">Boolean arguments\x3c/h2>\n<p>Some keywords accept arguments that are handled as Boolean values true or false. If such an argument is given as a string, it is considered false if it is either an empty string or case-insensitively equal to <code>false\x3c/code>, <code>none\x3c/code> or <code>no\x3c/code>. Other strings are considered true regardless their value, and other argument types are tested using the same <a href=\"http://docs.python.org/2/library/stdtypes.html#truth-value-testing\">rules as in Python\x3c/a>.\x3c/p>\n<p>True examples:\x3c/p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Take%20Partial%20Screenshot\" class=\"name\">Take Partial Screenshot\x3c/a>\x3c/td>\n<td>embed=True\x3c/td>\n<td># Strings are generally true.\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Partial%20Screenshot\" class=\"name\">Take Partial Screenshot\x3c/a>\x3c/td>\n<td>embed=yes\x3c/td>\n<td># Same as the above.\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Partial%20Screenshot\" class=\"name\">Take Partial Screenshot\x3c/a>\x3c/td>\n<td>embed=${TRUE}\x3c/td>\n<td># Python <code>True\x3c/code> is true.\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Partial%20Screenshot\" class=\"name\">Take Partial Screenshot\x3c/a>\x3c/td>\n<td>embed=${42}\x3c/td>\n<td># Numbers other than 0 are true.\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p>False examples:\x3c/p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Take%20Partial%20Screenshot\" class=\"name\">Take Partial Screenshot\x3c/a>\x3c/td>\n<td>embed=False\x3c/td>\n<td># String <code>false\x3c/code> is false.\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Partial%20Screenshot\" class=\"name\">Take Partial Screenshot\x3c/a>\x3c/td>\n<td>embed=no\x3c/td>\n<td># Also string <code>no\x3c/code> is false.\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Partial%20Screenshot\" class=\"name\">Take Partial Screenshot\x3c/a>\x3c/td>\n<td>embed=${EMPTY}\x3c/td>\n<td># Empty string is false.\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Partial%20Screenshot\" class=\"name\">Take Partial Screenshot\x3c/a>\x3c/td>\n<td>embed=${FALSE}\x3c/td>\n<td># Python <code>False\x3c/code> is false.\x3c/td>\n\x3c/tr>\n\x3c/table>","generated":"2019-05-31 11:05:34","inits":[{"args":["screenshot_module=None","screenshot_directory=None","format=png","quality=50","delay=0","fps=8"],"doc":"<p><code>screenshot_module\x3c/code> specifies the module or tool to use when taking screenshots using this library. If no tool or module is specified, <code>mss\x3c/code> will be used by default. For running on Linux with VNC, use <code>PyGTK\x3c/code>.\x3c/p>\n<p>To configure where screenshots are saved use <code>screenshot_directory\x3c/code>. If no value is given, screenshots are saved into same directory as the log file. The directory can also be set using <a href=\"#Set%20Screenshot%20Directory\" class=\"name\">Set Screenshot Directory\x3c/a> keyword.\x3c/p>\n<p><code>format\x3c/code> specifies the format in which the screenshots will be saved. Possible values are <code>png\x3c/code>,  <code>jpeg\x3c/code>, <code>jpg\x3c/code> and <code>webp\x3c/code>, case-insensitively. If no value is given the format is set by default to <code>png\x3c/code>.\x3c/p>\n<p><code>quality\x3c/code> can take values in range [0, 100]. Value 0 is lowest quality, while value 100 is maximum quality. The quality is directly proportional with file size. Because PNG uses lossless compression its size may be larger than the size of the JPG file. The default value is 50.\x3c/p>\n<p><code>delay\x3c/code> specifies the waiting time before taking a screenshot. See <a href=\"#Time%20format\" class=\"name\">Time format\x3c/a> section for more information. By default the delay is 0.\x3c/p>\n<p>Examples (use only one of these):\x3c/p>\n<table border=\"1\">\n<tr>\n<th>Setting\x3c/th>\n<th>Value\x3c/th>\n<th>Value\x3c/th>\n\x3c/tr>\n<tr>\n<td>Library\x3c/td>\n<td>Screenshot\x3c/td>\n<td>\x3c/td>\n\x3c/tr>\n<tr>\n<td>Library\x3c/td>\n<td>Screenshot\x3c/td>\n<td>PyGTK\x3c/td>\n\x3c/tr>\n<tr>\n<td>Library\x3c/td>\n<td>Screenshot\x3c/td>\n<td>screenshot_directory=${TEMPDIR}\x3c/td>\n\x3c/tr>\n<tr>\n<td>Library\x3c/td>\n<td>Screenshot\x3c/td>\n<td>format=jpg\x3c/td>\n\x3c/tr>\n<tr>\n<td>Library\x3c/td>\n<td>Screenshot\x3c/td>\n<td>quality=0\x3c/td>\n\x3c/tr>\n\x3c/table>","matched":true,"name":"Init","shortdoc":"``screenshot_module`` specifies the module or tool to use when taking screenshots using this library. If no tool or module is specified, ``mss`` will be used by default. For running on Linux with VNC, use ``PyGTK``.","tags":[]}],"keywords":[{"args":["path"],"doc":"<p>Sets the directory where screenshots are saved.\x3c/p>\n<p>It is possible to use <code>/\x3c/code> as a path separator in all operating systems. Path to the old directory is returned.\x3c/p>\n<p>The directory can also be set in <a href=\"#Importing\" class=\"name\">importing\x3c/a>.\x3c/p>","matched":true,"name":"Set Screenshot Directory","shortdoc":"Sets the directory where screenshots are saved.","tags":[]},{"args":["name=screenshot","size_percentage=0.5","embed=True","embed_width=800px"],"doc":"<p>Starts the recording of a GIF in the background with the specified <code>name\x3c/code>. The recording can be stopped by calling the <a href=\"#Stop%20Gif%20Recording\" class=\"name\">Stop Gif Recording\x3c/a> keyword.\x3c/p>\n<p><code>name\x3c/code> specifies the name by which the screenshot will be saved.\x3c/p>\n<p><code>size_percentage\x3c/code> is used to reduce the size of the GIFs a resize of the screencaptures. It will specify how much this reduction is with respect to screen resolution. By default this parameter is set to resize the images to 0.5 of the screen resolution.\x3c/p>\n<p><code>embed\x3c/code> specifies if the screenshot should be embedded in the log file or not. See <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments\x3c/a> section for more details.\x3c/p>\n<p><code>embed_width\x3c/code> specifies the size of the screenshot that is embedded in the log file.\x3c/p>\n<p>Examples:\x3c/p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Gif%20Recording\" class=\"name\">Start Gif Recording\x3c/a>\x3c/td>\n<td>\x3c/td>\n<td># Starts the GIF recording in background\x3c/td>\n\x3c/tr>\n<tr>\n<td><span class=\"name\">Sleep\x3c/span>\x3c/td>\n<td>10 seconds\x3c/td>\n<td># Here should be the actions that will be recorded\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Stop%20Gif%20Recording\" class=\"name\">Stop Gif Recording\x3c/a>\x3c/td>\n<td>\x3c/td>\n<td># Will create the GIF containing the screen recording         since <a href=\"#Start%20Gif%20Recording\" class=\"name\">Start Gif Recording\x3c/a> was called.\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p><b>Note:\x3c/b> Recommended GIF duration is 100 seconds or lower depending on system memory.\x3c/p>","matched":true,"name":"Start Gif Recording","shortdoc":"Starts the recording of a GIF in the background with the specified ``name``. The recording can be stopped by calling the `Stop Gif Recording` keyword.","tags":[]},{"args":["name=recording","fps=8","embed=True","embed_width=800px"],"doc":"<p>Starts the recording of a video in the background with the specified <code>name\x3c/code>. The recording can be stopped by calling the <a href=\"#Stop%20Video%20Recording\" class=\"name\">Stop Video Recording\x3c/a> keyword.\x3c/p>\n<p><code>name\x3c/code> specifies the name by which the record will be saved.\x3c/p>\n<p><code>fps\x3c/code> specifies the frame rate at which the video is displayed. By default frame rate is 8.\x3c/p>\n<p><code>embed\x3c/code> specifies if the record should be embedded in the log file or not. See <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments\x3c/a> section for more details.\x3c/p>\n<p><code>embed_width\x3c/code> specifies the size of the video record that is embedded in the log file.\x3c/p>\n<p>Examples:\x3c/p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Start%20Video%20Recording\" class=\"name\">Start Video Recording\x3c/a>\x3c/td>\n<td>\x3c/td>\n<td># Starts the video recording in background\x3c/td>\n\x3c/tr>\n<tr>\n<td><span class=\"name\">Sleep\x3c/span>\x3c/td>\n<td>10 seconds\x3c/td>\n<td># Here should be the actions that will be recorded\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Stop%20Video%20Recording\" class=\"name\">Stop Video Recording\x3c/a>\x3c/td>\n<td>\x3c/td>\n<td># Will create the video containing the screen recording         since <a href=\"#Start%20Video%20Recording\" class=\"name\">Start Video Recording\x3c/a> was called.\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p><b>Note:\x3c/b> Be aware that during recording the number of the collected frames are dependent on the performance of your system. Check different values for <code>fps\x3c/code> to find optimal results. (e.g. for a 15 seconds recording the output might be a 2 second video with 30 fps).\x3c/p>","matched":true,"name":"Start Video Recording","shortdoc":"Starts the recording of a video in the background with the specified ``name``. The recording can be stopped by calling the `Stop Video Recording` keyword.","tags":[]},{"args":[],"doc":"<p>Stops the GIF recording and generates the file. If <code>embed\x3c/code> argument was set to <code>True\x3c/code> the GIF will be displayed in the log file.\x3c/p>","matched":true,"name":"Stop Gif Recording","shortdoc":"Stops the GIF recording and generates the file. If ``embed`` argument was set to ``True`` the GIF will be displayed in the log file.","tags":[]},{"args":[],"doc":"<p>Stops the video recording and generates the file in WebM format. If <code>embed\x3c/code> argument was set to <code>True\x3c/code> the video will be displayed in the log file.\x3c/p>","matched":true,"name":"Stop Video Recording","shortdoc":"Stops the video recording and generates the file in WebM format. If ``embed`` argument was set to ``True`` the video will be displayed in the log file.","tags":[]},{"args":["name=screenshot","format=None","quality=None","screenshot_number=2","delay_time=0"],"doc":"<p>Takes the specified number of screenshots in the specified format at library import and embeds it into the log file (PNG by default).\x3c/p>\n<p>This keyword is similar with <a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a> but has some extra parameters listed below:\x3c/p>\n<p><code>screenshot_number\x3c/code> specifies the number of screenshots to be taken. By default this number is 2.\x3c/p>\n<p><code>delay_time\x3c/code> specifies the waiting time before taking another screenshot. See <a href=\"#Time%20format\" class=\"name\">Time format\x3c/a> section for more information. By default the delay time is 0.\x3c/p>","matched":true,"name":"Take Multiple Screenshots","shortdoc":"Takes the specified number of screenshots in the specified format at library import and embeds it into the log file (PNG by default).","tags":[]},{"args":["name=screenshot","format=None","quality=None","left=0","top=0","width=700","height=300","embed=True","embed_width=800px"],"doc":"<p>Takes a partial screenshot in the specified format and dimensions at library import and embeds it into the log file (PNG by default).\x3c/p>\n<p>This keyword is similar with <a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a> but has some extra parameters listed below:.\x3c/p>\n<p><code>left\x3c/code> specifies the cropping distance on the X axis from the left of the screen capture.\x3c/p>\n<p><code>top\x3c/code> specifies the cropping distance on the Y axis from the top of the screen capture.\x3c/p>\n<p><code>width\x3c/code> specifies the width of a screen capture when using partial screen captures.\x3c/p>\n<p><code>height\x3c/code> specifies the height of a screen capture when using partial screen captures.\x3c/p>\n<p><code>embed\x3c/code> specifies if the screenshot should be embedded in the log file or not. See <a href=\"#Boolean%20arguments\" class=\"name\">Boolean arguments\x3c/a> section for more details.\x3c/p>\n<p><code>embed_width\x3c/code> specifies the size of the screenshot that is embedded in the log file.\x3c/p>","matched":true,"name":"Take Partial Screenshot","shortdoc":"Takes a partial screenshot in the specified format and dimensions at library import and embeds it into the log file (PNG by default).","tags":[]},{"args":["name=screenshot","format=None","quality=None","width=800px","delay=0"],"doc":"<p>Takes a screenshot in the specified format at library import and embeds it into the log file (PNG by default).\x3c/p>\n<p>Name of the file where the screenshot is stored is derived from the given <code>name\x3c/code>. If the <code>name\x3c/code> ends with extension <code>.jpg\x3c/code>, <code>.jpeg\x3c/code>, <code>.png\x3c/code> or <code>.webp\x3c/code>, the screenshot will be stored with that exact name. Otherwise a unique name is created by adding an underscore, a running index and an extension to the <code>name\x3c/code>.\x3c/p>\n<p>The name will be interpreted to be relative to the directory where the log file is written. It is also possible to use absolute paths. Using <code>/\x3c/code> as a path separator works in all operating systems.\x3c/p>\n<p><code>format\x3c/code> specifies the format in which the screenshot is saved. If no format is provided the library import value will be used which is <code>png\x3c/code> by default. Can be either <code>jpg\x3c/code>, <code>jpeg\x3c/code>, <code>png\x3c/code>, or <code>webp\x3c/code>, case insensitive.\x3c/p>\n<p><code>quality\x3c/code> can take values in range [0, 100]. In case of JPEG format it can drastically reduce the file size of the image.\x3c/p>\n<p><code>width\x3c/code> specifies the size of the screenshot in the log file.\x3c/p>\n<p><code>delay\x3c/code> specifies the waiting time before taking a screenshot. See <a href=\"#Time%20format\" class=\"name\">Time format\x3c/a> section for more information. By default the delay is 0.\x3c/p>\n<p>Examples: (LOGDIR is determined automatically by the library)\x3c/p>\n<table border=\"1\">\n<tr>\n<td><a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a>\x3c/td>\n<td>\x3c/td>\n<td>\x3c/td>\n<td># LOGDIR/screenshot_1.png (index automatically incremented)\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a>\x3c/td>\n<td>mypic\x3c/td>\n<td>\x3c/td>\n<td># LOGDIR/mypic_1.png (index automatically incremented)\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a>\x3c/td>\n<td>${TEMPDIR}/mypic\x3c/td>\n<td>\x3c/td>\n<td># /tmp/mypic_1.png (index automatically incremented)\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a>\x3c/td>\n<td>pic.jpg\x3c/td>\n<td>\x3c/td>\n<td># LOGDIR/pic.jpg (always uses this file)\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a>\x3c/td>\n<td>images/login.jpg\x3c/td>\n<td>300px\x3c/td>\n<td># Specify both name and width.\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a>\x3c/td>\n<td>width=550px\x3c/td>\n<td>\x3c/td>\n<td># Specify only width.\x3c/td>\n\x3c/tr>\n<tr>\n<td><a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a>\x3c/td>\n<td>format=jpg\x3c/td>\n<td>quality=15\x3c/td>\n<td># Specify both image format and quality\x3c/td>\n\x3c/tr>\n\x3c/table>\n<p>The path where the screenshot is saved is returned.\x3c/p>","matched":true,"name":"Take Screenshot","shortdoc":"Takes a screenshot in the specified format at library import and embeds it into the log file (PNG by default).","tags":[]},{"args":["name=screenshot","format=None","quality=None","delay=0"],"doc":"<p>Takes a screenshot and links it from the log file. This keyword is otherwise identical to <a href=\"#Take%20Screenshot\" class=\"name\">Take Screenshot\x3c/a> but the saved screenshot is not embedded into the log file. The screenshot is linked so it is nevertheless easily available.\x3c/p>","matched":true,"name":"Take Screenshot Without Embedding","shortdoc":"Takes a screenshot and links it from the log file. This keyword is otherwise identical to `Take Screenshot` but the saved screenshot is not embedded into the log file. The screenshot is linked so it is nevertheless easily available.","tags":[]}],"name":"ScreenCapLibrary","named_args":true,"scope":"test case","version":"1.3.0"};
 </script>
 <title></title>
 </head>
diff --git a/src/ScreenCapLibrary/library.py b/src/ScreenCapLibrary/library.py
index e530d02..caf1350 100644
--- a/src/ScreenCapLibrary/library.py
+++ b/src/ScreenCapLibrary/library.py
@@ -284,7 +284,7 @@ def start_video_recording(self, name="recording", fps=8, embed=True, embed_width
         since `Start Video Recording` was called. |
 
         *Note:* Be aware that during recording the number of the collected frames are dependent on the
-        performance of your system. Check different values for ``fps`` to find optimal results.(e.g.
+        performance of your system. Check different values for ``fps`` to find optimal results. (e.g.
         for a 15 seconds recording the output might be a 2 second video with 30 fps).
         """
         return self._client.start_video_recording(name, fps, embed, embed_width)
diff --git a/src/ScreenCapLibrary/version.py b/src/ScreenCapLibrary/version.py
index 4383cfa..3a45984 100644
--- a/src/ScreenCapLibrary/version.py
+++ b/src/ScreenCapLibrary/version.py
@@ -13,4 +13,4 @@
 #  See the License for the specific language governing permissions and
 #  limitations under the License.
 
-VERSION = '1.3.0rc3.dev1'
+VERSION = '1.3.0'