Component:LocalAudioDeviceStream: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
dash world -> userspace
 
(One intermediate revision by one other user not shown)
Line 3: Line 3:
|Name=Local Audio Device Stream
|Name=Local Audio Device Stream
}}
}}
{{stub}}
The '''LocalAudioDeviceStream''' component can be used as a source of streamed audio data kind of like a player or a video for use with audio output components. This component Outputs locally the audio for a specified audio input Device by index number.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|AudioDeviceIndex|Int|
|AudioDeviceIndex|Int| The audio device to gather audio samples from.
|UseFilteredData|Bool|
|UseFilteredData|Bool| Whether to use raw audio samples or filter them.
}}
}}


== Behavior ==
== Usage ==
Can be used to listen to a specified audio device index using an audio output. Can be used in world space and isn't limited to userspace.


== Examples ==
== Examples ==
Line 19: Line 20:
[[Category:Components:Uncategorized{{#translation:}}|Local Audio Device Stream]]
[[Category:Components:Uncategorized{{#translation:}}|Local Audio Device Stream]]
[[Category:Components{{#translation:}}|Local Audio Device Stream]]
[[Category:Components{{#translation:}}|Local Audio Device Stream]]
[[Category:ComponentStubs]]

Latest revision as of 15:29, 17 June 2025

Component image 
Local Audio Device Stream component as seen in the Scene Inspector

The LocalAudioDeviceStream component can be used as a source of streamed audio data kind of like a player or a video for use with audio output components. This component Outputs locally the audio for a specified audio input Device by index number.

Fields

Fields
Name Type Description
persistent Bool Determines whether or not this item will be saved to the server.
UpdateOrder Int Controls the order in which this component is updated.
Enabled Bool Controls whether or not this component is enabled. Some components stop their functionality when this field is disabled, but some don't.
AudioDeviceIndex Int The audio device to gather audio samples from.
UseFilteredData Bool Whether to use raw audio samples or filter them.

Usage

Can be used to listen to a specified audio device index using an audio output. Can be used in world space and isn't limited to userspace.

Examples

See Also