Component:AudioInputDeviceSettings: Difference between revisions

From Resonite Wiki
Automated: create new component page
 
Add some info, format
 
(3 intermediate revisions by the same user not shown)
Line 4: Line 4:
}}
}}
{{stub}}
{{stub}}
The '''AudioInputDeviceSettings''' Component is used to set the priority order of input devices for the local user. It also can be used to disable priority and use the system default instead.


== Usage ==
== Fields ==
{{Table ComponentFields
{{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|
}}
}}


== Behavior ==
== Sync Delegates ==
{{Table ComponentTriggers
|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.
}}
 
== Usage ==


== Examples ==
== Examples ==

Latest revision as of 02:16, 8 November 2024

Component image 
Audio Input Device Settings component as seen in the Scene Inspector


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


The AudioInputDeviceSettings Component is used to set the priority order of input 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.
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

Sync Delegates

Triggers
Name Arguments Description
GetDevice() SubsettingGetter<String: key> This returns a setting with the name specified by the methods key input.

Usage

Examples

See Also