mirror of
https://github.com/wagesj45/butterflow-ui.git
synced 2025-08-02 14:38:23 -05:00
Updated documentation.
This commit is contained in:
parent
641ffbd617
commit
0c3921f6b0
289 changed files with 638 additions and 442 deletions
|
|
@ -2,7 +2,7 @@
|
|||
<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="ID1EACA_tab1" class="codeSnippetContainerTabSingle">C#</div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID1EACA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID1EACA');return false;" title="Copy">Copy</a></div></div><div id="ID1EACA_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></div><script type="text/javascript">AddLanguageTabSet("ID1EACA");</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">
|
||||
butterflow-ui (in butterflow-ui.exe) Version: 1.0.2.31734 (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="ID1EACA_tab1" class="codeSnippetContainerTabSingle">C#</div></div><div class="codeSnippetContainerCodeContainer"><div class="codeSnippetToolBar"><div class="codeSnippetToolBarText"><a id="ID1EACA_copyCode" href="#" class="copyCodeSnippet" onclick="javascript:CopyToClipboard('ID1EACA');return false;" title="Copy">Copy</a></div></div><div id="ID1EACA_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></div><script type="text/javascript">AddLanguageTabSet("ID1EACA");</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">
|
||||
|
||||
|
|
@ -13,8 +13,8 @@
|
|||
</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">
|
||||
</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="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="8a2f8de4-a4d7-02a5-2edf-5d86511ecf0c.htm">ProcessQueue</a></td><td><div class="summary"> Process the queue of butterflow arguments. </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> by adding it to the queue. </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> by adding it to the queue. </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="../icons/SectionExpanded.png" />See Also</span></div><div id="ID8RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="e151fc72-f3cc-1740-7ea1-73c21ce1fa93.htm">butterflow_ui Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>
|
||||
</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><tr data="private;declared;notNetfw;"><td><img src="../icons/privfield.gif" alt="Private field" title="Private field" /></td><td><a href="e8746b49-f99f-9eb2-f858-251facee577f.htm">runQueue</a></td><td><div class="summary"> Queue of butterflow commands to run. </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="../icons/SectionExpanded.png" />See Also</span></div><div id="ID8RBSection" class="collapsibleSection"><h4 class="subHeading">Reference</h4><div class="seeAlsoStyle"><a href="e151fc72-f3cc-1740-7ea1-73c21ce1fa93.htm">butterflow_ui Namespace</a></div></div></div></div><div id="pageFooter" class="pageFooter"> </div></body></html>
|
||||
Loading…
Add table
Add a link
Reference in a new issue