| Volume pwrb | |
| Attributes: Runtime | Development | System | Template | Detail C Binding: Struct | Class ClassTree | INDEX NO INDEX |
|
Class Sound
|
||
|---|---|---|
| Version | 1.0 | |
| Modified | 26-MAY-2023 14:29:26.00 | |
The Sound object defines a sound for an alarm, or for sound dynamics in
the operator environment.
The sound is specified by a souce, that can be a code word ("Sine" for
sinewaves and "Square" for squre waves) or a filepath to a sampled file.
For files specified with Sine or Square, the amplitude for the wave over
time can be specified with the Attack, Decay, Release, Time and Sustain
attributes.
Object graph
| RtBody attributes pwr_sClass_Sound | |||
|---|---|---|---|
| String80 | Description | Optional description. | |
| String80 | Source | Sound source. A codeword or a filepath. | |
| Int32 | Prio | Sound priority. | |
| AudioToneEnum | BaseTone | Default base tone for sine and square waves. | |
| Array of UInt32 | ToneTable | Tone table. | |
| Array of Float32 | VolumeTable | Volume table. | |
| Float32 | Volume | Volume in percentage (0 - 100) | |
| Float32 | Attack | Attack time in seconds. | |
| Float32 | Decay | Timeconstant for sound decay. | |
| Float32 | Sustain | Sustain level in the interval 0 - 100 | |
| Float32 | Release | Release time in seconds. | |
| Float32 | Length | Default length of sound in seconds. | |
| Float32 | Tremolo | Tremolo. | |
| Template Object | |
|---|---|
| Source | Sine |
| BaseTone | 33 |
| VolumeTable[0] | 100 |
| Volume | 100 |
| Sustain | 100 |
| Length | 0.3 |
| Description Attribute | ||
|---|---|---|
| Class | Attribute | |
| Type | String80 | |
| Flags | ||
| Body | RtBody | |
Optional description.
| Source Attribute | ||
|---|---|---|
| Class | Attribute | |
| Type | String80 | |
| Flags | ||
| Body | RtBody | |
Sound source. A codeword or a filepath.
| Prio Attribute | ||
|---|---|---|
| Class | Attribute | |
| Type | Int32 | |
| Flags | ||
| Body | RtBody | |
Sound priority.
| BaseTone Attribute | ||
|---|---|---|
| Class | Attribute | |
| Type | AudioToneEnum | |
| Flags | ||
| Body | RtBody | |
Default base tone for sine and square waves.
| ToneTable Attribute | ||
|---|---|---|
| Class | Attribute | |
| Type | Array of UInt32 | |
| Flags | ARRAY | |
| Elements | 8 | |
| Body | RtBody | |
Tone table.
| VolumeTable Attribute | ||
|---|---|---|
| Class | Attribute | |
| Type | Array of Float32 | |
| Flags | ARRAY | |
| Elements | 8 | |
| Body | RtBody | |
Volume table.
| Volume Attribute | ||
|---|---|---|
| Class | Attribute | |
| Type | Float32 | |
| Flags | ||
| Body | RtBody | |
Volume in percentage (0 - 100)
| Attack Attribute | ||
|---|---|---|
| Class | Attribute | |
| Type | Float32 | |
| Flags | ||
| Body | RtBody | |
Attack time in seconds.
| Decay Attribute | ||
|---|---|---|
| Class | Attribute | |
| Type | Float32 | |
| Flags | ||
| Body | RtBody | |
Timeconstant for sound decay.
| Sustain Attribute | ||
|---|---|---|
| Class | Attribute | |
| Type | Float32 | |
| Flags | ||
| Body | RtBody | |
Sustain level in the interval 0 - 100
| Release Attribute | ||
|---|---|---|
| Class | Attribute | |
| Type | Float32 | |
| Flags | ||
| Body | RtBody | |
Release time in seconds.
| Length Attribute | ||
|---|---|---|
| Class | Attribute | |
| Type | Float32 | |
| Flags | ||
| Body | RtBody | |
Default length of sound in seconds.
| Tremolo Attribute | ||
|---|---|---|
| Class | Attribute | |
| Type | Float32 | |
| Flags | ||
| Body | RtBody | |
Tremolo.