Automated: update DeDuplicate |
add info |
||
| Line 2: | Line 2: | ||
<translate> | <translate> | ||
<!--T:1--> | <!--T:1--> | ||
{{Infobox Component | {{Infobox Component | ||
|Image=AudioStreamControllerComponent.png | |Image=AudioStreamControllerComponent.png | ||
|Name=Audio Stream Controller | |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--> | <!--T:2--> | ||
== Fields == | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|Stream|IAudioStream| | |Stream|IAudioStream| The audio stream this is controlling. | ||
|AudioOutput|'''[[Component:AudioOutput|AudioOutput]]'''|TypeAdv1=true| | |AudioOutput|'''[[Component:AudioOutput|AudioOutput]]'''|TypeAdv1=true| The audio output being used to play the stream. | ||
|IsPlayingForOwner|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv2=true| | |IsPlayingForOwner|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv2=true| Whether the audio stream is playing for the user who spawned it. | ||
}} | }} | ||
== Sync Delegates == | == Sync Delegates == | ||
{{Table ComponentTriggers | {{Table ComponentTriggers | ||
|OnToggleBroadcast()|[[Type:ButtonEventHandler|ButtonEventHandler]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData>| | |OnToggleBroadcast()|[[Type:ButtonEventHandler|ButtonEventHandler]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData>| Used to change the audio to broadcast. | ||
|OnTogglePlayForOwner()|[[Type:ButtonEventHandler|ButtonEventHandler]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData>| | |OnTogglePlayForOwner()|[[Type:ButtonEventHandler|ButtonEventHandler]]<[[Type:IButton|IButton]]: button, [[Type:ButtonEventData|ButtonEventData]]: eventData>| Used to make the audio play for the stream owner. | ||
}} | }} | ||
<!--T:3--> | <!--T:3--> | ||
== Usage == | == Usage == | ||
Legacy. | |||
<!--T:4--> | <!--T:4--> | ||
== Examples == | == Examples == | ||
Legacy. | |||
<!--T:5--> | <!--T:5--> | ||
== | == See Also == | ||
* [[Component:AudioStreamInterface]] | |||
</translate> | </translate> | ||
[[Category:Components{{#translation:}}|Audio Stream Controller]] | [[Category:Components{{#translation:}}|Audio Stream Controller]] | ||
[[Category:Components:Uncategorized{{#translation:}}|Audio Stream Controller]] | [[Category:Components:Uncategorized{{#translation:}}|Audio Stream Controller]] | ||
Revision as of 20:30, 10 February 2025
Component image 
Audio Stream Controller component as seen in the Scene Inspector
The AudioStreamController component is an old legacy component.
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
| Method Name | Method type and Arguments. | Is the method hidden? | Description |
|---|
Usage
Legacy.
Examples
Legacy.