NXOpen .NET Reference  12.0.0
Public Types | Properties | List of all members
NXOpen.MovieSettingsBuilder Class Reference

This class is the builder for the Movie Settings. More...

Inheritance diagram for NXOpen.MovieSettingsBuilder:
NXOpen.Builder NXOpen.GeometricUtilities.IComponentBuilder

Public Types

enum  CaptureAreaChoices { Graphics, NxWindow, Desktop }
 Indicates the are being recorded in the movie. More...
 
enum  PlaybackSpeedChoices {
  VerySlow, Slow, AsRecorded, Fast,
  VeryFast
}
 Indicates the playback speed of the movie. More...
 

Properties

unsafe
NXOpen.MovieSettingsBuilder.CaptureAreaChoices 
CaptureArea [get, set]
 Returns or sets the area captured for movie creation. More...
 
unsafe string CodecFourcc [get, set]
 Returns or sets the Codec that is used to create the movie. More...
 
unsafe int FramesPerSecond [get, set]
 Returns or sets the frames per second for the movie. More...
 
unsafe
NXOpen.MovieSettingsBuilder.PlaybackSpeedChoices 
PlaybackSpeed [get, set]
 Returns or sets the speed at which the recorded movie is played back. More...
 

Additional Inherited Members

- Public Member Functions inherited from NXOpen.Builder
unsafe NXOpen.NXObject Commit ()
 Commits any edits that have been applied to the builder. More...
 
unsafe void Destroy ()
 Deletes the builder, and cleans up any objects created by the builder. More...
 
unsafe NXOpen.NXObject[] GetCommittedObjects ()
 For builders that create more than one object, this method returns the objects that are created by commit. More...
 
unsafe NXOpen.NXObject GetObject ()
 Returns the object currently being edited by this builder. More...
 
unsafe void ShowResults ()
 Updates the model to reflect the result of an edit to the model for all builders that support showing results. More...
 
unsafe bool Validate ()
 Validate whether the inputs to the component are sufficient for commit to be called. More...
 

Detailed Description

This class is the builder for the Movie Settings.

To create a new instance of this class, use NXOpen.MovieManager.CreateMovieSettingsBuilder

Default values.

Property Value

CaptureArea

Graphics

FramesPerSecond

10

PlaybackSpeed

AsRecorded

Created in NX6.0.0

Member Enumeration Documentation

Indicates the are being recorded in the movie.

Enumerator
Graphics 

Specifies that the NX graphics contents are to be recorded

NxWindow 

Specifies that the NX window contents are to be recorded

Desktop 

Specifies that the Desktop contents are to be recorded

Indicates the playback speed of the movie.

Enumerator
VerySlow 

Specifies very slow playback speed (quarter of record speed)

Slow 

Specifies slow playback speed (half of record speed)

AsRecorded 

Specifies playback speed same as record speed

Fast 

Specifies fast playback speed (twice record speed)

VeryFast 

Specifies very fast playback speed (four times record speed)

Property Documentation

unsafe NXOpen.MovieSettingsBuilder.CaptureAreaChoices NXOpen.MovieSettingsBuilder.CaptureArea
getset

Returns or sets the area captured for movie creation.

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe string NXOpen.MovieSettingsBuilder.CodecFourcc
getset

Returns or sets the Codec that is used to create the movie.

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe int NXOpen.MovieSettingsBuilder.FramesPerSecond
getset

Returns or sets the frames per second for the movie.

This setting dictates the quality of the movie that is created. A smaller value would create a coarse movie with small file size, whereas, a bigger value would create a smooth movie with a big file size

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.

unsafe NXOpen.MovieSettingsBuilder.PlaybackSpeedChoices NXOpen.MovieSettingsBuilder.PlaybackSpeed
getset

Returns or sets the speed at which the recorded movie is played back.

Created in NX6.0.0

License requirements to get this property: None.

License requirements to set this property: None.


The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.