1. Epic GamesDeveloper
  3. FTrigger

FTrigger

[FTrigger](API\Plugins\MetasoundFrontend\FTrigger) supports sample accurate triggering, sample accurate internal tracking, and a convenient interface for running trigger-aligned audio signal processing routines on buffers..

API > API/Plugins > API/Plugins/MetasoundFrontend

References

   
Module MetasoundFrontend
Header /Engine/Plugins/Runtime/Metasound/Source/MetasoundFrontend/Public/MetasoundTrigger.h
Include #include "MetasoundTrigger.h"

Syntax

class FTrigger

Remarks

FTrigger supports sample accurate triggering, sample accurate internal tracking, and a convenient interface for running trigger-aligned audio signal processing routines on buffers..

FTriggers are triggered using FTrigger::TriggerTime or FTrigger::TriggerFrame. FTriggers track time internally by calling FTrigger::Advance. Executing audio signal processing on buffers can be performed by calling FTrigger::ExecuteBlock or FTrigger::LookAhead.

Constructors

  Type Name Description
Public function  

FTrigger ( const FOperatorSettings& InSettings
)

 FTrigger constructor.
Public function  

FTrigger ( const FOperatorSettings& InSettings,
bool bShouldTrigger
)

 FTrigger constructor.
Public function  

FTrigger ( const FOperatorSettings& InSettings,
int32 InFrameToTrigger
)

 FTrigger constructor.

Functions

  Type Name Description
Public function void

Advance ( int32 InNumFrames
)

 Advance internal frame counters by specific frame count.
Public function void Advance internal frame counters by block size.
Public function void

AssignRawParameter ( const void* ParamPackPayload
)

 For use when a Trigger request is found in a Parameter Pack
Public function Const void

ExecuteBlock ( PreTriggerType InPreTrigger,
OnTriggerType InOnTrigger
)

 Executes one block of frames and calls underlying InPreTrigger and InOnTrigger functions with frame indices.
Public function Const int32

First ()

 Returns frame index for the first trigger in the block.
Public function Const const TArray< int32 > &  
Public function Const bool Returns true if there are any triggered frames.
Public function Const bool Returns true there is a trigger in the current block of audio.
Public function Const int32

Last ()

 Returns frame index for the last trigger in the block.
Public function Const void

LookAhead ( int32 InNumFrames,
PreTriggerType InPreTrigger,
OnTriggerType InOnTrigger
)

 Executes a desired number of frames and calls underlying InPreTrigger and InOnTrigger functions with frame indices.
Public function Const int32

Num ()

 Number of triggered frames.
Public function Const int32 Returns true if there is a trigger in the current block of audio
Public function void

RemoveAfter ( int32 InFrameIndex
)

 Removes all triggers which occur after the frame index.
Public function void

Reset ()

 Removes all triggered frames.
Public function void

TriggerFrame ( int32 InFrameToTrigger
)

 Trigger a specific frame in the future.

Operators

  Type Name Description
Public function Const   Implicit conversion of FTrigger into bool by calling IsTriggeredInBlock()
Public function Const int32

operator[] ( int32 InTriggerIndex
)

 Returns frame index for a given trigger index.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page