NX Open C++ Reference Guide
Public Types | Public Member Functions
NXOpen::MovieSettingsBuilder Class Reference

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

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

List of all members.

Public Types

enum  CaptureAreaChoices { CaptureAreaChoicesGraphics, CaptureAreaChoicesNxWindow, CaptureAreaChoicesDesktop }
 Indicates the are being recorded in the movie. More...
enum  PlaybackSpeedChoices {
  PlaybackSpeedChoicesVerySlow, PlaybackSpeedChoicesSlow, PlaybackSpeedChoicesAsRecorded, PlaybackSpeedChoicesFast,
  PlaybackSpeedChoicesVeryFast
}
 Indicates the playback speed of the movie. More...

Public Member Functions

NXOpen::MovieSettingsBuilder::CaptureAreaChoices CaptureArea ()
 Returns the area captured for movie creation.
NXString CodecFourcc ()
 Returns the Codec that is used to create the movie.
int FramesPerSecond ()
 Returns the frames per second for the movie.
NXOpen::MovieSettingsBuilder::PlaybackSpeedChoices PlaybackSpeed ()
 Returns the speed at which the recorded movie is played back.
void SetCaptureArea (NXOpen::MovieSettingsBuilder::CaptureAreaChoices captureArea)
 Sets the area captured for movie creation.
void SetCodecFourcc (const NXString &codecFourcc)
 Sets the Codec that is used to create the movie.
void SetFramesPerSecond (int framesPerSecond)
 Sets the frames per second for the movie.
void SetPlaybackSpeed (NXOpen::MovieSettingsBuilder::PlaybackSpeedChoices playbackSpeed)
 Sets the speed at which the recorded movie is played back.

Detailed Description

This class is the builder for the Movie Settings.


To create a new instance of this class, use 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:
CaptureAreaChoicesGraphics 

Specifies that the NX graphics contents are to be recorded.

CaptureAreaChoicesNxWindow 

Specifies that the NX window contents are to be recorded.

CaptureAreaChoicesDesktop 

Specifies that the Desktop contents are to be recorded.

Indicates the playback speed of the movie.

Enumerator:
PlaybackSpeedChoicesVerySlow 

Specifies very slow playback speed (quarter of record speed)

PlaybackSpeedChoicesSlow 

Specifies slow playback speed (half of record speed)

PlaybackSpeedChoicesAsRecorded 

Specifies playback speed same as record speed.

PlaybackSpeedChoicesFast 

Specifies fast playback speed (twice record speed)

PlaybackSpeedChoicesVeryFast 

Specifies very fast playback speed (four times record speed)


Member Function Documentation

Returns the area captured for movie creation.


Created in NX6.0.0.

License requirements : None

Returns the Codec that is used to create the movie.


Created in NX6.0.0.

License requirements : None

Returns 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 : None

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


Created in NX6.0.0.

License requirements : None

Sets the area captured for movie creation.


Created in NX6.0.0.

License requirements : None

Parameters:
captureAreacapturearea

Sets the Codec that is used to create the movie.


Created in NX6.0.0.

License requirements : None

Parameters:
codecFourcccodecfourcc
void NXOpen::MovieSettingsBuilder::SetFramesPerSecond ( int  framesPerSecond)

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 : None

Parameters:
framesPerSecondframespersecond

Sets the speed at which the recorded movie is played back.


Created in NX6.0.0.

License requirements : None

Parameters:
playbackSpeedplaybackspeed

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