## On this page

  

 

 # ensightservice::AnimSaveRequest Struct Reference

 Last update: 16.07.2025 

## <a id="pub-attribs" name="pub-attribs"></a>Public Attributes

<a id="af913dc443e4fd1144801f856371e8382"></a>string [id](structensightservice_1_1_anim_save_request.xhtml#af913dc443e4fd1144801f856371e8382) = 1 Handle used to query progress or cancel a save. Any unique string, provided by the caller.   
 <a id="aed89c5bf60803520c1913f57fd3f4e24"></a>string [filename](structensightservice_1_1_anim_save_request.xhtml#aed89c5bf60803520c1913f57fd3f4e24) = 2 Name of file to save. Format determined from file extension. Defaults to .mp4 or .png with no file extension. UTF8 encoding. Existing files are overwritten.   
 <a id="a3c8150118e98048a89dfccc01bf425e8"></a>map&lt; string, string &gt; [format\_options](structensightservice_1_1_anim_save_request.xhtml#a3c8150118e98048a89dfccc01bf425e8) = 3 Options specific to certain formats, as (option\_name, value) pairs.   
 <a id="aea93ee30169d4bcf0ec93a8d8b9f4c17"></a>uint32 [width](structensightservice_1_1_anim_save_request.xhtml#aea93ee30169d4bcf0ec93a8d8b9f4c17) = 4 Image width. 0 means current window width.   
 <a id="a8e87977a7346548017e762bec03a735c"></a>uint32 [height](structensightservice_1_1_anim_save_request.xhtml#a8e87977a7346548017e762bec03a735c) = 5 Image height. 0 means current window height.   
 <a id="a44c9d1da2cba6eca416d718bff933721"></a>uint32 [aa\_passes](structensightservice_1_1_anim_save_request.xhtml#a44c9d1da2cba6eca416d718bff933721) = 6 Num anti-aliasing passes. 0 uses EnSight default 4-pass antialiasing.   
 <a id="a0edbc19bd0f34f98ac52b430047e69f1"></a>bool [white\_background](structensightservice_1_1_anim_save_request.xhtml#a0edbc19bd0f34f98ac52b430047e69f1) = 7 If True, set background to white, and change text and misc colors to black as necessary. Restore all, after save. If False, leave all colors as they are.   
 <a id="a60bc3fb7914b4e44127e342d2ec214c9"></a>int32 [start\_frame](structensightservice_1_1_anim_save_request.xhtml#a60bc3fb7914b4e44127e342d2ec214c9) = 8 First frame to save. 0-based. -1 special value that means the current timestep.   
 <a id="af4c8190c87265afdaf18c26a40110016"></a>int32 [num\_frames](structensightservice_1_1_anim_save_request.xhtml#af4c8190c87265afdaf18c26a40110016) = 9 Num frames to save. -1 special value that means all timesteps. num\_frames &gt; num timesteps allows multiple cycles through time.   
 <a id="a3108fd76dfcc451879339f6c99a01ce0"></a>float [fps](structensightservice_1_1_anim_save_request.xhtml#a3108fd76dfcc451879339f6c99a01ce0) = 10 Frames/sec. Ignored if saving an image.   
 <a id="details" name="details"></a>## Detailed Description

Request that an image or animation be saved. If saving an animation, and format is an image format like png, save multiple images and insert an index like "\_0003" into the file name before the extension. If saving one frame in an animation format, a one-frame movie will be written. Valid anim formats: .mp4, .avi, .mov Valid image formats: .png, .tif/.tiff, .jpg/.jpeg, .ppm

Format Option name Value Notes mp4: Quality Best|High|Medium|Low default: High Type 0|1 default: 1 1 for H.264, 0 for non-H.264 avi: Compression MJPEG|RAW|MPEG4V2 default: MPEG4V2 BitRate (a value between 0 and 80000) default: 20000 kbits/sec mov: BitRate (a value between 0 and 80000) default: 20000 kbits/sec png: Compression None|Fast|Best|Default default: Default (zlib compression setting) tif: Compression None|PackBits|Deflate default: PackBits jpg: Quality (a value between 0 and 100) default: 75 ppm: Format Binary|Ascii default: Binary

Definition at line [257](ensight_8proto_source.xhtml#l00257) of file [ensight.proto](ensight_8proto_source.xhtml).



---

The documentation for this struct was generated from the following file:- D:/ANSYSDev/NoBackup/branches/EnSight-Second-Coming/ensight/client/rpc\_interface/[ensight.proto](ensight_8proto_source.xhtml)