Component:AudioStreamController: Difference between revisions

Latest revision as of 06:30, 17 March 2025

Component image

**Audio Stream Controller** component as seen in the Scene Inspector

The AudioStreamController component is an old legacy component.

This shouldn't be used! For a modern component that does the same thing and is customizable, see AudioStreamInterface.

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`	IAudioStream	The audio stream this is controlling.
`AudioOutput`	AudioOutput	The audio output being used to play the stream.
`IsPlayingForOwner`	raw output of Bool	Whether the audio stream is playing for the user who spawned it.

Sync Delegates

Triggers
Method Name	Method type and Arguments.	Is the method hidden?	Description
`OnToggleBroadcast:ButtonEventHandler`	ButtonEventHandler	X	Used to change the audio to broadcast.
`OnTogglePlayForOwner:ButtonEventHandler`	ButtonEventHandler	X	Used to make the audio play for the stream owner.

Usage

Legacy.

Examples

Legacy.

@@ Line 2: / Line 2: @@
 <translate>
 <!--T:1-->
-{{stub}}
 {{Infobox Component
 |Image=AudioStreamControllerComponent.png
 |Name=Audio Stream Controller
 }}
+The '''AudioStreamController''' component is an old legacy component.
+{{Note|This shouldn't be used! For a modern component that does the same thing and is customizable, see [[Component:AudioStreamInterface|AudioStreamInterface]].|warning}}
 <!--T:2-->
 == Fields ==
 {{Table ComponentFields
-|_stream|OpusStream`1|TypeString0=OpusStream<StereoSample>|
+|Stream|IAudioStream| The audio stream this is controlling.
-|_audioOutput|AudioOutput|
+|AudioOutput|'''[[Component:AudioOutput|AudioOutput]]'''|TypeAdv1=true| The audio output being used to play the stream.
+|IsPlayingForOwner|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv2=true| Whether the audio stream is playing for the user who spawned it.
+}}
+== Sync Delegates ==
+{{Table ComponentTriggers
+|OnToggleBroadcast:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|false| Used to change the audio to broadcast.
+|OnTogglePlayForOwner:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|false| Used to make the audio play for the stream owner.
 }}
 <!--T:3-->
 == Usage ==
+Legacy.
 <!--T:4-->
 == Examples ==
+Legacy.
 <!--T:5-->
-== Related Components ==
+== See Also ==
+* [[Component:AudioStreamInterface]]
 </translate>
-[[Category:ComponentStubs]]
 [[Category:Components{{#translation:}}|Audio Stream Controller]]
 [[Category:Components:Uncategorized{{#translation:}}|Audio Stream Controller]]