-
Notifications
You must be signed in to change notification settings - Fork 989
/
AudioAnalyzer.yaml
96 lines (96 loc) · 2.52 KB
/
AudioAnalyzer.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
name: AudioAnalyzer
type: class
category:
memory_category: Internal
summary: |
Takes measurements from audio streams that are connected to it via one or more
`Class.Wire|Wires`.
description: |
`Class.AudioAnalyzer` takes measurements from audio streams that are wired to
it through `Class.Wire`. It provides a single **Input** pin but does not
produce any output streams.
code_samples: []
inherits:
- Instance
tags:
- NotBrowsable
deprecation_message: ''
properties:
- name: AudioAnalyzer.PeakLevel
summary: |
The loudest volume observed during the last audio buffer.
description: |
The loudest volume observed during the last audio buffer. This property
changes often and thus does not fire changed events.
code_samples: []
type: float
tags:
- ReadOnly
- NotReplicated
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Metering
serialization:
can_load: false
can_save: true
- name: AudioAnalyzer.RmsLevel
summary: |
The root-mean-square average volume observed during the last audio buffer.
description: |
The root-mean-square average volume observed during the last audio buffer.
This property is generally more stable than
`Class.AudioAnalyzer.PeakLevel|PeakLevel` but it may not capture momentary
volume spikes.
code_samples: []
type: float
tags:
- ReadOnly
- NotReplicated
deprecation_message: ''
security:
read: None
write: None
thread_safety: ReadSafe
category: Metering
serialization:
can_load: false
can_save: true
methods:
- name: AudioAnalyzer:GetConnectedWires
summary: ''
description: ''
code_samples: []
parameters:
- name: pin
type: string
default:
summary: ''
returns:
- type: Array
summary: ''
tags: []
deprecation_message: ''
security: None
thread_safety: Unsafe
- name: AudioAnalyzer:GetSpectrum
summary: |
Returns the frequency spectrum of the last audio buffer.
description: |
Returns the frequency spectrum of the last audio buffer, as an array of
numbers. The elements of the array are root-mean-square volume levels,
evenly spaced from 0 hertz to 24,000 hertz.
code_samples: []
parameters: []
returns:
- type: Array
summary: ''
tags:
- CustomLuaState
deprecation_message: ''
security: None
thread_safety: Unsafe
events: []
callbacks: []