Class TimelineAsset.EditorSettings

Properties of the timeline that are used by the editor

Inheritance

Object

TimelineAsset.EditorSettings

Inherited Members

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: UnityEngine.Timeline

Syntax

[Serializable]
public class EditorSettings

Properties

fps

The frames per second used for snapping and time ruler display

Declaration

[Obsolete("EditorSettings.fps has been deprecated. Use editorSettings.frameRate instead.", false)]
public float fps { get; set; }

Property Value

Type	Description
Single

frameRate

The frames per second used for framelocked preview, frame snapping and time ruler display,

Declaration

public double frameRate { get; set; }

Property Value

Type	Description
Double

Remarks

If frameRate is set to a non-standard custom frame rate, Timeline playback may give incorrect results when playbackLockedToFrame is true.

See Also

TimelineAsset

scenePreview

Set to false to ignore scene preview when this timeline is played by the Timeline window.

Declaration

public bool scenePreview { get; set; }

Property Value

Type	Description
Boolean

Remarks

When set to false, this setting will

• Disable scene preview when this timeline is played by the Timeline window.
• Disable recording for all recordable tracks.
• Disable play range in the Timeline window.
• Stop() is not called on the PlayableDirector when switching between different TimelineAssets in the TimelineWindow.

scenePreview will only be applied if the asset is the master timeline.

See Also

TimelineAsset

Methods

SetStandardFrameRate(StandardFrameRates)

Sets the EditorSetting frameRate to one of the provided standard frame rates.

Declaration

public void SetStandardFrameRate(StandardFrameRates enumValue)

Parameters

Type	Name	Description
StandardFrameRates	enumValue	StandardFrameRates value, used to set the current EditorSettings frameRate value.

Remarks

When specifying drop frame values, it is recommended to select one of the provided standard frame rates. Specifying a non-standard custom frame rate may give incorrect results when playbackLockedToFrame is enabled during Timeline playback.

Exceptions

Type	Condition
ArgumentException	Thrown when the enumValue is not a valid member of StandardFrameRates.

See Also

TimelineAsset