Files
advanced-camera-card/docs/usage/url-actions.md
T

9.5 KiB

URL Actions

It is possible to pass the Advanced Camera Card one or more actions from the URL (e.g. select a particular camera, open the live view in expanded mode, etc).

When actions are executed

The Advanced Camera Card will execute these actions in the following circumstances:

  • On initial card load.
  • On 'tab' change in a dashboard.
  • When a navigate action is called on the dashboard (e.g. a button click requests navigation).
  • When the user uses the back / forward browser buttons whilst viewing a dashboard.

Instructions

To send an action to all Advanced Camera Cards on a dashboard:

[PATH_TO_YOUR_HA_DASHBOARD]?advanced-camera-card-action.[ACTION]=[VALUE]

To send an action to a specific named Advanced Camera Card:

[PATH_TO_YOUR_HA_DASHBOARD]?advanced-camera-card-action.[CARD_ID].[ACTION]=[VALUE]

Note

For backwards compatibility, the card will also respond to frigate-card-action as a query-parameter with the same syntax.

Parameter Description
ACTION One of the supported Advanced Camera Card custom actions. See below.
CARD_ID When specified only cards that have a card_id parameter will act.
VALUE An optional value to use with the camera_select and live_substream_select actions.

Tip

Both . and : may be used as the delimiter. If you use : some browsers may require it be escaped to %3A.

Note

If a dashboard has multiple Advanced Camera Cards on it, even if they are on different 'tabs' within that dashboard, they will all respond to the actions unless the action is targeted with a CARD_ID as shown above.

Supported Actions

Only a subset of all actions are supported in URL form.

Action Supported in URL Explanation
camera_select ✅
camera_ui ✅
clip ✅
clips ✅
default ✅
diagnostics ✅
download ✖️ Latest media information is not available on initial render.
expand ✅
folder ✅
folders ✅
fullscreen ✖️ Javascript does not support activating fullscreen without direct human interaction. Use expand as an alternative.
gallery ✅
image ✅
live_substream_select ✅
live ✅
media ✅
media_player ✖️ Please request if you need this.
menu_toggle ✅
microphone_connect, microphone_disconnect, microphone_mute, microphone_unmute ✖️
mute, unmute ✖️
play, pause ✖️
ptz ✖️ Please request if you need this.
recording ✅
recordings ✅
review ✅
reviews ✅
screenshot ✖️ Latest media information is not available on initial render.
ptz_controls ✖️ Please request if you need this.
snapshot ✅
snapshots ✅

Examples

See URL actions examples.