Component:AudioStreamSpawner: Difference between revisions

Latest revision as of 06:30, 17 March 2025

Component image

The AudioStreamSpawner component is used as part of the dash to spawn a selected audio stream.

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.
`BitrateKbps`	Float	The bitrate the audio stream should be
`DeviceID`	String	the device name of the stream we are spawning
`_bitrateString`	String	The bitrate as a string.

Triggers
Method Name	Method type and Arguments.	Is the method hidden?	Description
`OnStartStreaming:ButtonEventHandler`	ButtonEventHandler	✓	Triggered by a button in order to spawn the stream in the world.

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

@@ Line 9: / Line 9: @@
 {{Table ComponentFields
 |BitrateKbps|Float| The bitrate the audio stream should be
-|DeviceID|String|
+|DeviceID|String| the device name of the stream we are spawning
 |_bitrateString|String| The bitrate as a string.
 }}
@@ Line 15: / Line 15: @@
 == Sync Delegates ==
 {{Table ComponentTriggers
-|OnStartStreaming()|[[Type:Delegate|Delegate]]&lt;[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData&gt;| Triggered by a button in order to spawn the stream in the world.
+|OnStartStreaming:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| Triggered by a button in order to spawn the stream in the world.
 }}
@@ Line 26: / Line 26: @@
 [[Category:Components:Utility:Tools{{#translation:}}|Audio Stream Spawner]]
-[[Category:ComponentStub]]
 [[Category:Components{{#translation:}}|Audio Stream Spawner]]