Api
Classes
MovieRecorderOptions
chevron_left Classes
class
MovieRecorderOptions

Constructors

functionsMovieRecorderOptions

Properties

data_objectBufferDurationdata_objectCaptureActionsdata_objectComponentCapturersdata_objectFiltersdata_objectSampleRate

Methods

functions<Clone>$functionsDeconstructfunctionsWithCaptureActionfunctionsWithCaptureAllfunctionsWithCaptureComponentfunctionsWithCaptureGameObjectfunctionsWithComponentCapturerfunctionsWithDefaultCaptureActionsfunctionsWithDefaultComponentCapturersfunctionsWithFilter

Static Fields

crop_dinDefaultSampleRate

Static Properties

data_objectDefault
MovieRecorderOptions
Configures a Sandbox.MovieMaker.MovieRecorder, deciding how often it captures and which properties should be recorded.
class Sandbox.MovieMaker .
sealedSandbox.Engine

build Constructors 1

MovieRecorderOptions (SampleRate, BufferDuration)

data_object Properties 5

BufferDuration
Nullable`1
Keep only the most recent samples in memory, with this duration. If , samples won't be discarded and the recording will keep growing in size until stopped.
CaptureActions
ImmutableArray`1
Delegates called each time Sandbox.MovieMaker.MovieRecorder.Capture is invoked, to control which objects should be recorded. These actions will call Sandbox.MovieMaker.IMovieTrackRecorder.Capture on one or more track recorders.
ComponentCapturers
ImmutableArray`1
When Sandbox.MovieMaker.IMovieTrackRecorder.Capture is called on a component track, any instances in this list that match the component type will be used to decide which properties on that component should be recorded.
Filters
ImmutableArray`1
Decide which objects are allowed to be recorded. Called the first time a Sandbox.GameObject is passed to Sandbox.MovieMaker.MovieRecorder.GetTrackRecorder(Sandbox.GameObject), which will return if any delegate in this list returns .
SampleRate
int
How often to capture the value of recorded properties.

functions Methods 10

<Clone>$ ()
MovieRecorderOptions
Deconstruct (SampleRate, BufferDuration)
WithCaptureAction (action)
MovieRecorderOptions
WithCaptureAll (condition)
MovieRecorderOptions
WithCaptureComponent (component)
MovieRecorderOptions
WithCaptureGameObject (gameObject)
MovieRecorderOptions
WithComponentCapturer ()
MovieRecorderOptions
WithDefaultCaptureActions ()
MovieRecorderOptions
WithDefaultComponentCapturers ()
MovieRecorderOptions
WithFilter (filter)
MovieRecorderOptions

crop_din Static Fields 1

DefaultSampleRate
int
Default value for Sandbox.MovieMaker.MovieRecorderOptions.SampleRate.

data_object Static Properties 1

Default
MovieRecorderOptions
Default options, using Sandbox.MovieMaker.MovieRecorderOptions.WithDefaultCaptureActions and Sandbox.MovieMaker.MovieRecorderOptions.WithDefaultComponentCapturers.
people
Log in to reply
You can't reply if you're not logged in. That would be crazy.