wagesj45/butterflow-ui
1
0
Fork 0
mirror of https://github.com/wagesj45/butterflow-ui.git synced 2024-12-22 17:12:42 -06:00
Code Issues Releases Wiki Activity
butterflow-ui/docs/html/fbe7965e-3c27-b071-c7cb-326cec0f4597.htm

24 lines
22 KiB
HTML
Raw Normal View History

Adding generated help documents.
2018-07-09 14:50:36 -05:00
<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>ButterflowWrapper Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="ButterflowWrapper class" /><meta name="System.Keywords" content="butterflow_ui.ButterflowWrapper class" /><meta name="Microsoft.Help.F1" content="butterflow_ui.ButterflowWrapper" /><meta name="Microsoft.Help.Id" content="T:butterflow_ui.ButterflowWrapper" /><meta name="Description" content="A butterflow wrapper. Provides interaction with the butterflow executable." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="butterflow_ui" /><meta name="file" content="fbe7965e-3c27-b071-c7cb-326cec0f4597" /><meta name="guid" content="fbe7965e-3c27-b071-c7cb-326cec0f4597" /><link type="text/css" rel="stylesheet" href="../styles/highlight.css" /><script type="text/javascript" src="../scripts/highlight.js"> </script><link rel="stylesheet" type="text/css" href="../styles/branding-Website.css" /><script type="text/javascript" src="../scripts/jquery-1.11.0.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="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="butterflow_ui" tocid="e151fc72-f3cc-1740-7ea1-73c21ce1fa93">butterflow_ui</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/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 data-tochassubtree="false" href="../html/428e99bd-48ad-4370-5fa4-b32e6271e65c.htm" title="ButterflowWrapper Constructor " tocid="428e99bd-48ad-4370-5fa4-b32e6271e65c">ButterflowWrapper Constructor </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/701a84d3-5bbb-187b-6abe-6e05c0ac26d1.htm" title="ButterflowWrapper Properties" tocid="701a84d3-5bbb-187b-6abe-6e05c0ac26d1">ButterflowWrapper Properties</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/98c35fae-9e4e-225a-03af-5da2f15cccc7.htm" title="ButterflowWrapper Methods" tocid="98c35fae-9e4e-225a-03af-5da2f15cccc7">ButterflowWrapper Methods</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/376543fe-
<strong>Namespace:</strong>
 <a href="e151fc72-f3cc-1740-7ea1-73c21ce1fa93.htm">butterflow_ui</a><br />
<strong>Assembly:</strong>
 butterflow-ui (in butterflow-ui.exe) Version: 1.0.0.0 (1.0.0.0)<div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID2RB')" onkeypress="SectionExpandCollapse_CheckKey('ID2RB', event)" tabindex="0"><img id="ID2RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Syntax</span></div><div id="ID2RBSection" class="collapsibleSection"><div class="codeSnippetContainer"><div class="codeSnippetContainerTabs"><div id="ID1EDCA_tab1" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','cs','1','4');return false;">C#</a></div><div id="ID1EDCA_tab2" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','vb','2','4');return false;">VB</a></div><div id="ID1EDCA_tab3" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','cpp','3','4');return false;">C++</a></div><div id="ID1EDCA_tab4" class="codeSnippetContainerTab"><a href="#" onclick="javascript:ChangeTab('ID1EDCA','fs','4','4');return false;">F#</a></div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID1EDCA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID1EDCA');return false;" title="Copy">Copy</a></div></div><div id="ID1EDCA_code_Div1" class="codeSnippetContainerCode" style="display: block"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">class</span> <span class="identifier">ButterflowWrapper</span> : <span class="identifier">PropertyChangedAlerter</span></pre></div><div id="ID1EDCA_code_Div2" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">Public</span> <span class="keyword">Class</span> <span class="identifier">ButterflowWrapper</span>
<span class="keyword">Inherits</span> <span class="identifier">PropertyChangedAlerter</span></pre></div><div id="ID1EDCA_code_Div3" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">public</span> <span class="keyword">ref class</span> <span class="identifier">ButterflowWrapper</span> : <span class="keyword">public</span> <span class="identifier">PropertyChangedAlerter</span></pre></div><div id="ID1EDCA_code_Div4" class="codeSnippetContainerCode" style="display: none"><pre xml:space="preserve"><span class="keyword">type</span> <span class="identifier">ButterflowWrapper</span> =
<span class="keyword">class</span>
<span class="keyword">inherit</span> <span class="identifier">PropertyChangedAlerter</span>
<span class="keyword">end</span></pre></div></div></div><script type="text/javascript">AddLanguageTabSet("ID1EDCA");</script></div><p>The <span class="selflink">ButterflowWrapper</span> type exposes the following members.</p><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID3RB')" onkeypress="SectionExpandCollapse_CheckKey('ID3RB', event)" tabindex="0"><img id="ID3RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Constructors</span></div><div id="ID3RBSection" class="collapsibleSection"><table class="members" id="constructorList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="428e99bd-48ad-4370-5fa4-b32e6271e65c.htm">ButterflowWrapper</a></td><td><div class="summary">Initializes a new instance of the <span class="selflink">ButterflowWrapper</span> class</div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID4RB')" onkeypress="SectionExpandCollapse_CheckKey('ID4RB', event)" tabindex="0"><img id="ID4RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Properties</span></div><div id="ID4RBSection" class="collapsibleSection"><table class="members" id="propertyList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="b2d0780d-8432-2b78-6b06-76b778c65083.htm">ConsoleOutput</a></td><td><div class="summary"> Gets the console output from butterflow. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="1037f945-7735-af3d-f3dd-f40750e81a2b.htm">IsRunning</a></td><td><div class="summary"> Gets a value indicating whether butterflow is currently running. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="951a287b-c7e8-64f1-f982-bb77d31aba13.htm">ProgressPercentage</a></td><td><div class="summary"> Gets the progress percentage as reported by butterflow. </div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID5RB')" onkeypress="SectionExpandCollapse_CheckKey('ID5RB', event)" tabindex="0"><img id="ID5RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Methods</span></div><div id="ID5RBSection" class="collapsibleSection"><table class="members" id="methodList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="94283020-fd41-a0ab-0e86-5d285dc72cff.htm">AddConstantCallProperty</a></td><td><div class="summary"> Adds a property that will always be called when any property is updated.. </div> (Inherited from <a href="229e6869-f14d-a176-5ac6-d0d28dc43a71.htm">PropertyChangedAlerter</a>.)</td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="4ae309d0-c1b6-0cf8-5c03-ff0ca2ba871c.htm">Cancel</a></td><td><div class="summary"> Kills the running instance of butterflow, cancelling its current operation. </div></td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /></td><td><a href="f4ce3949-e7fd-ce94-51cc-3c3698c097b5.htm">OnAllPropertiesChanged</a></td><td><div class="summary"> Executes when all properties are changed and should be updated. </div> (Inherited from <a href="229e6869-f14d-a176-5ac6-d0d28dc43a71.htm">PropertyChangedAlerter</a>.)</td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privmethod.gif" alt="Private method" title="Private method" /></td><td><a href="c16980db-32b2-dc80-d568-ef30ce3ea3bf.htm">OnParsedConsoleOutputRecieved</a></td><td><div class="summary"> Executes the parsed console output recieved action. </div></td></tr><tr data="protected;inherited;notNetfw;"><td><img src="../icons/protmethod.gif" alt="Protected method" title="Protected method" /><img src="../icons/CodeExample.png" alt="Code example" title="Code example" /></td><td><a href="eedea241-4ddb-bac9-5717-c691ef57e6ea.htm">OnPropertyChanged</a></td><td><div class="summary">
Executes the property changed action. This alerts subscribers to its change in value.
</div> (Inherited from <a href="229e6869-f14d-a176-5ac6-d0d28dc43a71.htm">PropertyChangedAlerter</a>.)</td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privmethod.gif" alt="Private method" title="Private method" /></td><td><a href="a40dbce6-a556-a0b5-a504-e0e6b5f9b2b2.htm">ParseConsoleOutput</a></td><td><div class="summary">
Parses console output and attempts to find known values. If a known value is found, the
event is triggered.
</div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="5f2749a7-c303-eaab-d82d-6b5a5d5957af.htm">Probe</a></td><td><div class="summary"> Probes a video file. </div></td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privmethod.gif" alt="Private method" title="Private method" /></td><td><a href="ecdfd054-a9b2-3571-09c4-a006bae59ed2.htm">Process_Exited</a></td><td><div class="summary"> Event handler. Called by Process for exited events. </div></td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privmethod.gif" alt="Private method" title="Private method" /></td><td><a href="ade5760c-a582-25e6-1253-15bbccd18447.htm">Process_OutputDataReceived</a></td><td><div class="summary"> Event handler. Called by Process for output data received events. </div></td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privmethod.gif" alt="Private method" title="Private method" /></td><td><a href="e76fa5c5-defd-752c-1b7d-1a6e0e849e94.htm">Run(String)</a></td><td><div class="summary"> Runs butterflow with the given <span class="parameter">arguments</span>. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="1970f320-0445-a329-d826-7eb6c236d533.htm">Run(OptionsConfiguration)</a></td><td><div class="summary"> Runs butterflow with the given <span class="parameter">optionsConfiguration</span>. </div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID6RB')" onkeypress="SectionExpandCollapse_CheckKey('ID6RB', event)" tabindex="0"><img id="ID6RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Events</span></div><div id="ID6RBSection" class="collapsibleSection"><table class="members" id="eventList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubevent.gif" alt="Public event" title="Public event" /></td><td><a href="35c52789-71d0-91af-efb7-d7a4618a0278.htm">ParsedConsoleOutputRecieved</a></td><td><div class="summary"> Event queue for all listeners interested in ParsedConsoleOutputRecieved events. </div></td></tr><tr data="public;inherited;notNetfw;"><td><img src="../icons/pubevent.gif" alt="Public event" title="Public event" /></td><td><a href="2bc00061-8840-fad4-50b6-7b7fad95336c.htm">PropertyChanged</a></td><td><div class="summary"> Occurs when a property value changes. </div> (Inherited from <a href="229e6869-f14d-a176-5ac6-d0d28dc43a71.htm">PropertyChangedAlerter</a>.)</td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID7RB')" onkeypress="SectionExpandCollapse_CheckKey('ID7RB', event)" tabindex="0"><img id="ID7RBToggle" class="collapseToggle" src="../icons/SectionExpanded.png" />Fields</span></div><div id="ID7RBSection" class="collapsibleSection"><table class="members" id="fieldList"><tr><th class="iconColumn">
 
</th><th>Name</th><th>Description</th></tr><tr data="private;inherited;notNetfw;"><td><img src="../icons/privfield.gif" alt="Private field" title="Private field" /></td><td><a href="de4e26b6-b925-00d1-b5c8-6cffb5cabf61.htm">alwaysCall</a></td><td><div class="summary"> A list of properties to always call as updated. Generally used for composite properties. </div> (Inherited from <a href="229e6869-f14d-a176-5ac6-d0d28dc43a71.htm">PropertyChangedAlerter</a>.)</td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privfield.gif" alt="Private field" title="Private field" /></td><td><a href="9a3697fc-2123-df08-0328-d113471c80bc.htm">consoleOutput</a></td><td><div class="summary"> The console output from butterflow. </div></td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privfield.gif" alt="Private field" title="Private field" /></td><td><a href="420ffbdc-a962-1e6e-b104-769177739ae5.htm">executablePath</a></td><td><div class="summary"> Full pathname of the butterflow executable file. </div></td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privfield.gif" alt="Private field" title="Private field" /></td><td><a href="a9af32ff-32d5-dd12-872e-a465698e82c7.htm">interpreter</a></td><td><div class="summary"> An input interpreter used for converting string values to numeric values. </div></td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privfield.gif" alt="Private field" title="Private field" /></td><td><a href="b38f4c5c-0a95-5352-c899-243474c8a504.htm">isRunning</a></td><td><div class="summary"> True if butterflow is running, false if not. </div></td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privfield.gif" alt="Private field" title="Private field" /></td><td><a href="45368a3c-9928-e1e7-18d7-b4fae812bfb2.htm">progressPercentage</a></td><td><div class="summary"> The progress percentage as reported by butterflow. </div></td></tr><tr data="private;static;declared;notNetfw;"><td><img src="../icons/privfield.gif" alt="Private field" title="Private field" /><img src="../icons/static.gif" alt="Static member" title="Static member" /></td><td><a href="40585672-9bac-c92d-89fa-e74b2c864a8c.htm">REGEX_PROGRESS</a></td><td><div class="summary"> The RegEx string for detecting progress made when rendering a video. </div></td></tr><tr data="private;static;declared;notNetfw;"><td><img src="../icons/privfield.gif" alt="Private field" title="Private field" /><img src="../icons/static.gif" alt="Static member" title="Static member" /></td><td><a href="f1d7e421-630d-bc87-3272-4e92aecc79e8.htm">REGEX_PROGRESS_ALT</a></td><td><div class="summary"> An alternative RegEx string for detecting progress made when rendering a video. </div></td></tr><tr data="private;static;declared;notNetfw;"><td><img src="../icons/privfield.gif" alt="Private field" title="Private field" /><img src="../icons/static.gif" alt="Static member" title="Static member" /></td><td><a href="0c17e820-04c1-9027-76be-c6efb92e4866.htm">REGEX_RATE</a></td><td><div class="summary"> The RegEx string for matching the probed playback rate. </div></td></tr><tr data="private;static;declared;notNetfw;"><td><img src="../icons/privfield.gif" alt="Private field" title="Private field" /><img src="../icons/static.gif" alt="Static member" title="Static member" /></td><td><a href="80068044-4661-d53c-d40d-056745fc309e.htm">REGEX_RESOLUTION</a></td><td><div class="summary"> The RegEx string for matching probed resolution. </div></td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privfield.gif" alt="Private field" title="Private field" /></td><td><a href="d7727346-f68e-b3e2-a774-7beb9171cc11.htm">runningProcess</a></td><td><div class="summary"> The running butterflow process. </div></td></tr></table><a href="#PageHeader">Top</a></div><div class="collapsibleAreaRegion" id="seeAlsoSection"><span class="collapsibleRegionTitle" onclick="SectionExpandCollapse('ID8RB')" onkeypress="SectionExpandCollapse_CheckKey('ID8RB', event)" tabindex="0"><img id="ID8RBToggle" class="collapseToggle" src="../
Reference in a new issue Copy permalink