Component:AudioOutputDeviceSettings: Difference between revisions

Revision as of 22:22, 15 December 2024

Component image

**Audio Output Device Settings** component as seen in the Scene Inspector

The AudioOutputDeviceSettings Component is used to set the priority order of output devices for the local user. It also can be used to disable priority and use the system default instead.

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.
`UseSystemDefault`	Bool	Whether or not to use the user's default device on their OS or not.
`DevicePriorities`	list of DevicePriorityEntry	A list of devices and their priority which is the order to use them in.
`DevicePrioritiesEnabled`	Bool	Whether the "Use Default Device" setting is turned on or off

Sync Delegates

Lua error in mw.text.lua at line 25: bad argument #1 to 'match' (string expected, got nil).

Triggers
Method Name	Method type and Arguments.	Is the method hidden?	Description

Usage

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

Examples

The settings menu

@@ Line 3: / Line 3: @@
 |Name=Audio Output Device Settings
 }}
-{{stub}}
+The '''AudioOutputDeviceSettings''' Component is used to set the priority order of output devices for the local user. It also can be used to disable priority and use the system default instead.
-== Usage ==
+== Fields ==
 {{Table ComponentFields
-|UseSystemDefault|Bool|
+|UseSystemDefault|Bool| Whether or not to use the user's default device on their OS or not.
-|DevicePriorities|{{RootFieldType|SyncList`1|[[Type:DevicePriorityEntry|DevicePriorityEntry]]}}|TypeAdv1=true|
+|DevicePriorities|{{RootFieldType|SyncList`1|[[Type:DevicePriorityEntry|DevicePriorityEntry]]}}|TypeAdv1=true| A list of devices and their priority which is the order to use them in.
-|DevicePrioritiesEnabled|Bool|
+|DevicePrioritiesEnabled|Bool| Whether the "Use Default Device" setting is turned on or off
 }}
 == Sync Delegates ==
 {{Table ComponentTriggers
-|GetDevice()|[[Type:SubsettingGetter|SubsettingGetter]]&lt;[[Type:String|String]]: key&gt;|
+|GetDevice()|[[Type:SubsettingGetter|SubsettingGetter]]&lt;[[Type:String|String]]: key&gt;| This returns a setting with the name specified by the methods <code>key</code> input.
 }}
-== Behavior ==
+== Usage ==
+{{stub}}
 == Examples ==
+The settings menu
 == See Also ==
@@ Line 25: / Line 27: @@
 [[Category:Components:Uncategorized{{#translation:}}|Audio Output Device Settings]]
 [[Category:Components{{#translation:}}|Audio Output Device Settings]]
-[[Category:ComponentStubs]]