template |
add info |
||
| Line 3: | Line 3: | ||
|Name=Microphone Tool | |Name=Microphone Tool | ||
}} | }} | ||
See [[Microphone]]. | |||
== Usage == | == Usage == | ||
| Line 14: | Line 14: | ||
|_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true| {{Template:ITool _overrideActiveTool}} | |_overrideActiveTool|'''[[Component:InteractionHandler|InteractionHandler]]'''|TypeAdv5=true| {{Template:ITool _overrideActiveTool}} | ||
|_gripPosesGenerated|Bool| {{Template:ITool _gripPosesGenerated}} | |_gripPosesGenerated|Bool| {{Template:ITool _gripPosesGenerated}} | ||
|Format|'''[[#RecordFormat|RecordFormat]]'''|TypeAdv7=true| | |Format|'''[[#RecordFormat|RecordFormat]]'''|TypeAdv7=true| The type of audio file to make. | ||
|Quality|Float| | |Quality|Float| The quality of the resulting audio clip file. | ||
|Mode|'''[[#RecordMode|RecordMode]]'''|TypeAdv9=true| | |Mode|'''[[#RecordMode|RecordMode]]'''|TypeAdv9=true| Whether the user has to hold or it's a toggle. | ||
|Source|'''[[#DataSource|DataSource]]'''|TypeAdv10=true| | |Source|'''[[#DataSource|DataSource]]'''|TypeAdv10=true| The way to record the audio. | ||
|RecordingUser|User| | |RecordingUser|User| The user that is currently recording using the Tool. | ||
|RecordingStartTime|{{RootFieldType|SyncTime}}|TypeAdv12=true| | |RecordingStartTime|{{RootFieldType|SyncTime}}|TypeAdv12=true| The time that the user started recording in world time. | ||
|IsRecording|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv13=true| | |IsRecording|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv13=true| Whether the tool is currently being used to record. | ||
}} | }} | ||
== | == RecordFormat == | ||
{{Table EnumValues | |||
|OGG_Vorbis|0|Directional audio with a left and right position. | |||
|WAV|1| Windows audio format | |||
|FLAC|2| Zero compression high quality format. | |||
}} | |||
== RecordMode == | |||
{{Table EnumValues | |||
|Hold|0|The user has to hold Primary down to record | |||
|Toggle|1| The user has to press Primary to start recording and then press it again to stop recording. | |||
}} | |||
== DataSource == | |||
{{Table EnumValues | |||
|RAW|0|Raw audio, no normalization | |||
|Normalized|1|Normalized audio, makes audio recording consistent between mic gains. | |||
}} | |||
== Usage == | |||
See [[Microphone]]. | |||
== Examples == | == Examples == | ||
See [[Microphone]]. | |||
== See Also == | == See Also == | ||
* [[Microphone]] | |||
* [[Tools]] | |||
[[Category:Components:Tools{{#translation:}}|Microphone Tool]] | [[Category:Components:Tools{{#translation:}}|Microphone Tool]] | ||
[[Category:Components{{#translation:}}|Microphone Tool]] | [[Category:Components{{#translation:}}|Microphone Tool]] | ||
[[Category:Components With Nested Enums{{#translation:}}|Microphone Tool]] | [[Category:Components With Nested Enums{{#translation:}}|Microphone Tool]] | ||
Latest revision as of 20:06, 22 December 2024
Component image 
Microphone Tool component as seen in the Scene Inspector
See Microphone.
Usage
| 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. |
_equipLink
|
direct LinkTarget`1<ITool> | This is Internal, and is used by the engine to retrieve the component this field is a part of. It cannot be assigned to. |
TipReference
|
Slot | The slot to use as the tool's tip, instead of the component's slot. |
BlockGripEquip
|
Bool | Whether to prevent legacy double grip equipping from equipping this tooltip. |
BlockRemoteEquip
|
Bool | Whether to prevent equipping by clicking via laser |
EquipName
|
String | The name of the tool in the context menu when equipping via context menu. |
_overrideActiveTool
|
InteractionHandler | The interaction handler to use instead of this tool as an interaction handler. |
_gripPosesGenerated
|
Bool | Whether the Grip Pose Reference components and slots have been generated for this tool. |
Format
|
RecordFormat | The type of audio file to make. |
Quality
|
Float | The quality of the resulting audio clip file. |
Mode
|
RecordMode | Whether the user has to hold or it's a toggle. |
Source
|
DataSource | The way to record the audio. |
RecordingUser
|
User | The user that is currently recording using the Tool. |
RecordingStartTime
|
direct SyncTime | The time that the user started recording in world time. |
IsRecording
|
raw output of Bool | Whether the tool is currently being used to record. |
RecordFormat
| Name | Value | Description |
|---|---|---|
OGG_Vorbis
|
0 | Directional audio with a left and right position. |
WAV
|
1 | Windows audio format |
FLAC
|
2 | Zero compression high quality format. |
RecordMode
| Name | Value | Description |
|---|---|---|
Hold
|
0 | The user has to hold Primary down to record |
Toggle
|
1 | The user has to press Primary to start recording and then press it again to stop recording. |
DataSource
| Name | Value | Description |
|---|---|---|
RAW
|
0 | Raw audio, no normalization |
Normalized
|
1 | Normalized audio, makes audio recording consistent between mic gains. |
Usage
See Microphone.
Examples
See Microphone.