butterflow-ui/docs/html/e151fc72-f3cc-1740-7ea1-73c...

36 lines
18 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<html><head><meta http-equiv="X-UA-Compatible" content="IE=edge" /><link rel="shortcut icon" href="../icons/favicon.ico" /><link rel="stylesheet" type="text/css" href="../styles/branding.css" /><link rel="stylesheet" type="text/css" href="../styles/branding-en-US.css" /><script type="text/javascript" src="../scripts/branding.js"> </script><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>butterflow_ui Namespace</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="butterflow_ui namespace" /><meta name="Microsoft.Help.F1" content="butterflow_ui" /><meta name="Microsoft.Help.Id" content="N:butterflow_ui" /><meta name="Description" content="butterflow-ui is a graphical front end for interacting with the butterflow command line application in Windows." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="butterflow_ui" /><meta name="file" content="e151fc72-f3cc-1740-7ea1-73c21ce1fa93" /><meta name="guid" content="e151fc72-f3cc-1740-7ea1-73c21ce1fa93" /><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-3.5.1.min.js"></script><script type="text/javascript" src="../scripts/branding-Website.js"></script><script type="text/javascript" src="../scripts/clipboard.min.js"></script></head><body onload="OnLoad('cs')"><input type="hidden" id="userDataCache" class="userDataStyle" /><div class="pageHeader" id="PageHeader">A Sandcastle Documented Class Library<form id="SearchForm" method="get" action="#" onsubmit="javascript:TransferToSearchPage(); return false;"><input id="SearchTextBox" type="text" maxlength="200" /><button id="SearchButton" type="submit"></button></form></div><div class="pageBody"><div class="leftNav" id="leftNav"><div id="tocNav"><div class="toclevel0" data-toclevel="0"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/e151fc72-f3cc-1740-7ea1-73c21ce1fa93.htm" title="A Sandcastle Documented Class Library" tocid="roottoc">A Sandcastle Documented Class Library</a></div><div class="toclevel1 current" data-toclevel="1" data-childrenloaded="true"><a class="tocExpanded" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/e151fc72-f3cc-1740-7ea1-73c21ce1fa93.htm" title="butterflow_ui" tocid="e151fc72-f3cc-1740-7ea1-73c21ce1fa93">butterflow_ui</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/4570f55e-9488-16c6-9dab-e11f856874bb.htm" title="AboutWindow Class" tocid="4570f55e-9488-16c6-9dab-e11f856874bb">AboutWindow Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/d15fc1fd-caee-16f8-14ce-9dcc70712385.htm" title="App Class" tocid="d15fc1fd-caee-16f8-14ce-9dcc70712385">App Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/327f2eef-b268-4eee-32e9-6933d366f80c.htm" title="BoolVisibilityConverter Class" tocid="327f2eef-b268-4eee-32e9-6933d366f80c">BoolVisibilityConverter Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/014a2f1b-9848-61b6-74c1-8cfcdc507450.htm" title="ButterflowOption Class" tocid="014a2f1b-9848-61b6-74c1-8cfcdc507450">ButterflowOption Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/c0e400bb-1bb1-4eb0-ec46-a134802bb550.htm" title="ButterflowSubregion Class" tocid="c0e400bb-1bb1-4eb0-ec46-a134802bb550">ButterflowSubregion Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/fbe7965e-3c27-b071-c7cb-326cec0f4597.htm" title="ButterflowWrapper Class" tocid="fbe7965e-3c27-b071-c7cb-326cec0f4597">ButterflowWrapper Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/4f5187fc-d00e-1d7a-87e4-76997d33cde3.htm" title="ButterflowWrapper.ButterflowConsoleOutputArgs Class" tocid="4f5187fc-d00e-1d7a-87e4-76997d33cde3">ButterflowWrapper.ButterflowConsoleOutputArgs Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/b7ddfb89-7ada-9d58-62a8-12bfdd86f8b6.htm" title="ButterflowWrapper.ButterflowExitArgs Class" tocid="b7ddfb89-7ada-9d58-62a8-12bfdd86f8b6">ButterflowWrapper.ButterflowExitArgs Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/66e690de-9367-e42a-b964-af247afae7ff.htm" title="ButterflowWrapper.ButterflowOutputArgs Class" tocid="66e690de-9367-e42a-b964-af247afae7ff">ButterflowWrapper.ButterflowOutputArgs Class</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/4d847e66-a863-43bf-dbdb-3a98d55468b9.htm" title="ButterflowWrapper.ButterflowOutputType Enumeration" tocid="4d847e66-a863-43bf-dbdb-3a98d55468b9">ButterflowWrapper.ButterflowOutputType Enumeration</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/dede81d0-e317-bc55-5d70-fda170fdee9e.htm" title="FlowFilterType Enumeration" tocid="dede81d0-e317-bc55-5d70-fda170fdee9e">FlowFilterType Enumeration</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/571e5a65-b19d-80a7-fc52-e02575182e64.htm" title="InverseBoolConverter Class" tocid="571e5a65-b19d-80a7-fc52-e02575182e64">InverseBoolConverter Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/58dd4a01-cfc7-3be7-f8bd-0322141b67a4.htm" title="InverseBoolVisibilityConverter Class" tocid="58dd4a01-cfc7-3be7-f8bd-0322141b67a4">InverseBoolVisibilityConverter Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/7ae7656b-c378-ab3d-9af4-1be26a4a3904.htm" title="MainWindow Class" tocid="7ae7656b-c378-ab3d-9af4-1be26a4a3904">MainWindow Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/ac7c7b24-67c3-f7af-424b-f20e3851990c.htm" title="OctokitWrapper Class" tocid="ac7c7b24-67c3-f7af-424b-f20e3851990c">OctokitWrapper Class</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/6e73df0d-d25c-dd42-81f3-b831e79561d6.htm" title="OctokitWrapper.VersionStatus Enumeration" tocid="6e73df0d-d25c-dd42-81f3-b831e79561d6">OctokitWrapper.VersionStatus Enumeration</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/8b6c756f-d88d-a439-ae46-36933c20e4cc.htm" title="OptionsConfiguration Class" tocid="8b6c756f-d88d-a439-ae46-36933c20e4cc">OptionsConfiguration Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/b6d681cc-0a33-4090-fc85-261516d0a18b.htm" title="OptionsConfigurationFile Class" tocid="b6d681cc-0a33-4090-fc85-261516d0a18b">OptionsConfigurationFile Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/40aedc8a-3b6a-2a82-5d77-e3558e9efaab.htm" title="OptionsWindow Class" tocid="40aedc8a-3b6a-2a82-5d77-e3558e9efaab">OptionsWindow Class</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/229e6869-f14d-a176-5ac6-d0d28dc43a71.htm" title="PropertyChangedAlerter Class" tocid="229e6869-f14d-a176-5ac6-d0d28dc43a71">PropertyChangedAlerter Class</a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/4e076ed3-56c3-9ed7-43ef-41dd0c624aa7.htm" title="RegionType Enumeration" tocid="4e076ed3-56c3-9ed7-43ef-41dd0c624aa7">RegionType Enumeration</a></div></div><div id="tocResizableEW" onmousedown="OnMouseDown(event);"></div><div id="TocResize" class="tocResize"><img id="ResizeImageIncrease" src="../icons/TocOpen.gif" onclick="OnIncreaseToc()" alt="Click or drag to resize" title="Click or drag to resize" /><img id="ResizeImageReset" src="../icons/TocClose.gif" style="display:none" onclick="OnResetToc()" alt="Click or drag to resize" title="Click or drag to resize" /></div></div><div class="topicContent" id="TopicContent"><table class="titleTable"><tr><td class="titleColumn"><h1>butterflow_ui Namespace</h1></td></tr></table><span class="introStyle"></span> <div class="summary">butterflow-ui is a graphical front end for interacting with the butterflow command line application in Windows.</div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID0RB')" onkeypress="SectionExpandCollapse_CheckKey('ID0RB', event)" tabindex="0"><img id="ID0RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Classes</span></div><div id="ID0RBSection" class="collapsibleSection"><table class="members" id="classList"><tr><th class="iconColumn">
 
</th><th>Class</th><th>Description</th></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="4570f55e-9488-16c6-9dab-e11f856874bb.htm">AboutWindow</a></td><td><div class="summary">
Interaction logic for AboutWindow.xaml
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="d15fc1fd-caee-16f8-14ce-9dcc70712385.htm">App</a></td><td><div class="summary">
Interaction logic for App.xaml
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="327f2eef-b268-4eee-32e9-6933d366f80c.htm">BoolVisibilityConverter</a></td><td><div class="summary"> A visibility converter. </div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="014a2f1b-9848-61b6-74c1-8cfcdc507450.htm">ButterflowOption</a></td><td><div class="summary"> A butterflowUI option. Contains layout information for use in butterflowUI. </div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="c0e400bb-1bb1-4eb0-ec46-a134802bb550.htm">ButterflowSubregion</a></td><td><div class="summary"> A butterflow video subregion. Represents a snippet of a video on which butterflow will act. </div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="fbe7965e-3c27-b071-c7cb-326cec0f4597.htm">ButterflowWrapper</a></td><td><div class="summary"> A butterflow wrapper. Provides interaction with the butterflow executable. </div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="4f5187fc-d00e-1d7a-87e4-76997d33cde3.htm">ButterflowWrapper<span id="LST612BD3D7_0"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST612BD3D7_0?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ButterflowConsoleOutputArgs</a></td><td><div class="summary"> Arguments for butterflow console output events. </div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="b7ddfb89-7ada-9d58-62a8-12bfdd86f8b6.htm">ButterflowWrapper<span id="LST612BD3D7_1"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST612BD3D7_1?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ButterflowExitArgs</a></td><td><div class="summary"> Arguments for butterflow exiting. </div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="66e690de-9367-e42a-b964-af247afae7ff.htm">ButterflowWrapper<span id="LST612BD3D7_2"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST612BD3D7_2?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ButterflowOutputArgs</a></td><td><div class="summary"> Arguments for butterflow output events where a known value of type can be parsed. </div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="571e5a65-b19d-80a7-fc52-e02575182e64.htm">InverseBoolConverter</a></td><td><div class="summary"> An inverse boolean converter. </div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="58dd4a01-cfc7-3be7-f8bd-0322141b67a4.htm">InverseBoolVisibilityConverter</a></td><td><div class="summary"> An inverse bool visibility converter. </div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="7ae7656b-c378-ab3d-9af4-1be26a4a3904.htm">MainWindow</a></td><td><div class="summary">
Interaction logic for MainWindow.xaml
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="ac7c7b24-67c3-f7af-424b-f20e3851990c.htm">OctokitWrapper</a></td><td><div class="summary">
An wrapper for the Octokit.net class. This class is used to extract functionality for
checking github for updates to butterflow-ui installation.
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="8b6c756f-d88d-a439-ae46-36933c20e4cc.htm">OptionsConfiguration</a></td><td><div class="summary"> The butterflow options configuration. Contians all the options necessary to run butterflow and process a video. </div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="b6d681cc-0a33-4090-fc85-261516d0a18b.htm">OptionsConfigurationFile</a></td><td><div class="summary"> An options configuration file. This class is used to serialize out the configuration to a file. </div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="40aedc8a-3b6a-2a82-5d77-e3558e9efaab.htm">OptionsWindow</a></td><td><div class="summary">
Interaction logic for OptionsWindow.xaml
</div></td></tr><tr data="class; public"><td><img src="../icons/pubclass.gif" alt="Public class" title="Public class" /></td><td><a href="229e6869-f14d-a176-5ac6-d0d28dc43a71.htm">PropertyChangedAlerter</a></td><td><div class="summary"> A class responsible for implementing the <a href="https://docs.microsoft.com/dotnet/api/system.componentmodel.inotifypropertychanged" target="_blank" rel="noopener noreferrer">INotifyPropertyChanged</a> interface and helper functions. </div></td></tr></table></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID1RB')" onkeypress="SectionExpandCollapse_CheckKey('ID1RB', event)" tabindex="0"><img id="ID1RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Enumerations</span></div><div id="ID1RBSection" class="collapsibleSection"><table class="members" id="enumerationList"><tr><th class="iconColumn">
 
</th><th>Enumeration</th><th>Description</th></tr><tr data="enumeration; public"><td><img src="../icons/pubenumeration.gif" alt="Public enumeration" title="Public enumeration" /></td><td><a href="4d847e66-a863-43bf-dbdb-3a98d55468b9.htm">ButterflowWrapper<span id="LST612BD3D7_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST612BD3D7_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ButterflowOutputType</a></td><td><div class="summary"> Values that represent butterflow output types. </div></td></tr><tr data="enumeration; public"><td><img src="../icons/pubenumeration.gif" alt="Public enumeration" title="Public enumeration" /></td><td><a href="dede81d0-e317-bc55-5d70-fda170fdee9e.htm">FlowFilterType</a></td><td><div class="summary"> Values that represent a flow filter type used for optical flow calculations. </div></td></tr><tr data="enumeration; public"><td><img src="../icons/pubenumeration.gif" alt="Public enumeration" title="Public enumeration" /></td><td><a href="6e73df0d-d25c-dd42-81f3-b831e79561d6.htm">OctokitWrapper<span id="LST612BD3D7_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST612BD3D7_4?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>VersionStatus</a></td><td><div class="summary"> Values that represent version status of the current installation of butterflow-ui. </div></td></tr><tr data="enumeration; public"><td><img src="../icons/pubenumeration.gif" alt="Public enumeration" title="Public enumeration" /></td><td><a href="4e076ed3-56c3-9ed7-43ef-41dd0c624aa7.htm">RegionType</a></td><td><div class="summary"> Values that represent subregion types. </div></td></tr></table></div></div></div><div id="pageFooter" class="pageFooter"> </div><script type="text/javascript">
var _paq = window._paq = window._paq || [];
/* tracker methods like "setCustomDimension" should be called before "trackPageView" */
_paq.push(['trackPageView']);
_paq.push(['enableLinkTracking']);
(function() {
var u="//t.thebreadsticks.com/";
_paq.push(['setTrackerUrl', u+'js/']);
_paq.push(['setSiteId', '6']);
var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0];
g.type='text/javascript'; g.async=true; g.src=u+'js/'; s.parentNode.insertBefore(g,s);
})();
</script></body><script type="text/javascript">
<!--
var tocNav = document.getElementById("tocNav");
var anchor = tocNav.children[0].children[0];
Toggle(anchor);
tocNav.children[0].className += " current";
-->
</script>
</html>