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/8b6c756f-d88d-a439-ae46-36933c20e4cc.htm

21 lines
32 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>OptionsConfiguration Class</title><meta name="Language" content="en-us" /><meta name="System.Keywords" content="OptionsConfiguration class" /><meta name="System.Keywords" content="butterflow_ui.OptionsConfiguration class" /><meta name="Microsoft.Help.F1" content="butterflow_ui.OptionsConfiguration" /><meta name="Microsoft.Help.Id" content="T:butterflow_ui.OptionsConfiguration" /><meta name="Description" content="The butterflow options configuration. Contians all the options necessary to run butterflow and process a video." /><meta name="Microsoft.Help.ContentType" content="Reference" /><meta name="BrandingAware" content="true" /><meta name="container" content="butterflow_ui" /><meta name="file" content="8b6c756f-d88d-a439-ae46-36933c20e4cc" /><meta name="guid" content="8b6c756f-d88d-a439-ae46-36933c20e4cc" /><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/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 data-tochassubtree="false" href="../html/4b292151-5a2e-cea1-2368-802e23b5bb6f.htm" title="OptionsConfiguration Constructor " tocid="4b292151-5a2e-cea1-2368-802e23b5bb6f">OptionsConfiguration Constructor </a></div><div class="toclevel2" data-toclevel="2"><a data-tochassubtree="false" href="../html/09c4fb13-1283-2577-67f6-743c466a6f4b.htm" title="OptionsConfiguration Constructor " tocid="09c4fb13-1283-2577-67f6-743c466a6f4b">OptionsConfiguration Constructor </a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="../html/967fbfe1-1e06-96ce-2a6e-e86982fb6935.htm" title="OptionsConfiguration Properties" tocid="967fbfe1-1e06-96ce-2a6e-e86982fb6935">OptionsConfiguration Properties</a></div><div class="toclevel2" data-toclevel="2"><a class="tocCollapsed" onclick="javascript: Toggle(this);" href="#!" /><a data-tochassubtree="true" href="..
<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">OptionsConfiguration</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">OptionsConfiguration</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">OptionsConfiguration</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">OptionsConfiguration</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">OptionsConfiguration</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="private;static;declared;notNetfw;"><td><img src="../icons/privmethod.gif" alt="Private method" title="Private method" /><img src="../icons/static.gif" alt="Static member" title="Static member" /></td><td><a href="09c4fb13-1283-2577-67f6-743c466a6f4b.htm">OptionsConfiguration</a></td><td /></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="4b292151-5a2e-cea1-2368-802e23b5bb6f.htm">OptionsConfiguration</a></td><td><div class="summary"> Default constructor. </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="2ab1f69f-ff78-6e57-8ade-6ffd38070087.htm">CommandLineOutput</a></td><td><div class="summary"> Gets the command line output given the current configuration. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="ba5c0673-a02d-29fa-7793-d9bf04419d1d.htm">FastPyramid</a></td><td><div class="summary"> Gets or sets a value indicating whether to use fast pyramids. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="985d56af-6017-1462-1514-a6feafcdacf2.htm">FlowFilterType</a></td><td><div class="summary"> Gets or sets the type of the flow filter used for optical flow calculations. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="a19a2cc9-fd1f-8d1c-3e6f-65659578614b.htm">Height</a></td><td><div class="summary"> Gets or sets the height of the video output. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="6d65e6c5-10c3-49cb-7bad-c793d2f39e0c.htm">Iterations</a></td><td><div class="summary"> Gets or sets the number of iterations at each pyramid level. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="9d4cfded-177b-abdb-a75e-849e62dc9562.htm">KeepAudio</a></td><td><div class="summary"> Gets or sets a value indicating whether the keep audio. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="e99b3cdc-fb52-cc06-9656-0afa4d9f847d.htm">KeepSubregions</a></td><td><div class="summary"> Gets or sets a value indicating whether the keep subregions that are not explicitly specified. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="68ef1656-e3cc-1ad4-094e-267dcdb43182.htm">Levels</a></td><td><div class="summary"> Gets or sets the number of pyramid layers. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="6a62b320-0dc7-5c55-5fc1-7960ce031f08.htm">LockAspectRatio</a></td><td><div class="summary"> Gets or sets a value indicating whether to lock aspect ratio of the video. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="73a52eb1-4244-8eb1-e3c0-31fa95ca7595.htm">LosslessQuality</a></td><td><div class="summary"> Gets or sets a value indicating whether the result is rendered in lossless quality. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="54ad7414-0302-6706-ed2d-640fba85f6c9.htm">PixelNeighborhood</a></td><td><div class="summary"> Gets or sets the size of the pixel neighborhood. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="543c18ec-e299-2053-3100-3b5d56c488b4.htm">PlaybackRate</a></td><td><div class="summary"> Gets or sets the playback rate. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubproperty.gif" alt="Public property" title="Public property" /></td><td><a href="dab6a385-86c3-93b9-70c4-0a46f5f2f148.htm">PyramidScale</a></td><td><div class="summary"> Gets or sets the pyramid scale factor. </div></td></tr><tr data="public;declared;notNetfw;"><t
 
</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="2d21bf05-43bf-5769-f8b1-3110b7683cee.htm">LoadFile</a></td><td><div class="summary"> Loads an option configuration file's contents into the . </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="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="623ea212-0570-afa3-41f1-cfc51bd295a4.htm">SubregionPropertyChanged</a></td><td /></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privmethod.gif" alt="Private method" title="Private method" /></td><td><a href="d2133235-452c-bdf9-0999-1a5e0341c18a.htm">Subregions_CollectionChanged</a></td><td><div class="summary"> Event handler. Called by Subregions for collection changed 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="33bad8a9-ff3b-c7f3-f9d4-864c25e77217.htm">ToButterflowArguments</a></td><td><div class="summary"> Converts this object to a butterflow options. </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="e34f04fb-f23f-b33a-2c7b-fd1d7c590626.htm">ToFile</a></td><td><div class="summary"> Converts this object to a . </div></td></tr><tr data="public;declared;notNetfw;"><td><img src="../icons/pubmethod.gif" alt="Public method" title="Public method" /></td><td><a href="e973f29c-14ab-597d-a4b5-2003d9caee33.htm">ToString</a></td><td><div class="summary"> Returns a string that represents the current object. </div> (Overrides <a href="http://msdn2.microsoft.com/en-us/library/7bxwbwt2" target="_blank">Object<span id="LST7E9ECD99_3"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST7E9ECD99_3?cs=.|vb=.|cpp=::|nu=.|fs=.");</script>ToString<span id="LST7E9ECD99_4"></span><script type="text/javascript">AddLanguageSpecificTextSet("LST7E9ECD99_4?cs=()|vb=|cpp=()|nu=()|fs=()");</script></a>.)</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;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="f4f5eab8-72e8-9ffd-f024-ac667450f2cb.htm">aspectRatio</a></td><td><div class="summary"> The aspect ratio used for calculating heights when the aspect ratio is locked. </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="829c1e85-9830-0ade-d7c3-01105c20e9d4.htm">DEFAULT_FLOW_FILTER_TYPE</a></td><td><div class="summary"> The default flow filter type setting. </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="78d5bca2-0453-b125-ea2e-fdc7a659b475.htm">DEFAULT_ITERATIONS</a></td><td><div class="summary"> The default iterations setting. </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="499ad123-ec06-695b-086c-6938ee390049.htm">DEFAULT_LEVELS</a></td><td><div class="summary"> The default levels setting. </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="6007c2d4-a94e-42c7-f177-546650644dcf.htm">DEFAULT_PIXEL_NEIGHBORHOOD</a></td><td><div class="summary"> The default pixel neighborhood setting. </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="64ab9fdd-f9a8-68c2-7601-b3d3992ca4d4.htm">DEFAULT_PYRAMID_SCALE</a></td><td><div class="summary"> The default pyramid scale setting. </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="8934d9cd-66af-199f-37f7-31215fe45287.htm">DEFAULT_SMOOTH_DERIVATIVE_STANDARD_DEVIATION</a></td><td><div class="summary"> The default smooth derivative standard deviation setting. </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="e3c226ad-4d8b-d51c-eaa8-bf15d240754a.htm">DEFAULT_WINDOW_SIZE</a></td><td><div class="summary"> The default window size setting. </div></td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privfield.gif" alt="Private field" title="Private field" /></td><td><a href="04f213df-d0ce-2a78-bb7d-5fa0e9a78524.htm">fastPyramid</a></td><td><div class="summary"> A value indicating whether or not to use fast pyramids when processing a video. </div></td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/privfield.gif" alt="Private field" title="Private field" /></td><td><a href="7f4cc619-4fcf-6889-67a9-9507e03dc8d8.htm">flowFilterType</a></td><td><div class="summary"> Type of the flow filter to use for processing. </div></td></tr><tr data="private;declared;notNetfw;"><td><img src="../icons/p
Reference in a new issue Copy permalink