Component:InteractiveCameraUserItem: Difference between revisions

From Resonite Wiki
Automated: update SyncDelegates
add info
 
Line 3: Line 3:
|Name=Interactive Camera User Item
|Name=Interactive Camera User Item
}}
}}
{{stub}}
See [[Camera]].


== Usage ==
Used to handle the items for each user for the interactive camera settings.
 
== Fields ==
{{Table ComponentFields
{{Table ComponentFields
|Control|'''[[Component:InteractiveCameraControl|InteractiveCameraControl]]'''|TypeAdv0=true|
|Control|'''[[Component:InteractiveCameraControl|InteractiveCameraControl]]'''|TypeAdv0=true| The root camera control settings panel.
|_username|'''[[Component:Text|Text]]'''|TypeAdv1=true|
|_username|'''[[Component:Text|Text]]'''|TypeAdv1=true| The username of the user this item refers to.
|_voiceDefault|'''[[Component:Button|Button]]'''|TypeAdv2=true|
|_voiceDefault|'''[[Component:Button|Button]]'''|TypeAdv2=true| Capture this user's voice as their default voice setting.
|_voiceMute|'''[[Component:Button|Button]]'''|TypeAdv3=true|
|_voiceMute|'''[[Component:Button|Button]]'''|TypeAdv3=true| Capture this user's voice as the mute voice setting.
|_voiceShout|'''[[Component:Button|Button]]'''|TypeAdv4=true|
|_voiceShout|'''[[Component:Button|Button]]'''|TypeAdv4=true| Capture this user's voice as the shout voice setting.
|_voiceBroadcast|'''[[Component:Button|Button]]'''|TypeAdv5=true|
|_voiceBroadcast|'''[[Component:Button|Button]]'''|TypeAdv5=true| Capture this user's voice as the broadcast voice setting.
|_groupAuto|'''[[Component:Button|Button]]'''|TypeAdv6=true|
|_groupAuto|'''[[Component:Button|Button]]'''|TypeAdv6=true| Set this user's group inclusion and exclusion modes to default.
|_groupExclude|'''[[Component:Button|Button]]'''|TypeAdv7=true|
|_groupExclude|'''[[Component:Button|Button]]'''|TypeAdv7=true| Set this user's group inclusion to never.
|_groupInclude|'''[[Component:Button|Button]]'''|TypeAdv8=true|
|_groupInclude|'''[[Component:Button|Button]]'''|TypeAdv8=true| Set this user's group inclusion to always.
|_cameraOperator|'''[[Component:Button|Button]]'''|TypeAdv9=true|
|_cameraOperator|'''[[Component:Button|Button]]'''|TypeAdv9=true| Make this user able to interact with the camera.
|_framingTarget|'''[[Component:Button|Button]]'''|TypeAdv10=true|
|_framingTarget|'''[[Component:Button|Button]]'''|TypeAdv10=true| Make this user a framing target when framing the scene.
|_volumeSlider|'''[[Component:Slider`1|Slider`1]]<[[Type:Float|Float]]>'''|TypeAdv11=true|
|_volumeSlider|'''[[Component:Slider`1|Slider`1]]<[[Type:Float|Float]]>'''|TypeAdv11=true| The user's voice volume when capturing their voice.
}}
}}


== Sync Delegates ==
== Sync Delegates ==
{{Table ComponentTriggers
{{Table ComponentTriggers
|OnVoiceDefault:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OnVoiceDefault:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| A setting changing handler for the panel.
|OnVoiceMute:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OnVoiceMute:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| A setting changing handler for the panel.
|OnVoiceShout:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OnVoiceShout:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| A setting changing handler for the panel.
|OnVoiceBroadcast:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OnVoiceBroadcast:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| A setting changing handler for the panel.
|OnGroupExclude:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OnGroupExclude:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| A setting changing handler for the panel.
|OnGroupAuto:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OnGroupAuto:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| A setting changing handler for the panel.
|OnGroupInclude:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OnGroupInclude:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| A setting changing handler for the panel.
|OnToggleOperator:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OnToggleOperator:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| A setting changing handler for the panel.
|OnSetFramingTarget:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true|
|OnSetFramingTarget:[[Type:ButtonEventHandler|ButtonEventHandler]]|[[Type:ButtonEventHandler|ButtonEventHandler]]|true| A setting changing handler for the panel.
}}
}}


== Behavior ==
== Usage ==
See [[Camera]].


== Examples ==
== Examples ==
See [[Camera]].


== See Also ==
== See Also ==
* [[Camera]]


[[Category:Components:Uncategorized{{#translation:}}|Interactive Camera User Item]]
[[Category:Components:Uncategorized{{#translation:}}|Interactive Camera User Item]]
[[Category:Components{{#translation:}}|Interactive Camera User Item]]
[[Category:Components{{#translation:}}|Interactive Camera User Item]]
[[Category:ComponentStubs]]

Latest revision as of 20:54, 5 April 2025

Component image 
Interactive Camera User Item component as seen in the Scene Inspector

See Camera.

Used to handle the items for each user for the interactive camera settings.

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.
Control InteractiveCameraControl The root camera control settings panel.
_username Text The username of the user this item refers to.
_voiceDefault Button Capture this user's voice as their default voice setting.
_voiceMute Button Capture this user's voice as the mute voice setting.
_voiceShout Button Capture this user's voice as the shout voice setting.
_voiceBroadcast Button Capture this user's voice as the broadcast voice setting.
_groupAuto Button Set this user's group inclusion and exclusion modes to default.
_groupExclude Button Set this user's group inclusion to never.
_groupInclude Button Set this user's group inclusion to always.
_cameraOperator Button Make this user able to interact with the camera.
_framingTarget Button Make this user a framing target when framing the scene.
_volumeSlider Slider`1<Float> The user's voice volume when capturing their voice.

Sync Delegates

Triggers
Method Name Method type and Arguments. Is the method hidden? Description
OnVoiceDefault:ButtonEventHandler ButtonEventHandler A setting changing handler for the panel.
OnVoiceMute:ButtonEventHandler ButtonEventHandler A setting changing handler for the panel.
OnVoiceShout:ButtonEventHandler ButtonEventHandler A setting changing handler for the panel.
OnVoiceBroadcast:ButtonEventHandler ButtonEventHandler A setting changing handler for the panel.
OnGroupExclude:ButtonEventHandler ButtonEventHandler A setting changing handler for the panel.
OnGroupAuto:ButtonEventHandler ButtonEventHandler A setting changing handler for the panel.
OnGroupInclude:ButtonEventHandler ButtonEventHandler A setting changing handler for the panel.
OnToggleOperator:ButtonEventHandler ButtonEventHandler A setting changing handler for the panel.
OnSetFramingTarget:ButtonEventHandler ButtonEventHandler A setting changing handler for the panel.

Usage

See Camera.

Examples

See Camera.

See Also