Component:AudioStreamSpawner: Difference between revisions

From Resonite Wiki
Automated: update DeDuplicate
add info
Line 3: Line 3:
|Name=Audio Stream Spawner
|Name=Audio Stream Spawner
}}
}}
{{stub}}
The '''AudioStreamSpawner''' component is used as part of the dash to spawn a selected audio stream.
 


== Usage ==
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|BitrateKbps|Float|
|BitrateKbps|Float| The bitrate the audio stream should be
|DeviceName|String|
|DeviceName|String| The name of the selected audio stream
|_bitrateString|String|
|_bitrateString|String| The bitrate as a string.
}}
}}


== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|OnStartStreaming()|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData>|
|OnStartStreaming()|[[Type:Delegate|Delegate]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData>| Triggered by a button in order to spawn the stream in the world.
}}
}}


== Behavior ==
== Usage ==


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


== See Also ==
== See Also ==
Line 25: Line 27:
[[Category:Components:Utility:Tools{{#translation:}}|Audio Stream Spawner]]
[[Category:Components:Utility:Tools{{#translation:}}|Audio Stream Spawner]]
[[Category:Components{{#translation:}}|Audio Stream Spawner]]
[[Category:Components{{#translation:}}|Audio Stream Spawner]]
[[Category:ComponentStubs]]

Revision as of 02:51, 16 December 2024

Component image 
Audio Stream Spawner component as seen in the Scene Inspector

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


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.
BitrateKbps Float The bitrate the audio stream should be
DeviceName String The name of the selected audio stream
_bitrateString String The bitrate as a string.

Sync Delegates

Triggers
Method Name Method type and Arguments. Description
OnStartStreaming() Delegate<IButton: button, ButtonEventData: eventData> Triggered by a button in order to spawn the stream in the world.

Usage

Examples

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


See Also