advanced-camera-card/docs/configuration/live.md

live

Configures the behavior of the live view.

live: [...]

Option	Default	Description
actions		Actions to use for the live view.
auto_mute	[unselected, hidden, microphone]	A list of conditions in which live camera feeds are muted. unselected will automatically mute when a camera is unselected in the carousel, hidden will automatically mute when the browser/tab becomes hidden or microphone will automatically mute after the microphone is muted as long as the camera stays selected (see the live.microphone.mute_after_microphone_mute_seconds to control how long after). Use an empty list ([]) to never automatically mute. Note that if auto_play is enabled, the stream may mute itself automatically in order to honor the auto_play setting, as some browsers will not auto play media that is unmuted -- that is to say, where necessary, the auto_play parameter will take priority over the auto_mute parameter.
auto_pause	[]	A list of conditions in which live camera feeds are automatically paused. unselected will automatically pause when a camera is unselected in the carousel and hidden will automatically pause when the browser/tab becomes hidden. Use an empty list ([]) to never automatically pause. Caution: Some live providers (e.g. jsmpeg) may not offer human-accessible means to resume play if it is paused, unless the auto_play option is used.
auto_play	[selected, visible]	A list of conditions in which live camera feeds are automatically played.selected will automatically play when a camera is selected in the carousel and visible will automatically play when the browser/tab becomes visible. Use an empty list ([]) to never automatically play. Some live providers (e.g. webrtc-card, jsmpeg) do not support the prevention of automatic play on initial load, but should still respect the value of this flag on play-after-pause.
auto_unmute	[microphone]	A list of conditions in which live camera feeds are unmuted. selected will automatically unmute when a camera is unselected in the carousel, visible will automatically unmute when the browser/tab becomes visible or microphone will automatically unmute after the microphone is unmuted. Use an empty list ([]) to never automatically unmute.
controls		Configuration for the live view controls. See below.
display		Controls whether to show a single or grid live view. See below.
draggable	true	Whether or not the live carousel can be dragged left or right, via touch/swipe and mouse dragging.
lazy_load	true	Whether or not to lazily load cameras in the camera carousel. Setting this will false will cause all cameras to load simultaneously when the live carousel is opened (or cause all cameras to load continually if both lazy_load and preload are true). This will result in a smoother carousel experience at a cost of (potentially) a substantial amount of continually streamed data.
lazy_unload	[]	A list of conditions in which live camera feeds are unloaded. unselected will lazy-unload a camera when it is unselected in the carousel and hidden will lazy-unload all cameras when the browser/tab becomes hidden. Use an empty list ([]) to never automatically unload. This will cause a reloading delay on revisiting that camera in the carousel but will save the streaming network resources that are otherwise consumed. This option has no effect if lazy_load is false. Some live providers (e.g. webrtc-card) implement their own lazy unloading independently which may occur regardless of the value of this setting.
microphone		See below.
preload	false	Whether or not to preload the live view. Preloading causes the live view to render in the background regardless of what view is actually shown, so it's instantly available when requested. This consumes additional network/CPU resources continually.
show_image_during_load	true	If true, during the initial stream load, the image live provider will be shown instead of the loading video stream. This still image will auto-refresh and is replaced with the live stream once loaded.
transition_effect	slide	Effect to apply as a transition between live cameras. Accepted values: slide or none.
zoomable	true	Whether or not the live carousel can be zoomed and panned, via touch/pinch and mouse scroll wheel with ctrl held.

controls

Configure the controls for the live view.

live:
  controls: [...]

Option	Default	Description
builtin	true	Whether to show the built in (browser) video controls on live video.
next_previous		Configures how the "Next & Previous" controls are shown on the live view. See below.
thumbnails		Configures how thumbnails are shown on the live view. See below.
timeline		Configures how the mini-timeline is shown on the live view. See below.
title		Configures how the camera title is shown on the live view. See below.

next_previous

Configures how the "Next & Previous" controls are shown on the live view.

live:
  controls:
    next_previous: [...]

Option	Default	Description
size	48	The size of the next/previous controls in pixels. Must be >= 20.
style	chevrons	When viewing live cameras, what kind of controls to show to move to the previous/next camera. Acceptable values: chevrons, icons, none .

ptz

Configures the PTZ (Pan Tilt Zoom) controls.

live:
  controls:
    ptz: [...]

Option	Default	Description
hide_home	false	When true the Home button of the control is hidden
hide_pan_tilt	false	When true the Pan & Tilt buttons of the control is hidden
hide_zoom	false	When true the Zoom button of the control is hidden
mode	auto	If on or off will always or never show PTZ controls respectively, if auto will show PTZ controls only if the camera supports real PTZ.
orientation	horizontal	Whether to show a vertical or horizontal PTZ control.
position	bottom-right	Whether to position the control on the top-left, top-right, bottom-left or bottom-right. This may be overridden by using the style parameter to precisely control placement.
style		Optionally position and style the element using CSS. Similar to Picture Element styling, except without any default, e.g. left: 42%

To configure the PTZ actions taken for a particular camera, see Camera PTZ Settings.

thumbnails

Configures how thumbnails are shown on the live view.

live:
  controls:
    thumbnails: [...]

Option	Default	Description
events_media_type	all	Whether to show clips, snapshots or all in the thumbnail carousel in the live view. This setting is only relevant when the media_type parameter is set to events.
media_type	events	Whether to load events or recordings media.
mode	none	Whether to show the thumbnail carousel below the media, above the media, in a drawer to the left or right of the media or to hide it entirely (none).
show_details	false	Whether to show event details (e.g. duration, start time, object detected, etc) alongside the thumbnail.
show_download_control	true	Whether to show the download control on each thumbnail.
show_favorite_control	true	Whether to show the favorite ('star') control on each thumbnail.
show_timeline_control	true	Whether to show the timeline ('target') control on each thumbnail.
size	100	The size of the thumbnails in the thumbnail carousel in pixels. Must be >= 75 and <= 175.

timeline

Configures how the mini-timeline is shown on the live view.

live:
  controls:
    timeline: [...]

Option	Default	Description
clustering_threshold	3	The minimum number of overlapping events to allow prior to clustering/grouping them. Higher numbers cause clustering to happen less frequently. Depending on the timescale/zoom of the timeline, the underlying timeline library may still allow overlaps for low values of this parameter -- for a fully "flat" timeline use the ribbon style. 0 disables clustering entirely. Only used in the stack style of timeline.
events_media_type	all	Whether to show only events with clips, events with snapshots or all events. When all is used, clips are favored for events that have both a clip and a snapshot.
mode	none	Whether to show the thumbnail carousel below the media, above the media, in a drawer to the left or right of the media or to hide it entirely (none).
pan_mode	pan	See timeline pan mode.
show_recordings	true	Whether to show recordings on the timeline (specifically: which hours have any recorded content).
style	ribbon	Whether the timeline should show events as a single flat ribbon or a stack of events that are clustered using the clustering_threshold.
window_seconds	3600	The length of the default timeline in seconds. By default, 1 hour (3600 seconds) is shown in the timeline.

title

Configures how the camera title is shown on the live view.

live:
  controls:
    title: [...]

Option	Default	Description
duration_seconds	2	The number of seconds to display the title popup. 0 implies forever.
mode	popup-bottom-right	How to display the live camera title. Acceptable values: none, popup-top-left, popup-top-right, popup-bottom-left, popup-bottom-right .

display

Controls whether to show a single or grid live view.

live:
  display: [...]

Option	Default	Description
grid_columns		If specified the grid will always have exactly this number of columns.
grid_max_columns	4	If specified, and grid_columns is not specified, the grid will not render more than this number of columns. The precise number will be calculated based on the grid layout algorithm.
grid_selected_width_factor	2	How much to scale up the selected media item in a grid. A value of 1 will not scale the selected item at all, the default value of 2 will scale the media item width to twice what it would otherwise be, etc.
mode	single	Whether to display a single live camera in a carousel, or all cameras in a grid configuration.

microphone

Controls the behavior of the microphone in the live view.

live:
  microphone:

Option	Default	Description
always_connected	false	Whether or not to keep the microphone stream continually connected while the card is running, or only when microphone is used (default). In the latter case there'll be a connection reset when the microphone is first used -- using this option can avoid that reset.
disconnect_seconds	90	The number of seconds after microphone usage to disconnect the microphone from the stream. 0 implies never. Not relevant if always_connected is true.
mute_after_microphone_mute_seconds	60	The number of seconds after the microphone mutes to automatically mute the inbound audio when live.auto_mute includes microphone.

See Using 2-way audio for more information about the very particular requirements that must be followed for 2-way audio to work.

Fully expanded reference

live:
  auto_play:
    - selected
    - visible
  auto_pause: []
  auto_mute:
    - unselected
    - hidden
  auto_unmute:
    - microphone
  preload: false
  lazy_load: true
  lazy_unload: []
  draggable: true
  zoomable: true
  transition_effect: slide
  controls:
    builtin: true
    next_previous:
      style: chevrons
      size: 48
    ptz:
      mode: auto
      position: bottom-right
      orientation: horizontal
      hide_pan_tilt: false
      hide_zoom: false
      hide_home: false
      style:
        # Optionally override the default style.
        right: 5%
    thumbnails:
      media_type: events
      events_media_type: all
      size: 100
      show_details: false
      show_download_control: true
      show_favorite_control: true
      show_timeline_control: true
      mode: none
    timeline:
      style: ribbon
      mode: none
      pan_mode: pan
      clustering_threshold: 3
      events_media_type: all
      show_recordings: true
      window_seconds: 3600
    title:
      mode: popup-bottom-right
      duration_seconds: 2
  microphone:
    always_connected: false
    disconnect_seconds: 90
    mute_after_microphone_mute_seconds: 60
  display:
    mode: single
    grid_selected_width_factor: 2
    grid_max_columns: 4
  actions:
    entity: light.office_main_lights
    tap_action:
      action: none
    hold_action:
      action: none
    double_tap_action:
      action: none
    start_tap_action:
      action: none
    end_tap_action:
      action: none