@@ -31,6 +31,8 @@ For the syntax of the commands the following convention is used in this document
...
@@ -31,6 +31,8 @@ For the syntax of the commands the following convention is used in this document
*`<a | b>` is a parameter that is required and has to hold either the value `a` or `b`.
*`<a | b>` is a parameter that is required and has to hold either the value `a` or `b`.
*`[param]` is a parameter that is optional
This is the list of the available commands:
This is the list of the available commands:
### Slot Control Commands
### Slot Control Commands
...
@@ -49,8 +51,8 @@ The current state of the camera feeds is saved in the server's memory and will b
...
@@ -49,8 +51,8 @@ The current state of the camera feeds is saved in the server's memory and will b
| Command | Description
| Command | Description
| --------------------------------- | -----------
| --------------------------------- | -----------
| `set_geometry_relative_to_canvas` | Sets the geometry of the feed on the slot relative to the noVNC canvas. <br/> Note that the pixel values are provided relative to those of the transmitted VNC feed, not those of the canvas. This might change the absolute size of the camera feed depending on the screen size of the viewer. <br/><br/>**Usage**: `set_geometry_relative_to_canvas <slot> <l \| r><t \| b> <x_offset> <y_offset> <width> <height>`. <br/><br/> The positioning is handled like the CSS position attribute. In case you are not familiar with it: l stand for left, r for right, t for top and b for bottom. The x and y offset is then relative to the provided sides. For example the position `rt 21 42` will position the camera feed with a 21px space to the right side and a 42px space to the top side of the canvas.
| `set_geometry_relative_to_canvas` | Sets the geometry of the feed on the slot relative to the noVNC canvas. <br/> Note that the pixel values should be provided relative to those of the transmitted VNC feed, not those of the canvas or window. This might change the absolute size of the camera feed depending on the screen size of the viewer. <br/><br/>**Usage**: `set_geometry_relative_to_canvas <slot> <l \| r><t \| b> <x_offset> <y_offset> <width> <height> [z-index]`. <br/><br/> The positioning is handled like the CSS position attribute. In case you are not familiar with it: l stand for left, r for right, t for top and b for bottom. The x and y offset is then relative to the provided sides. For example the position `rt 21 42` will position the camera feed with a 21px space to the right side and a 42px space to the top side of the canvas.<br/> The z-index defines how the camera feeds are layered, when they overlap. To make sure no undefined behavior occurs, one should make sure that every feed has a different z-index when overlapping the feeds.
| `set_geometry_relative_to_window` | Sets the geometry of the feed on the slot relative to the window of the viewer. <br/> Note that this can cause unwanted behavior. The feeds might look positioned well on your screen, but poorly positioned and cut off on a screen with a different size. `set_geometry_relative_to_canvas` should be used in most cases. <br/><br/>**Usage**: `set_geometry_relative_to_window <slot> <l \| r><t \| b> <x_offset> <y_offset> <width> <height>`. <br/><br/> The exact mechanism of the positioning is described in the description of `set_geometry_relative_to_canvas`.
| `set_geometry_relative_to_window` | Sets the geometry of the feed on the slot relative to the window of the viewer. <br/> Note that this can cause unwanted behavior. The feeds might look positioned well on your screen, but poorly positioned on a screen with a different size. `set_geometry_relative_to_canvas` should be used in most cases, because its pixel values are relative to the size of the transmitted VNC feed. <br/><br/>**Usage**: `set_geometry_relative_to_window <slot> <l \| r><t \| b> <x_offset> <y_offset> <width> <height> [z-index]`. <br/><br/> The parameters work the same way as described in the description of `set_geometry_relative_to_canvas`.
| `hide` | Hides the feed of the provided slot. <br/> Note that the feed will still be transmitted to the viewer but is just hidden. By doing that, the feed can be shown again with a very low latency. <br/><br/>**Usage**: `hide <slot>`
| `hide` | Hides the feed of the provided slot. <br/> Note that the feed will still be transmitted to the viewer but is just hidden. By doing that, the feed can be shown again with a very low latency. <br/><br/>**Usage**: `hide <slot>`
| `show` | Shows the feed of the provided slot in case it was hidden. <br/><br/>**Usage**: `show <slot>`
| `show` | Shows the feed of the provided slot in case it was hidden. <br/><br/>**Usage**: `show <slot>`