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

Inheritance diagram for NXOpen::MovieSettingsBuilder:

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	SetCodecFourcc (const char *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.

Public Member Functions inherited from NXOpen::Builder
NXOpen::NXObject *	Commit ()
	Commits any edits that have been applied to the builder.

void	Destroy ()
	Deletes the builder, and cleans up any objects created by the builder.

std::vector< NXOpen::NXObject * >	GetCommittedObjects ()
	For builders that create more than one object, this method returns the objects that are created by commit.

NXOpen::NXObject *	GetObject ()
	Returns the object currently being edited by this builder.

void	ShowResults ()
	Updates the model to reflect the result of an edit to the model for all builders that support showing results.

virtual bool	Validate ()
	Validate whether the inputs to the component are sufficient for commit to be called.

Public Member Functions inherited from NXOpen::TaggedObject
tag_t	GetTag () const
	<b>Deprecated</b>:<br> Use Tag instead.

tag_t	Tag () const
	Returns the tag of this object.

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

enum NXOpen::MovieSettingsBuilder::CaptureAreaChoices

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.

enum NXOpen::MovieSettingsBuilder::PlaybackSpeedChoices

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)