Api Sandbox MovieMaker MovieRecorderOptions
class

MovieRecorderOptions

public sealed class MovieRecorderOptions

Configures a MovieRecorder, deciding how often it captures and which properties should be recorded.

Constructors

MovieRecorderOptions(Int32 SampleRate)

Configures a MovieRecorder, deciding how often it captures and which properties should be recorded.

SampleRate — How often to capture the value of recorded properties.

Properties

Name Type Description
SampleRate Int32 How often to capture the value of recorded properties.
Default static MovieRecorderOptions Default options, using WithDefaultCaptureActions and WithDefaultComponentCapturers.
Filters ImmutableArray<MovieRecorderFilter> Decide which objects are allowed to be recorded. Called the first time a GameObject is passed to GameObject), which will return if any delegate in this list returns .
CaptureActions ImmutableArray<MovieRecorderAction> Delegates called each time Capture is invoked, to control which objects should be recorded. These actions will call Capture on one or more track recorders.
ComponentCapturers ImmutableArray<IComponentCapturer> When 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.

Methods

MovieRecorderOptions WithCaptureAction(MovieRecorderAction action)
MovieRecorderOptions WithComponentCapturer()
MovieRecorderOptions WithComponentCapturer(IComponentCapturer recorder)
MovieRecorderOptions WithCaptureAll(Func<T, Boolean> condition = null)
MovieRecorderOptions WithDefaultComponentCapturers()
MovieRecorderOptions WithDefaultCaptureActions()
MovieRecorderOptions WithCaptureGameObject(GameObject gameObject)
MovieRecorderOptions WithCaptureComponent(Component component)
Void Deconstruct(Int32 SampleRate)

Fields

Name Type Description
DefaultSampleRate static Int32 Default value for SampleRate.
Assembly: Sandbox.Engine Namespace: Sandbox.MovieMaker Full Name: Sandbox.MovieMaker.MovieRecorderOptions