Automated: create new component page |
add info |
||
Line 3: | Line 3: | ||
|Name=Audio Device Volume | |Name=Audio Device Volume | ||
}} | }} | ||
The '''AudioDeviceVolume''' component only functions in dash space. If <code>AudioDeviceIndex</code> is negative, then it uses the user's set default audio device. This component is used to manage the volume of an input device like a microphone for one example. This is a settings component. | |||
<!--(confirm is this a setting component?)--> | |||
== | == Fields == | ||
{{Table ComponentFields | {{Table ComponentFields | ||
|AudioDeviceIndex|Int| | |AudioDeviceIndex|Int| The audio input device by OS audio manager index to modify the volume for. | ||
|Volume|Float| | |Volume|Float| The volume the input device should have. | ||
|NormalizedVolume|Float| | |NormalizedVolume|Float| The component uses this value to boost the output noise to a higher volume when it is too quiet or reduce the volume when it is too loud. | ||
|Smoothing|Float| | |Smoothing|Float| How fast to reduce or increase the volume when it gets too loud or quiet | ||
|Power|Float| | |Power|Float| The amount to boost the volume overall before normalization. | ||
}} | }} | ||
== | == Usage == | ||
== Examples == | == Examples == | ||
{{stub}} | |||
== See Also == | == See Also == | ||
Line 22: | Line 24: | ||
[[Category:Components:Userspace{{#translation:}}|Audio Device Volume]] | [[Category:Components:Userspace{{#translation:}}|Audio Device Volume]] | ||
[[Category:Components{{#translation:}}|Audio Device Volume]] | [[Category:Components{{#translation:}}|Audio Device Volume]] | ||
Latest revision as of 17:20, 12 December 2024
Component image
The AudioDeviceVolume component only functions in dash space. If AudioDeviceIndex
is negative, then it uses the user's set default audio device. This component is used to manage the volume of an input device like a microphone for one example. This is a settings 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. |
AudioDeviceIndex
|
Int | The audio input device by OS audio manager index to modify the volume for. |
Volume
|
Float | The volume the input device should have. |
NormalizedVolume
|
Float | The component uses this value to boost the output noise to a higher volume when it is too quiet or reduce the volume when it is too loud. |
Smoothing
|
Float | How fast to reduce or increase the volume when it gets too loud or quiet |
Power
|
Float | The amount to boost the volume overall before normalization. |
Usage
Examples
This article or section is a Stub. You can help the Resonite Wiki by expanding it.