Automated: create new component page |
add info |
||
Line 3: | Line 3: | ||
|Name=Audio Stream Interface | |Name=Audio Stream Interface | ||
}} | }} | ||
The '''AudioStreamInterface''' component is used on AudioStream objects that are spawned in by the user via the dash to allow the engine to interface with the stored audio stream. | |||
This is a favorite-able item like a favorite text viewer or a favorite world load indicator | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv0=true| | |ItemName|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv0=true| The name of the stream like Frooxius's Stream | ||
|SpawningUser|UserRef| | |SpawningUser|UserRef| The user that spawned the stream | ||
|SpawningUserID|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv2=true| | |SpawningUserID|'''[[Type:IField`1|IField`1]]<[[Type:String|String]]>'''|TypeAdv2=true| The userid field of the <code>SpawningUser</code> | ||
|IsInstance|Bool| | |IsInstance|Bool| Whether this interface is being edited or is part of a spawned audio stream. | ||
|Source|'''[[Type:SyncRef`1|SyncRef`1]]<[[Type:IAudioStream|IAudioStream]]>'''|TypeAdv4=true| | |Source|'''[[Type:SyncRef`1|SyncRef`1]]<[[Type:IAudioStream|IAudioStream]]>'''|TypeAdv4=true| The audio stream this interfaces with | ||
|Bitrate|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv5=true| | |Bitrate|'''[[Type:IField`1|IField`1]]<[[Type:Int|Int]]>'''|TypeAdv5=true| The Bitrate setting of the spawned audiostream interface (like a UIX) | ||
|Volume|'''[[Type:IField`1|IField`1]]<[[Type:Float|Float]]>'''|TypeAdv6=true| | |Volume|'''[[Type:IField`1|IField`1]]<[[Type:Float|Float]]>'''|TypeAdv6=true| The Volume slider/setting of the spawned audio stream interface (like a UIX) | ||
|Spatialize|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv7=true| | |Spatialize|'''[[Type:IField`1|IField`1]]<[[Type:Bool|Bool]]>'''|TypeAdv7=true| The Spatialize setting of the spawned audio stream interface (like a UIX) | ||
}} | }} | ||
== | == Usage == | ||
Can be used to make your own audio stream player interface as an inventory favorite | |||
== Examples == | == Examples == | ||
{{stub}} | |||
== See Also == | == See Also == | ||
Line 25: | Line 30: | ||
[[Category:Components:Utility:Entity Interfaces{{#translation:}}|Audio Stream Interface]] | [[Category:Components:Utility:Entity Interfaces{{#translation:}}|Audio Stream Interface]] | ||
[[Category:Components{{#translation:}}|Audio Stream Interface]] | [[Category:Components{{#translation:}}|Audio Stream Interface]] | ||
Revision as of 02:34, 16 December 2024
Component image
The AudioStreamInterface component is used on AudioStream objects that are spawned in by the user via the dash to allow the engine to interface with the stored audio stream.
This is a favorite-able item like a favorite text viewer or a favorite world load indicator
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. |
ItemName
|
IField`1<String> | The name of the stream like Frooxius's Stream |
SpawningUser
|
UserRef | The user that spawned the stream |
SpawningUserID
|
IField`1<String> | The userid field of the SpawningUser
|
IsInstance
|
Bool | Whether this interface is being edited or is part of a spawned audio stream. |
Source
|
SyncRef`1<IAudioStream> | The audio stream this interfaces with |
Bitrate
|
IField`1<Int> | The Bitrate setting of the spawned audiostream interface (like a UIX) |
Volume
|
IField`1<Float> | The Volume slider/setting of the spawned audio stream interface (like a UIX) |
Spatialize
|
IField`1<Bool> | The Spatialize setting of the spawned audio stream interface (like a UIX) |
Usage
Can be used to make your own audio stream player interface as an inventory favorite
Examples
This article or section is a Stub. You can help the Resonite Wiki by expanding it.