Class FlowGraphPlaySoundBlockExperimental
Hierarchy
- FlowGraphExecutionBlockWithOutSignal
- FlowGraphPlaySoundBlock
Constructors
constructor
-
ExperimentalConstructs a new FlowGraphPlaySoundBlock.
Parameters
Optionalconfig: IFlowGraphBlockConfigurationoptional configuration for the block
Returns FlowGraphPlaySoundBlock
Properties
Optional Experimentalconfig
the configuration of the block
Experimentaldata
The data inputs of the block.
Experimentaldata
The data outputs of the block.
Readonly Experimentalerror
An output connection that can be used to signal an error, if the block defines it.
Readonly Experimentalin
Input connection: The input signal of the block.
Readonly Experimentalloop
Input connection: Whether the sound should loop. Defaults to false.
Experimentalmetadata
Metadata that can be used by the block.
Experimentalname
The name of the block.
Readonly Experimentalout
Output connection: The signal that is synchronous triggered when the execution of this block is done.
Note that is case of events or async you might want to use the done signal instead.
Readonly Experimentalpriority
The priority of the block. Higher priority blocks will be executed first. Note that priority cannot be change AFTER the block was added as sorting happens when the block is added to the execution queue.
Experimentalsignal
Input connections that activate the block.
Experimentalsignal
Output connections that can activate downstream blocks.
Readonly Experimentalsound
Input connection: The sound to play.
Readonly Experimentalstart
Input connection: The time offset in seconds to start playback from. Defaults to 0.
Experimentalunique
A randomly generated GUID for each block.
Readonly Experimentalvolume
Input connection: The volume to play at (0–1). Defaults to 1.
Methods
deserialize
-
ExperimentalDeserializes from an object
Parameters
- serializationObject: any
the object to deserialize from
Returns void
- serializationObject: any
get
-
ExperimentalReturns string
class name of the block.
get
-
ExperimentalGiven the name of a data input, returns the connection if it exists
Parameters
- name: string
the name of the input
Returns FlowGraphDataConnection<any> | undefined
the connection if it exists, undefined otherwise
- name: string
get
-
ExperimentalGiven the name of a data output, returns the connection if it exists
Parameters
- name: string
the name of the output
Returns FlowGraphDataConnection<any> | undefined
the connection if it exists, undefined otherwise
- name: string
get
-
ExperimentalGiven a name of a signal input, return that input if it exists
Parameters
- name: string
the name of the input
Returns FlowGraphSignalConnection | undefined
if the input exists, the input. Otherwise, undefined.
- name: string
get
-
ExperimentalGiven a name of a signal output, return that input if it exists
Parameters
- name: string
the name of the input
Returns FlowGraphSignalConnection | undefined
if the input exists, the input. Otherwise, undefined.
- name: string
register
-
registerDataInput<T>(
name: string,
richType: RichType<T>,
defaultValue?: T,
): FlowGraphDataConnection<T>ExperimentalRegisters a data input on the block.
Type Parameters
- T
Parameters
Returns FlowGraphDataConnection<T>
the created connection
register
-
registerDataOutput<T>(
name: string,
richType: RichType<T>,
defaultValue?: T,
): FlowGraphDataConnection<T>ExperimentalRegisters a data output on the block.
Type Parameters
- T
Parameters
Returns FlowGraphDataConnection<T>
the created connection
serialize
-
ExperimentalSerializes this block
Parameters
- serializationObject: any = {}
the object to serialize in
Returns void
- serializationObject: any = {}
A block that plays an Audio V2 sound.