PlaySoundAction class final
Plays a synthesised sound (a voice name), now or at a time on the sound clock, or the sound file at url. Every field is an expression.
- Inheritance
-
- Object
- ActionDef
- MediaAction
- PlaySoundAction
Constructors
- PlaySoundAction({String sound = 'wood', String operation = 'play', String voiceId = '', String frequency = '440', String waveform = 'sine', String note = '', String duration = '', String volume = '1', String pitch = '1', String at = '', String url = '', bool enabled = true, bool nonBlocking = false, Predicate? when})
-
const
Properties
- at → String
-
final
- duration → String
-
Milliseconds after which a
started voice releases by itself (a latched note, an audition, a metronome tick); empty sustains untilstop.final - enabled → bool
-
False skips the action.
finalinherited
- fieldsJson → Json
-
Its own fields, as JSON (sparse): what toJson writes besides
typeand the common fields. An action class outside this library overrides this.no setteroverride - frequency → String
-
playis the existing one-shot;startsustains a tone untilstopwith the same voiceId.stopAllreleases the app's sustained tones.final - hashCode → int
-
The hash code for this object.
no setterinherited
-
nested
→ List<
ActionDef> -
The actions it runs itself (branches, follow-ups), in order.
no setterinherited
- nonBlocking → bool
-
The chain doesn't wait for it, and its failure doesn't stop the chain.
finalinherited
- note → String
-
A MIDI note number (60 = middle C, 69 = A 440) for
start, used in place of frequency when not empty:${item.midi}.final - operation → String
-
playis the existing one-shot;startsustains a tone untilstopwith the same voiceId.stopAllreleases the app's sustained tones.final - pitch → String
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
selfAndNested
→ Iterable<
ActionDef> -
This action, then every action nested in it, depth first.
no setterinherited
- sound → String
-
final
- type → String
-
The JSON
type.no setteroverride - url → String
-
final
- voiceId → String
-
playis the existing one-shot;startsustains a tone untilstopwith the same voiceId.stopAllreleases the app's sustained tones.final - volume → String
-
final
- waveform → String
-
A sustained voice's sound:
sine(default),triangle,square,sawtooth, or an instrument voice with its own envelope and filter:felt(a soft electric piano),reed(an organ-like reed) orpluck(a plucked string that dies away on its own).final - when → Predicate?
-
Runs only when it holds; null: always.
finalinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Json -
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited