Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update AudioAnalyzer docs to mention server limitations #987

Merged
merged 3 commits into from
Jan 21, 2025
+9 −3
Merged

Update AudioAnalyzer docs to mention server limitations #987

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f9e667b
Update AudioAnalyzer docs to mention server limitations
rbxphogen Jan 17, 2025
86fd012
Apply suggestions from code review
IgnisRBX Jan 21, 2025
8f8a9f9
Merge branch 'main' into update-audioanalyzer-docs-to-note-server
IgnisRBX Jan 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions content/en-us/reference/engine/classes/AudioAnalyzer.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ 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.
Note that all audio processing is disabled on the server in order to conserve resources;
Properties and methods of `Class.AudioAnalyzer` return empty or zero results when used from server scripts.
code_samples: []
inherits:
- Instance
Expand All @@ -20,7 +22,8 @@ properties:
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.
changes more often than the framerate and does not fire changed events.
On the server, this property is always `0`.
code_samples: []
type: float
tags:
Expand All @@ -46,6 +49,8 @@ properties:
This property is generally more stable than
`Class.AudioAnalyzer.PeakLevel|PeakLevel` but it may not capture momentary
volume spikes.
This property changes more often than the framerate and does not fire changed events.
On the server, this property is always `0`.
code_samples: []
type: float
tags:
Expand Down Expand Up @@ -116,8 +121,9 @@ methods:
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. If any of the analyzer's
inputs come from an `Class.AudioDeviceInput`, this method returns an empty
evenly spaced from 0 hertz to 24,000 hertz.
If any of the analyzer's
inputs come from an `Class.AudioDeviceInput`, or this method is used from a server script, it returns an empty
array.
code_samples: []
parameters: []
Expand Down
Loading