A Sandcastle Documented Class Library
A Sandcastle Documented Class Library
butterflow_ui
OptionsConfiguration Class
OptionsConfiguration Constructor
OptionsConfiguration Constructor
OptionsConfiguration Properties
OptionsConfiguration Methods
OptionsConfiguration Events
OptionsConfiguration Fields

# OptionsConfiguration Class

The butterflow options configuration. Contians all the options necessary to run butterflow and process a video.
Inheritance Hierarchy
System
Object
butterflow_ui
PropertyChangedAlerter
butterflow_ui
OptionsConfiguration

Namespace: butterflow_ui
Assembly: butterflow-ui (in butterflow-ui.exe) Version: 1.1.0.42906 (1.0.0.0)
Syntax
C#
Copy

    public class OptionsConfiguration : PropertyChangedAlerter

The OptionsConfiguration type exposes the following members.

Constructors

| Name | Description
--- | --- | ---
| OptionsConfiguration |
| OptionsConfiguration | Default constructor.

Top
Properties

| Name | Description
--- | --- | ---
| CommandLineOutput | Gets the command line output given the current configuration.
| FastPyramid | Gets or sets a value indicating whether to use fast pyramids.
| FlowFilterType | Gets or sets the type of the flow filter used for optical flow calculations.
| Height | Gets or sets the height of the video output.
| Iterations | Gets or sets the number of iterations at each pyramid level.
| KeepAudio | Gets or sets a value indicating whether the keep audio.
| KeepSubregions | Gets or sets a value indicating whether the keep subregions that are not explicitly specified.
| Levels | Gets or sets the number of pyramid layers.
| LockAspectRatio | Gets or sets a value indicating whether to lock aspect ratio of the video.
| LosslessQuality | Gets or sets a value indicating whether the result is rendered in lossless quality.
| MultipleFiles | Gets a value indicating whether butterflow will process multiple files.
| PixelNeighborhood | Gets or sets the size of the pixel neighborhood.
| PlaybackRate | Gets or sets the playback rate.
| PyramidScale | Gets or sets the pyramid scale factor.
| SmoothDerivativeStandardDeviation | Gets or sets the standard deviation of smooth derivatives.
| SmoothMotion | Gets or sets a value indicating whether the butterflow should be turned toward smooth motion.
| Subregions | Gets or sets the subregions of the video on which to work.
| VideoInput | Gets or sets the video input file path.
| VideoOutput | Gets or sets the video output file path.
| Width | Gets or sets the width of the video output.
| WindowSize | Gets or sets the size of the windowing average.

Top
Methods

| Name | Description
--- | --- | ---
| AddConstantCallProperty | Adds a property that will always be called when any property is updated.. (Inherited from PropertyChangedAlerter.)
| ForceUpdate | Force the object's properties to report as updated.
| LoadFile | Loads an option configuration file's contents into the .
| OnAllPropertiesChanged | Executes when all properties are changed and should be updated. (Inherited from PropertyChangedAlerter.)
| OnPropertyChanged | Executes the property changed action. This alerts subscribers to its change in value. (Inherited from PropertyChangedAlerter.)
| SubregionPropertyChanged | Subregion property changed.
| Subregions_CollectionChanged | Event handler. Called by Subregions for collection changed events.
| ToButterflowArguments | Converts this object to a butterflow options.
| ToFile | Converts this object to a .
| ToString | Returns a string that represents the current object. (Overrides Object ToString .)

Top
Events

| Name | Description
--- | --- | ---
| PropertyChanged | Occurs when a property value changes. (Inherited from PropertyChangedAlerter.)

Top
Fields

| Name | Description
--- | --- | ---
| alwaysCall | A list of properties to always call as updated. Generally used for composite properties. (Inherited from PropertyChangedAlerter.)
| aspectRatio | The aspect ratio used for calculating heights when the aspect ratio is locked.
| DEFAULT_FLOW_FILTER_TYPE | The default flow filter type setting.
| DEFAULT_ITERATIONS | The default iterations setting.
| DEFAULT_LEVELS | The default levels setting.
| DEFAULT_PIXEL_NEIGHBORHOOD | The default pixel neighborhood setting.
| DEFAULT_PYRAMID_SCALE | The default pyramid scale setting.
| DEFAULT_SMOOTH_DERIVATIVE_STANDARD_DEVIATION | The default smooth derivative standard deviation setting.
| DEFAULT_WINDOW_SIZE | The default window size setting.
| fastPyramid | A value indicating whether or not to use fast pyramids when processing a video.
| flowFilterType | Type of the flow filter to use for processing.
| height | The height of the output video.
| interpreter | An input interpreter used for converting string values to numeric values.
| iterations | The number of iterations per pyramid level.
| keepAudio | A value indicating whether or not to keep the original audio in the final video.
| keepSubregions | A value indicating whether or not to render unspecified subregions.
| levels | The level size setting.
| lockAspectRatio | A value indicating whether or not to lock the aspect ratio to the of the video.
| losslessQuality | A value indicating whether or not to render the final video with lossless quality.
| OUTPUT_FILE_FORMAT | The output file format when operating on more than one video.
| pixelNeighborhood | The size of pixel neighborhood.
| playbackRate | The playback rate.
| pyramidScale | The pyramid scale setting.
| smoothDerivativeStandardDeviation | The standard deviation of smooth derivatives
| smoothMotion | A value indicating whether or not to tune processing for smooth motion.
| subregions | The subregions of the video on which to process.
| videoInput | The video input files.
| videoOutput | The video output file.
| width | The width of the output video.
| windowSize | Size of the windowing average.

Top
See Also

#### Reference

butterflow_ui Namespace