I reworded this. Even with my bad writing skills I couldn't really follow...
Line 2:
Line 2:
<translate>
<translate>
<!--T:1-->
<!--T:1-->
{{stub}}
{{Infobox Component
{{Infobox Component
|Image=CameraPermissionsComponent.png
|Image=CameraPermissionsComponent.png
|Name=Camera Permissions
|Name=Camera Permissions
}}
}}
The Camera Permissions component allows you to set up who can use certain camera modes on the streaming camera. Currently, the component allows setting permissions for camera modes per role.
== Intoduction ==
The '''CameraPermissions''' component allows you to set up who can use which camera mode.
<!--T:2-->
<!--T:2-->
Line 15:
Line 12:
{{Table ComponentFields
{{Table ComponentFields
|CameraModeFilterMode|ListFilterMode|Whether to allow or disallow the <code>CameraModes</code>
|CameraModeFilterMode|ListFilterMode|Whether to allow or disallow the <code>CameraModes</code>
|CameraModes|{{RootFieldType|SyncFieldList`1|[[Type:CameraPositioningMode|CameraPositioningMode]]}}|TypeAdv1=true|List of Camera modes which decide how the camera looks at users/the world.
|CameraModes|{{RootFieldType|SyncFieldList`1|[[Type:CameraPositioningMode|CameraPositioningMode]]}}|TypeAdv1=true|List of Camera modes which decide how a stream camera can look at users and/or the world.
|AllowFramingOtherUsers|Bool|Determines whether focusing the camera on other user is allowed.
|AllowFramingOtherUsers|Bool|Determines whether focusing the camera on other user is allowed.
}}
}}
Line 21:
Line 18:
<!--T:3-->
<!--T:3-->
== Usage ==
== Usage ==
Adding an item to the list and giving it the appropriate item from the <code>CameraModes</code> which will then determine what camera mode methods users of that role are allowed to use.
First, add an item to the list of camera modes, and select a role at the bottom. Then, use <code>CameraModeFilterMode</code> to determine if users can use any of the items in the list of camera modes.
<!--T:4-->
<!--T:4-->
== Examples ==
== Examples ==
If the Filter is set to <code>Whitelist</code> and given <code>Group</code> and the component is set to <code>Guest</code> as the role:
If the <code>CameraModeFilterMode</code> field is set to <code>Whitelist</code> and <code>Group</code> is added to the <code>CameraMode</code> list, then the selected role can only use the <code>Group</code> mode with their stream cameras.
It will allow <code>Guest</code> users to only use <code>Group</code> as a way to record their surroundings.
The Camera Permissions component allows you to set up who can use certain camera modes on the streaming camera. Currently, the component allows setting permissions for camera modes per role.
Determines whether focusing the camera on other user is allowed.
Usage
First, add an item to the list of camera modes, and select a role at the bottom. Then, use CameraModeFilterMode to determine if users can use any of the items in the list of camera modes.
Examples
If the CameraModeFilterMode field is set to Whitelist and Group is added to the CameraMode list, then the selected role can only use the Group mode with their stream cameras.
