Component:AvatarLiveIndicator: Difference between revisions

From Resonite Wiki
Automated: update Fields, Categories
Added a description, and a usage for this component.
Line 9: Line 9:


<!--T:2-->
<!--T:2-->
== Intoduction ==
The '''AvatarLiveIndicator''' component is used to show or enable a [[Slot|slot]] (usually a visual) to let other [[User|users]] know that you are live. This activates from the [[Camera#Photo_Controls|streaming camera control panel]], specifically the "Mirror to display" button.


<!--T:3-->
<!--T:3-->
== Usage ==
{{Table ComponentFields
{{Table ComponentFields
|IsLive|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv0=true|
|IsLive|{{RootFieldType|RawOutput`1|[[Type:Bool|Bool]]}}|TypeAdv0=true|
Line 19: Line 18:


<!--T:4-->
<!--T:4-->
== Behavior ==
== Usage ==
Usually this is used with the [[Camera]], especially when streaming. This is also already setup along with the [[Nameplate]] and positioned on it (however, this can be customizable).


<!--T:5-->
<!--T:5-->

Revision as of 05:51, 19 August 2024


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


Component image 
AvatarLiveIndicator component as seen in the Scene Inspector


The AvatarLiveIndicator component is used to show or enable a slot (usually a visual) to let other users know that you are live. This activates from the streaming camera control panel, specifically the "Mirror to display" button.

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.
IsLive raw output of Bool
_activeUser User

Usage

Usually this is used with the Camera, especially when streaming. This is also already setup along with the Nameplate and positioned on it (however, this can be customizable).

Examples

Related Components