MovieManager Class — NXOpen Python API Reference 12.0.0 documentation

# MovieManager Class

class `NXOpen.``MovieManager`

  Bases: `object`

  Represents a `MovieManager` class. This class is used for recording movies.

  To obtain an instance of this class, refer to `NXOpen.UI`

  New in version NX6.0.0.

# Methods

Method | Description
--- | ---
CaptureFrame | Use this method to capture a frame at a specified point.
CreateMovieSettingsBuilder | Creates a `MovieSettingsBuilder`
End | Stops movie recording
Pause | Pauses movie recording
Resume | Resumes movie recording
SetPlaybackSpeed | Sets the movie playback speed.
Start | Starts movie recording

# Method Detail

## CaptureFrame

`MovieManager.``CaptureFrame`

  Use this method to capture a frame at a specified point.

  This is used when the movie recording was started with true as the second parameter of `MovieManager.Start()`

  Signature `CaptureFrame()`

  New in version NX6.0.0.

  License requirements: None.

## CreateMovieSettingsBuilder

`MovieManager.``CreateMovieSettingsBuilder`

  Creates a `MovieSettingsBuilder`

  Signature `CreateMovieSettingsBuilder()`

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

  New in version NX6.0.0.

  License requirements: None.

## End

`MovieManager.``End`

  Stops movie recording

  Signature `End()`

  New in version NX6.0.0.

  License requirements: None.

## Pause

`MovieManager.``Pause`

  Pauses movie recording

  Signature `Pause()`

  New in version NX6.0.0.

  License requirements: None.

## Resume

`MovieManager.``Resume`

  Resumes movie recording

  Signature `Resume()`

  New in version NX6.0.0.

  License requirements: None.

## SetPlaybackSpeed

`MovieManager.``SetPlaybackSpeed`

  Sets the movie playback speed.

  Movie may not play appropriately at a very high rate (few hundreds). In such cases a lower value could be set. Recommendation is to use a value less than 100 fps.

  Signature `SetPlaybackSpeed(fps)`

  Parameters: | fps (int) – Specifies the playback speed of the movie in frames per second.

  New in version NX8.0.0.

  License requirements: None.

## Start

`MovieManager.``Start`

  Starts movie recording

  Signature `Start(filename, userFrames)`

  Parameters:

  - filename (str) – Filename of the movie to be createed
  - userFrames (bool) – If true, user will provide frames through `MovieManager.CaptureFrame()`. If false, system generates frames

  New in version NX6.0.0.

  License requirements: None.