TextStudioSignalDriver
public sealed class TextStudioSignalDriver : MonoBehaviour, ITextStudioCapabilityReportProvider, ITextStudioExternalEffectSourceApplies one normalized signal through the shared external-effect contract each runtime frame.
Methods
Section titled “Methods”
Submit(in TextStudioExternalEffectSubmissionContext)
Section titled “Submit(in TextStudioExternalEffectSubmissionContext)”public void Submit(in TextStudioExternalEffectSubmissionContext context)Samples the active signal once per frame and submits it as effect progress or intensity.
Parameters
| Name | Type |
|---|---|
context |
TextStudio.TextStudioExternalEffectSubmissionContext |
CollectCapabilityDiagnostics(List)
Section titled “CollectCapabilityDiagnostics(List)”public void CollectCapabilityDiagnostics(List<TextStudioPreviewDiagnostic> diagnostics)Appends warnings for a missing effect or a missing audio source required by the selected signal.
Parameters
| Name | Type |
|---|---|
diagnostics |
System.Collections.Generic.List{TextStudio.TextStudioPreviewDiagnostic} |
Constructors
Section titled “Constructors”
TextStudioSignalDriver()
Section titled “TextStudioSignalDriver()”public TextStudioSignalDriver()Properties
Section titled “Properties”
Effect
Section titled “Effect”public TextStudioEffectDefinitionAsset Effect { get; set; }Returns
TextStudio.TextStudioEffectDefinitionAsset
Source
Section titled “Source”public TextStudioSignalSource Source { get; set; }Returns
TextStudio.TextStudioSignalSource
Destination
Section titled “Destination”public TextStudioSignalDestination Destination { get; set; }Returns
TextStudio.TextStudioSignalDestination
public float Value { get; set; }Returns
System.Single
AudioSource
Section titled “AudioSource”public AudioSource AudioSource { get; set; }Returns
UnityEngine.AudioSource
BeatsPerMinute
Section titled “BeatsPerMinute”public float BeatsPerMinute { get; set; }Returns
System.Single
BeatOriginSeconds
Section titled “BeatOriginSeconds”public double BeatOriginSeconds { get; set; }Returns
System.Double
CurrentSignal
Section titled “CurrentSignal”public float CurrentSignal { get; }Returns
System.Single
IsActive
Section titled “IsActive”public bool IsActive { get; }Whether the source currently has a contribution to submit.
Returns
System.Boolean