MovieSettingsBuilder Class — NXOpen Python API Reference 12.0.0 documentation

# MovieSettingsBuilder Class

class `NXOpen.``MovieSettingsBuilder`

  Bases: `NXOpen.Builder`

  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

  New in version NX6.0.0.

# Properties

Property | Description
--- | ---
CaptureArea | Returns or sets the area captured for movie creation.
CodecFourcc | Returns or sets the Codec that is used to create the movie.
FramesPerSecond | Returns or sets the frames per second for the movie.
PlaybackSpeed | Returns or sets the speed at which the recorded movie is played back.
Tag | Returns the Tag for this object.

# Methods

Method | Description
--- | ---
Commit | Commits any edits that have been applied to the builder.
Destroy | Deletes the builder, and cleans up any objects created by the builder.
GetCommittedObjects | For builders that create more than one object, this method returns the objects that are created by commit.
GetObject | Returns the object currently being edited by this builder.
ShowResults | Updates the model to reflect the result of an edit to the model for all builders that support showing results.
Validate | Validate whether the inputs to the component are sufficient for commit to be called.

# Enumerations

MovieSettingsBuilderCaptureAreaChoices Enumeration | Indicates the are being recorded in the movie.
MovieSettingsBuilderPlaybackSpeedChoices Enumeration | Indicates the playback speed of the movie.

# Property Detail

## CaptureArea

`MovieSettingsBuilder.``CaptureArea`

  Returns or sets the area captured for movie creation.

  `-------------------------------------`

  Getter Method

  Signature `CaptureArea`

  Returns: |
  Return type: | `NXOpen.MovieSettingsBuilderCaptureAreaChoices`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CaptureArea`

  Parameters: | captureArea (`NXOpen.MovieSettingsBuilderCaptureAreaChoices`) –

  New in version NX6.0.0.

  License requirements: None.

## CodecFourcc

`MovieSettingsBuilder.``CodecFourcc`

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

  `-------------------------------------`

  Getter Method

  Signature `CodecFourcc`

  Returns: |
  Return type: | str

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `CodecFourcc`

  Parameters: | codecFourcc (str) –

  New in version NX6.0.0.

  License requirements: None.

## FramesPerSecond

`MovieSettingsBuilder.``FramesPerSecond`

  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

  `-------------------------------------`

  Getter Method

  Signature `FramesPerSecond`

  Returns: |
  Return type: | int

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `FramesPerSecond`

  Parameters: | framesPerSecond (int) –

  New in version NX6.0.0.

  License requirements: None.

## PlaybackSpeed

`MovieSettingsBuilder.``PlaybackSpeed`

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

  `-------------------------------------`

  Getter Method

  Signature `PlaybackSpeed`

  Returns: |
  Return type: | `NXOpen.MovieSettingsBuilderPlaybackSpeedChoices`

  New in version NX6.0.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PlaybackSpeed`

  Parameters: | playbackSpeed (`NXOpen.MovieSettingsBuilderPlaybackSpeedChoices`) –

  New in version NX6.0.0.

  License requirements: None.

# Method Detail

## Validate

`MovieSettingsBuilder.``Validate`

  Validate whether the inputs to the component are sufficient for commit to be called.

  If the component is not in a state to commit then an exception is thrown. For example, if the component requires you to set some property, this method will throw an exception if you haven’t set it. This method throws a not-yet-implemented NXException for some components.

  Signature `Validate()`

  Returns: | Was self validation successful
  Return type: | bool

  New in version NX3.0.1.

  License requirements: None.