Component:UserAudioStream: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
add info
 
Line 3: Line 3:
|Name=User Audio Stream`1
|Name=User Audio Stream`1
}}
}}
{{stub}}
The '''UserAudioStream''' component writes Audio from a user Audio device to a specified stream. The audio device used is set internally and such methods are not accessible to the user.


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Stream|'''[[Type:AudioStream`1|AudioStream`1]]<S>'''|TypeAdv0=true|
|Stream|'''[[Type:AudioStream`1|AudioStream`1]]<S>'''|TypeAdv0=true| The stream to write audio to.
|UseFilteredData|Bool|
|UseFilteredData|Bool| Whether to filter the audio data being written to <code>Stream</code> from the user.
}}
}}


== Behavior ==
== Usage ==
{{stub}}


== Examples ==
== Examples ==
{{stub}}


== See Also ==
== See Also ==
Line 20: Line 22:
[[Category:Components{{#translation:}}|User Audio Stream`1]]
[[Category:Components{{#translation:}}|User Audio Stream`1]]
[[Category:Generic Components{{#translation:}}|User Audio Stream`1]]
[[Category:Generic Components{{#translation:}}|User Audio Stream`1]]
[[Category:ComponentStubs]]

Latest revision as of 17:23, 6 February 2025

Component image 
File:UserAudioStream`1Component.png
User Audio Stream`1 component as seen in the Scene Inspector

The UserAudioStream component writes Audio from a user Audio device to a specified stream. The audio device used is set internally and such methods are not accessible to the user.

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.
Stream AudioStream`1<S> The stream to write audio to.
UseFilteredData Bool Whether to filter the audio data being written to Stream from the user.

Usage

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

Examples

This article or section is a Stub. You can help the Resonite Wiki by expanding it.

See Also