__________________________________
Requirements
__________________________________

This sample application is a C# application developed in Microsoft Visual Studio 2012 using .Net 4.5. The application will work with Solid Edge ST8 or later.


__________________________________
Installation
__________________________________

The compiled executable, SolidEdgeMovieRecorder.exe, is dependent on several interop assemblies:
- interop.SolidEdgeAssemblySEMovieRecorder.dll
- interop.SolidEdgeConstantSEMovieRecorder.dll
- interop.SolidEdgeFrameworkSEMovieRecorder.dll

All files required to use the application are delivered in the bin folder of the SolidEdgeMovieRecorder\SolidEdgeMovieRecorder folder.  The interop assemblies are embedded in the executable,
so if you copy the executable to a new location, you shouldn't need to worry about any other files.


__________________________________
Known Limitations
__________________________________

To record a movie using this application, an assembly document must be active. Since the recording API is implemented on the 3D view object, part and sheet documents also support the API, but
this sample only supports assembly documents.


__________________________________
General Usage
__________________________________

SolidEdgeMovieRecorder.exe is a tool, written in C#, that demonstrates the usage of the new animation / movie recording API that was added in ST8. The application is a simple movie recorder that will
record animations running in the animation editor (either in ERA or the Simulate Motor command), the motion in the Drag Component command or both. The movie recorder demonstrates using the recording
API methods added on the view object as well as hooking into the new animation event set and existing application event set.

To record a movie after an assembly document is open, you will need to perform the following steps. First, choose the movie format(WMV is the default). When you choose the movie format, the dialog
controls are updated appropriately for the selected format. Once you have selected a movie format, you can then set the other movie settings such as compression codec as you wish. Once you have set
the desired movie settings, you are now ready to start the recording process. To start the recording process, you simply push the 'Start Recording' button. The application will now listen for the
appropriate animation events (determined by the 'Record Animation Editor motion' and 'Drag Component motion' settings). After the recording process has been started, you simply run the appropriate
Solid Edge functionality to create the animation - use the Animation Editor (in the ERA environment or using the Simulate Motor command) to animate the assembly or use the Drag Component command
to create motion by dragging a component. When you are ready to stop the movie recording process, simply push the 'Stop Recording' button. At this point, the movie file will be finalized on disk. If
the option to play the movie when finished is selected, the movie will now play in the default player for the selected movie format.

__________________________________
Dialog Controls
__________________________________

- Play when finished
        If this setting is selected, the movie will play in the default movie player once the recording process is finished.

- Record Animation Editor motion
        If this setting is selected, the motion from the Animation Editor will be recorded as the timeline is being played. This
        is supported both in the ERA environment and in the Simulate Motor command.
        
- Record Drag Component motion
        If this setting is selected, the motion created by dragging a component will be recorded.
        
- Start Recording
        Starts the movie recording process.
        
- Stop Recording
        Stops the movie recording process. This will finalize the movie file on disk and will play the movie if the 'Play when finished'
        option is selected.
        
- File Name
        Specifies the name for the movie file. The movie is created in the Temp directory by default.
        
- Movie Format
        Specifies the format for the movie. The supported formats are AVI and WMV (the default).
        
- Compression Codec
        This list contains all movie compression codecs available on the user's computer for the selected movie format.
        
- Resolution
        Specifies the resolution for the movie. There are several predefined resolutions or you can use a custom resolution

- Width
        The movie resolution width. Disabled unless using a custom resolution.

- Height
        The movie resolution height. Disabled unless using a custom resolution.
        
- Frame Rate
        The frame rate for the movie in frames per second.
        
- Movie Quality
        The quality of the movie. Must be in the range of 1-100, with 100 being the highest quality with largest file size.
        
- Bit Rate
        The bit rate for the movie. This is only used by WMV movies to tell the compression codec what rate must be maintained when dropping
        frames in order to keep the best quality. A default value is calculated based on standard formulas, so you shouldn't need to
        adjust the value.
        
- Movie Information
        This button will bring up a dialog that will let you populate some of the movie summary information fields such as Title, Author, Copyright, etc.
        This is only supported for WMV movies.