docs: Various minor doc improvements (#2384)
This commit is contained in:
Dermot Duffy
+44
-14
@@ -36,29 +36,34 @@ menu:
|
||||
| `expand` | The `expand` menu button: expand the card into a popup/dialog. |
|
||||
| `folders` | The `folders` menu button: brings the user to a [gallery](./media-gallery.md) of folders on tap and to the media viewer with media from the folder on hold. Will only appear if [`folders`](./folders.md) are configured. |
|
||||
| `fullscreen` | The `fullscreen` menu button: expand the card to consume the fullscreen. Please note that fullscreen behavior on iPhone is limited, see [troubleshooting](../troubleshooting.md?id=fullscreen-doesn39t-work-on-iphone). |
|
||||
| `gallery` | The `gallery` view menu button: brings the user to the `gallery` view of the camera's default media type. |
|
||||
| `image` | The `image` view menu button: brings the user to the static `image` view. |
|
||||
| `info` | The `info` menu button: show media metadata (e.g. event time, camera, description). |
|
||||
| `iris` | The main Advanced Camera Card `iris` menu button: brings the user to the default configured view (`view.default`), or collapses/expands the menu if the `menu.style` is `hidden` . |
|
||||
| `live` | The `live` view menu button: brings the user to the `live` view. |
|
||||
| `media_player` | The `media_player` menu button: sends the visible media to a remote media player. Supports Frigate clips, snapshots and live camera (only for cameras that specify a `camera_entity` and only using the default HA stream (equivalent to the `ha` live provider)). `jsmpeg` or `webrtc-card` are not supported, although live can still be played as long as `camera_entity` is specified. In the player list, a `tap` will send the media to the player, a `hold` will stop the media on the player. |
|
||||
| `microphone` | The `microphone` button allows usage of 2-way audio in certain configurations. See [Using 2-way audio](../usage/2-way-audio.md). |
|
||||
| `mute` | The `mute` button: toggles the mute state of the selected media. |
|
||||
| `play` | The `play` button: toggles the play/pause state of the selected media. |
|
||||
| `ptz_controls` | The `ptz_controls` button shows or hides the PTZ controls. |
|
||||
| `ptz_home` | The `ptz_home` button allows easily returning the camera to default home position. |
|
||||
| `recordings` | The `recordings` view menu button: brings the user to the `recordings` view on tap and the most-recent `recording` view on hold. |
|
||||
| `reviews` | The `reviews` view menu button: brings the user to the `reviews` view on tap and the most-recent `review` view on hold. |
|
||||
| `screenshot` | The `screenshot` menu button: take a screenshot of the loaded media (e.g. a still from a video). |
|
||||
| `set_review` | The `set_review` button: toggle the review status of the media being displayed (e.g. mark it as reviewed or unreviewed). |
|
||||
| `snapshots` | The `snapshots` view menu button: brings the user to the `clips` view on tap and the most-recent `snapshot` view on hold. |
|
||||
| `snapshots` | The `snapshots` view menu button: brings the user to the `snapshots` view on tap and the most-recent `snapshot` view on hold. |
|
||||
| `timeline` | The `timeline` menu button: show the event timeline. |
|
||||
|
||||
### Options for each button
|
||||
|
||||
| Option | Default | Description |
|
||||
| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `alignment` | `matching` | Whether this menu item should have an alignment that is `matching` the menu alignment or `opposing` the menu alignment. Can be used to create two separate groups of buttons on the menu. The `priority` option orders buttons within a given `alignment`. |
|
||||
| `enabled` | `true` for `iris`, `cameras`, `substreams`, `live`, `clips`, `snapshots`, `timeline`, `download`, `camera_ui`, `fullscreen`, `media_player`, `display_mode`, `ptz_home` and `info`. `false` for `image`, `expand`, `microphone`, `mute`, `play`, `recordings`, `screenshot`, `set_review`, `ptz_controls` | Whether or not to show the button. |
|
||||
| `icon` | | An icon to overriding the default for that button, e.g. `mdi:camera-front`. See also [custom icons](../usage/custom-icons.md). |
|
||||
| `permanent` | `false` | If `false` the menu item is hidden when the menu has the `hidden` style and the menu is closed, otherwise it is shown (and sorted to the front). |
|
||||
| `priority` | `50` | The menu item priority. Higher priority items are ordered closer to the start of the menu alignment (i.e. a button with priority `70` will order further to the left than a button with priority `60`). Priority applies separately to `matching` and `opposing` groups (see `alignment` above). Minimum `0`, maximum `100`. |
|
||||
| Option | Default | Description |
|
||||
| ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `alignment` | `matching` | Whether this menu item should have an alignment that is `matching` the menu alignment or `opposing` the menu alignment. Can be used to create two separate groups of buttons on the menu. The `priority` option orders buttons within a given `alignment`. |
|
||||
| `enabled` | `true` for `camera_ui`, `cameras`, `display_mode`, `download`, `folders`, `fullscreen`, `gallery`, `info`, `iris`, `live`, `media_player`, `set_review`, `substreams` and `timeline`. `false` for `clips`, `expand`, `image`, `microphone`, `mute`, `play`, `ptz_controls`, `ptz_home`, `recordings`, `reviews`, `screenshot` and `snapshots`. | Whether or not to show the button. |
|
||||
| `icon` | | An icon to overriding the default for that button, e.g. `mdi:camera-front`. See also [custom icons](../usage/custom-icons.md). |
|
||||
| `permanent` | `false` | If `false` the menu item is hidden when the menu has the `hidden` style and the menu is closed, otherwise it is shown (and sorted to the front). |
|
||||
| `priority` | `50` | The menu item priority. Higher priority items are ordered closer to the start of the menu alignment (i.e. a button with priority `70` will order further to the left than a button with priority `60`). Priority applies separately to `matching` and `opposing` groups (see `alignment` above). Minimum `0`, maximum `100`. |
|
||||
| `state_color` | `true` | Whether to colorize the button based on the state of a related entity (where applicable). |
|
||||
|
||||
### Additional options: `microphone`
|
||||
|
||||
@@ -106,9 +111,14 @@ menu:
|
||||
icon: mdi:video-switch
|
||||
clips:
|
||||
priority: 50
|
||||
enabled: true
|
||||
enabled: false
|
||||
alignment: matching
|
||||
icon: mdi:filmstrip
|
||||
display_mode:
|
||||
priority: 50
|
||||
enabled: true
|
||||
alignment: matching
|
||||
icon: mdi:grid
|
||||
download:
|
||||
priority: 50
|
||||
enabled: true
|
||||
@@ -116,7 +126,7 @@ menu:
|
||||
icon: mdi:download
|
||||
expand:
|
||||
priority: 50
|
||||
enabled: true
|
||||
enabled: false
|
||||
alignment: matching
|
||||
icon: mdi:arrow-expand-all
|
||||
folders:
|
||||
@@ -129,6 +139,11 @@ menu:
|
||||
enabled: true
|
||||
alignment: matching
|
||||
icon: mdi:fullscreen
|
||||
gallery:
|
||||
priority: 50
|
||||
enabled: true
|
||||
alignment: matching
|
||||
icon: mdi:play-box-multiple
|
||||
image:
|
||||
priority: 50
|
||||
enabled: false
|
||||
@@ -151,7 +166,7 @@ menu:
|
||||
icon: mdi:cctv
|
||||
media_player:
|
||||
priority: 50
|
||||
enabled: false
|
||||
enabled: true
|
||||
alignment: matching
|
||||
icon: mdi:cast
|
||||
microphone:
|
||||
@@ -177,17 +192,32 @@ menu:
|
||||
icon: mdi:pan
|
||||
ptz_home:
|
||||
priority: 50
|
||||
enabled: true
|
||||
enabled: false
|
||||
alignment: matching
|
||||
icon: mdi:home
|
||||
set_review:
|
||||
recordings:
|
||||
priority: 50
|
||||
enabled: false
|
||||
alignment: matching
|
||||
icon: mdi:album
|
||||
reviews:
|
||||
priority: 50
|
||||
enabled: false
|
||||
alignment: matching
|
||||
icon: mdi:play-box-edit-outline
|
||||
screenshot:
|
||||
priority: 50
|
||||
enabled: false
|
||||
alignment: matching
|
||||
icon: mdi:monitor-screenshot
|
||||
set_review:
|
||||
priority: 50
|
||||
enabled: true
|
||||
alignment: matching
|
||||
icon: mdi:check-circle
|
||||
snapshots:
|
||||
priority: 50
|
||||
enabled: true
|
||||
enabled: false
|
||||
alignment: matching
|
||||
icon: mdi:camera
|
||||
substreams:
|
||||
|
||||
Reference in New Issue
Block a user