Scrypted

https://docs.scrypted.app/
Admin
Scrypted is an open-source video integration platform that provides unified management of security...
Tokens:7,968
Snippets:80
Trust Score:8.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### Install Video Analysis Plugin

Source: https://docs.scrypted.app/detection/smart-occupancy-sensor

Instructions to install the 'Video Analysis Plugin' which is a prerequisite for setting up the Smart Occupancy Sensor. No specific code example is provided, but it's a configuration step within the Scrypted environment.

--------------------------------

### Install Scrypted on Proxmox VE (Bash)

Source: https://docs.scrypted.app/install/proxmox-ve

Installs Scrypted on a Proxmox VE host by downloading and executing a setup script. This script facilitates the setup of a Scrypted container and prompts for GPU and Coral Edge TPU passthrough configuration.

```bash
cd /tmp
curl -s https://raw.githubusercontent.com/koush/scrypted/main/install/proxmox/install-scrypted-proxmox.sh > install-scrypted-proxmox.sh
bash install-scrypted-proxmox.sh
```

--------------------------------

### Download Proxmox VE Scrypted NVR Volume Setup Script

Source: https://docs.scrypted.app/scrypted-nvr/storage/proxmox

Downloads the setup script from GitHub to the /tmp directory on the Proxmox VE server. This script is used to configure storage for Scrypted's NVR plugin.

```shell
cd /tmp
curl -s https://raw.githubusercontent.com/koush/scrypted/main/install/proxmox/setup-scrypted-nvr-volume.sh > setup-scrypted-nvr-volume.sh
```

--------------------------------

### Install Intel NPU Driver on Proxmox VE (Bash)

Source: https://docs.scrypted.app/install/proxmox-ve

Installs the Intel NPU driver for Core Ultra processors on a Proxmox VE host by downloading and executing an installation script.

```bash
cd /tmp
curl -s https://raw.githubusercontent.com/koush/scrypted/main/install/docker/install-intel-npu.sh > install-intel-npu.sh
INTEL_FW_NPU=true bash install-intel-npu.sh
```

--------------------------------

### Download Scrypted NVR Volume Setup Script (Shell)

Source: https://docs.scrypted.app/scrypted-nvr/storage/docker

Downloads the setup script for configuring Scrypted NVR Docker volumes. This script automates the process of setting up a disk or existing directory for recordings.

```shell
mkdir -p ~/.scrypted
curl -s https://raw.githubusercontent.com/koush/scrypted/main/install/docker/setup-scrypted-nvr-volume.sh > ~/.scrypted/setup-scrypted-nvr-volume.sh
```

--------------------------------

### Install Scrypted Docker Compose Script (Shell)

Source: https://docs.scrypted.app/install/linux-docker

This script downloads the necessary docker-compose.yml file, installs Scrypted as a service using Docker, and then removes the downloaded script. It requires sudo privileges for service installation.

```shell
curl -s https://raw.githubusercontent.com/koush/scrypted/main/install/docker/install-scrypted-docker-compose.sh > ~/install-scrypted-docker-compose.sh 
sudo SERVICE_USER=$USER bash ~/install-scrypted-docker-compose.sh
rm ~/install-scrypted-docker-compose.sh
```

--------------------------------

### Install Scrypted Desktop App (Debian/Ubuntu)

Source: https://docs.scrypted.app/install/desktop-app

Adds the Scrypted apt repository and installs the scrypted-electron package. This is the recommended way to install the Desktop App on Debian-based systems.

```sh
echo 'deb [trusted=yes] https://nuts.scrypted.app/apt stable main' | sudo tee /etc/apt/sources.list.d/scrypted.list
sudo apt update
sudo apt install scrypted-electron
```

--------------------------------

### Run Proxmox VE Scrypted NVR Volume Setup Script

Source: https://docs.scrypted.app/scrypted-nvr/storage/proxmox

Executes the downloaded setup script to configure a Proxmox VE storage volume for Scrypted's NVR. It stops Scrypted, adds the storage, and restarts Scrypted. The script takes the storage name as an argument.

```shell
bash setup-scrypted-nvr-volume.sh nvr-storage
```

--------------------------------

### Format and Use New Disk for Scrypted NVR (Shell)

Source: https://docs.scrypted.app/scrypted-nvr/storage/docker

Formats a new disk (e.g., sdx) and configures it for Scrypted NVR recordings using the setup script. This prepares the disk for storing video recordings.

```shell
sudo SERVICE_USER=$USER bash ~/.scrypted/setup-scrypted-nvr-volume.sh sdx
```

--------------------------------

### Install Scrypted NVR Dependencies and Service on Windows

Source: https://docs.scrypted.app/install/windows-powershell

This command downloads and executes a PowerShell script that installs all necessary dependencies for Scrypted, including Node.js and Python, and then sets up Scrypted to run as a service. It requires administrator privileges.

```powershell
iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/koush/scrypted/main/install/local/install-scrypted-dependencies-win.ps1'))
```

--------------------------------

### Event Reel Card Configuration Example (YAML)

Source: https://docs.scrypted.app/home-assistant

This YAML configuration demonstrates how to set up an Event Reel card in a Home Assistant-like interface. It specifies the iframe URL with parameters for filtering events by camera IDs and setting the grid layout.

```yaml
type: iframe
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframeevents?ids=<id1>,<id2>&cols=4
allow_open_top_navigation: true
type: iframe
url: >-
  /api/scrypted/3713673acab4bdd3214e673700fe48d4/endpoint/@scrypted/nvr/public/#/iframe/41?cols=1&videoClick=ha&live=true
allow_open_top_navigation: true
layout_options:
  grid_columns: full
  grid_rows: 2.3
```

--------------------------------

### Install Coral USB Drivers on Proxmox VE (Bash)

Source: https://docs.scrypted.app/install/proxmox-ve

Installs the Coral Edge TPU USB driver on a Proxmox VE host by adding a Google APT repository and installing the 'libedgetpu1-max' package.

```bash
echo "deb https://packages.cloud.google.com/apt coral-edgetpu-stable main" | tee /etc/apt/sources.list.d/coral-edgetpu.list
curl https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key add -
apt-get -y update
apt-get -y install libedgetpu1-max
```

--------------------------------

### Install Coral M.2/PCI Drivers on Proxmox VE (Bash)

Source: https://docs.scrypted.app/install/proxmox-ve

Installs the gasket-dkms driver from source on a Proxmox VE host for Coral M.2/PCI devices. This process requires the 'pve-no-subscription' repository and builds the driver using debuild.

```bash
apt remove -y gasket-dkms
apt install -y git devscripts dh-dkms dkms pve-headers-$(uname -r)
cd /tmp
rm -rf gasket-drivergit clone https://github.com/google/gasket-driver.git
cd gasket-driver/
debuild -us -uc -tc -b
dpkg -i ../gasket-dkms_1.0-18_all.deb
```

--------------------------------

### Run Docker Compose

Source: https://docs.scrypted.app/detection/object-detection

Commands to stop, remove, and then start Docker containers using Docker Compose, typically used after modifying docker-compose.yml to pass through devices for hardware acceleration.

```bash
cd ~/.scrypted
docker compose down
docker compose up -d
```

--------------------------------

### Configure Existing Storage Directory (Shell)

Source: https://docs.scrypted.app/scrypted-nvr/storage/docker

Configures Scrypted NVR to use an existing storage directory by running the setup script with the path to the directory. Assumes the directory is on an ext4 filesystem.

```shell
sudo SERVICE_USER=$USER bash ~/.scrypted/setup-scrypted-nvr-volume.sh /path/to/existing/directory
```

--------------------------------

### Install Scrypted Dependencies and Service on Mac (Shell)

Source: https://docs.scrypted.app/install/mac-terminal

This script installs necessary dependencies for Scrypted on macOS, including Node.js and Python. It then installs Scrypted as a service and cleans up the downloaded script. Ensure Homebrew is installed prior to running this script.

```shell
curl -s https://raw.githubusercontent.com/koush/scrypted/main/install/local/install-scrypted-dependencies-mac.sh > ~/install-scrypted-dependencies-mac.sh 
bash ~/install-scrypted-dependencies-mac.sh
rm ~/install-scrypted-dependencies-mac.sh
```

--------------------------------

### List Available Disks (Shell)

Source: https://docs.scrypted.app/scrypted-nvr/storage/docker

Lists all block devices available on the system, used to identify the disk to be formatted for Scrypted NVR recordings. The output helps in selecting the correct device name (e.g., sdx).

```shell
lsblk
```

--------------------------------

### Add Fast Disk for Scrypted NVR in Proxmox VE

Source: https://docs.scrypted.app/scrypted-nvr/storage/proxmox

Uses the setup script with the FAST_DISK=true environment variable to add a fast storage volume for Scrypted's NVR. This is typically for performance-sensitive storage.

```shell
FAST_DISK=true bash setup-scrypted-nvr-volume.sh fast-nvr-storage
```

--------------------------------

### Automate Backup Request

Source: https://docs.scrypted.app/maintenance/migration

Example of using curl to automate Scrypted backups via the web interface. Requires Basic authentication.

```shell
curl -u admin:password https://[scrypted-server-ip]:10443/web/component/backup --output backup.zip
```

--------------------------------

### Scrypted NVR Docker Compose Configuration (YAML)

Source: https://docs.scrypted.app/scrypted-nvr/storage/docker

Defines the Docker services for Scrypted NVR, including environment variables for webhook integration and optional Nvidia GPU support, and volume mounts for storing recordings and the database.

```yaml
services:
  scrypted:
    environment:
      # Scrypted NVR Storage (Part 2 of 3)

      # Uncomment this line to configure the NVR plugin to store
      # recordings within the /nvr directory inside the container.
      # DO NOT MODIFY /nvr.
      # The Recordings Directory in the NVR Plugin will autopopulate
      # with /nvr (unless it was manually changed earlier).
      # The disk or network share will ALSO need to be configured in
      # Part 3.
      - SCRYPTED_NVR_VOLUME=/nvr

      - SCRYPTED_WEBHOOK_UPDATE_AUTHORIZATION=Bearer SET_THIS_TO_SOME_RANDOM_TEXT
      - SCRYPTED_WEBHOOK_UPDATE=http://localhost:10444/v1/update

      # Uncomment next 3 lines for Nvidia GPU support.
      # - NVIDIA_VISIBLE_DEVICES=all
      # - NVIDIA_DRIVER_CAPABILITIES=all

      # Uncomment next line to run avahi-daemon inside the container
      # Don't use if dbus and avahi run on the host and are bind-mounted
      # (see below under "volumes")
      # - SCRYPTED_DOCKER_AVAHI=true
    # runtime: nvidia

    volumes:
      # Scrypted NVR Storage (Part 3 of 3)

      # Modify to add the add a Recordings Directory for Scrypted NVR.
      # The following example would mount the /mnt/media/video path on
      # the host to the /nvr path inside the docker container.
      # Modify /mnt/media/video according to the server path.
      # DO NOT MODIFY /nvr.
      - /mnt/media/video:/nvr

      # Or use a network mount from one of the CIFS/NFS examples at the top of this file.
      # - type: volume
      #   source: nvr
      #   target: /nvr
      #   volume:
      #     nocopy: true

      # uncomment the following lines to expose Avahi, an mDNS advertiser.
      # make sure Avahi is running on the host machine, otherwise this will not work.
      # not compatible with Avahi enabled via SCRYPTED_DOCKER_AVAHI=true
      # - /var/run/dbus:/var/run/dbus
      # - /var/run/avahi-daemon/socket:/var/run/avahi-daemon/socket

      # Default volume for the Scrypted database. Typically should not be changed.
      - ~/.scrypted/volume:/server/volume
```

--------------------------------

### Reset Proxmox VE Scrypted Container (Bash)

Source: https://docs.scrypted.app/install/proxmox-ve

Resets the Proxmox VE Scrypted installation to its default state using the installation script with the SCRYPTED_RESTORE=true flag. This process preserves data and recordings but requires running the script on the Proxmox VE Host shell.

```bash
cd /tmp
curl -s https://raw.githubusercontent.com/koush/scrypted/main/install/proxmox/install-scrypted-proxmox.sh > install-scrypted-proxmox.sh
SCRYPTED_RESTORE=true bash install-scrypted-proxmox.sh
```

--------------------------------

### Add Additional Disk for Scrypted NVR in Proxmox VE

Source: https://docs.scrypted.app/scrypted-nvr/storage/proxmox

Uses the setup script with the ADD_DISK=true environment variable to add an additional storage volume for Scrypted's NVR. This is for scenarios with multiple storage devices.

```shell
ADD_DISK=true bash setup-scrypted-nvr-volume.sh another-nvr-storage
```

--------------------------------

### Home Assistant Webpage Card Configuration

Source: https://docs.scrypted.app/home-assistant

Example configuration for a Home Assistant Webpage Card to display Scrypted NVR content. This card uses an iframe to embed the Scrypted NVR interface, with options for grid layout.

```yaml
type: iframe
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>
allow_open_top_navigation: true
layout_options:
  grid_columns: full
  grid_rows: 4.25
```

--------------------------------

### Mount Host Path as Scrypted NVR Volume in Proxmox VE

Source: https://docs.scrypted.app/scrypted-nvr/storage/proxmox

Configures the setup script to mount an existing host path (e.g., a ZFS array directory) as a volume for Scrypted's NVR. This allows using pre-existing storage locations.

```shell
bash setup-scrypted-nvr-volume.sh nvr-storage /my-raid-device/scrypted-nvr/
```

--------------------------------

### Set PowerShell Execution Policy to Unrestricted

Source: https://docs.scrypted.app/install/windows-powershell

This command allows PowerShell to run unsigned scripts, which is necessary for the Scrypted installation script. It prompts for confirmation before changing the policy.

```powershell
Set-ExecutionPolicy Unrestricted
```

--------------------------------

### Locate Scrypted Database (Linux)

Source: https://docs.scrypted.app/maintenance/migration

Default path for the Scrypted database volume on Linux installations.

```text
~/.scrypted/volume
```

--------------------------------

### Locate Scrypted Database (Windows)

Source: https://docs.scrypted.app/maintenance/migration

Default path for the Scrypted database volume on Windows installations.

```text
%USERPROFILE%\.scrypted\volume
```

--------------------------------

### Tensorflow Lite EdgeTPU Docker Integration

Source: https://docs.scrypted.app/detection/object-detection

Example log output indicating the successful detection and addition of a Coral EdgeTPU device within a Docker container for Tensorflow Lite object detection.

```text
edge tpus [{'type': 'pci', 'path': '/dev/apex_0'}]
model: yolov8n_full_integer_quant_320
added tpu {'type': 'pci', 'path': '/dev/apex_0'}
```

--------------------------------

### Restart Scrypted Docker Containers (Shell)

Source: https://docs.scrypted.app/scrypted-nvr/storage/docker

Restarts the Scrypted Docker containers after manual configuration changes to the docker-compose.yaml file. This applies the updated volume and environment settings.

```shell
cd ~/.scrypted && docker compose down && docker compose up -d
```

--------------------------------

### Configure Scrypted Cluster Client (.env)

Source: https://docs.scrypted.app/maintenance/cluster

Configures a Scrypted installation as a cluster client to perform video decoding and detection. It specifies the server's IP address, the shared secret, and labels that indicate the client's capabilities, such as compute and transcode workloads.

```sh
# Set worker type. There can be multiple clients.
SCRYPTED_CLUSTER_MODE=client
# this is the IP of the server machine,
# matching the SCRYPTED_CLUSTER_ADDRESS in the prior section.
SCRYPTED_CLUSTER_SERVER=192.168.2.130
SCRYPTED_CLUSTER_SECRET=swordfish
# designate this worker as available for decode and detection workloads
SCRYPTED_CLUSTER_LABELS=compute,transcode,@scrypted/openvino
# if this is a mac, delete the previous line and
# use @scrypted/coreml label instead
# SCRYPTED_CLUSTER_LABELS=compute,transcode,@scrypted/coreml
```

--------------------------------

### Add Scrypted Custom Repository to HACS

Source: https://docs.scrypted.app/home-assistant

Adds the Scrypted custom component repository to Home Assistant Community Store (HACS) for installation. This is a prerequisite for integrating Scrypted with Home Assistant.

```text
https://github.com/koush/ha_scrypted
```

--------------------------------

### Configure Scrypted Cluster Server (.env)

Source: https://docs.scrypted.app/maintenance/cluster

Sets up a Scrypted installation as a cluster server by defining its worker type, IP address, secret, and labels. This configuration is essential for ingesting camera streams and managing cluster operations.

```sh
# Set worker type. There can only be one server.
SCRYPTED_CLUSTER_MODE=server
# This is the IP of this machine.
SCRYPTED_CLUSTER_ADDRESS=192.168.2.130
SCRYPTED_CLUSTER_SECRET=swordfish
SCRYPTED_CLUSTER_LABELS=storage
```

--------------------------------

### Main Stream Resolution and Bitrate Settings

Source: https://docs.scrypted.app/camera-preparation

Recommended resolution and bitrate settings for the main stream to balance quality and performance, especially when substreams are not heavily utilized.

```General
Main Stream Resolution| Bitrate  
---|---
3840x2160| 8 Mbit, Variable/VBR  
2688x1520| 3.5 Mbit, Variable/VBR  
1920x1080| 2 Mbit, Variable/VBR
```

--------------------------------

### Enable All Streams and Audio

Source: https://docs.scrypted.app/camera-preparation

Ensures all available video and audio streams are enabled on the camera for optimal performance with Scrypted. This is crucial as Scrypted may utilize multiple streams for different functions.

```General
Ensure audio is also enabled on all the streams.
```

--------------------------------

### Configure Camera Grid Card

Source: https://docs.scrypted.app/home-assistant

Sets up a Camera Grid card to display multiple camera feeds. It specifies the URL format for the grid and includes layout options for columns and rows.

```yaml
type: iframe
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframegrid?ids=<id1>,<id2>
allow_open_top_navigation: true
layout_options:
  grid_columns: full
  grid_rows: 9.5
```

--------------------------------

### Customize Camera Grid Layout (Desktop Min Width)

Source: https://docs.scrypted.app/home-assistant

Allows customization of the Camera Grid layout by setting a minimum width for desktop viewports using 'desktopMinWidth'. This influences the number of columns displayed based on screen width.

```yaml
# Example for setting minimum desktop width
# desktopMinWidth: 480
```

--------------------------------

### Framerate and Keyframe Interval Settings

Source: https://docs.scrypted.app/camera-preparation

Optimal settings for framerate and keyframe interval (I-Frame Interval) to ensure smooth video playback and efficient streaming.

```General
Frame Rate| Interval| Space  
---|---|---
20| 80| 4 (or 2)
```

```General
Frame Rate| Interval| Space  
---|---|---
10| 40| 4 (or 2)
```

--------------------------------

### Combine Multiple Parameters

Source: https://docs.scrypted.app/home-assistant

Multiple parameters can be combined in the URL using the `&` symbol to customize the camera stream.

```APIDOC
## GET /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>

### Description
Retrieves a camera stream with multiple custom parameters.

### Method
GET

### Endpoint
`/api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>`

### Query Parameters
- **imageClick** (string) - Optional - Action on image click. Example: `ha`.
- **videoClick** (string) - Optional - Action on video click. Example: `ha`.
- **live** (boolean) - Optional - Whether to enable live mode. Example: `true`.

### Request Example
```yaml
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?imageClick=ha&videoClick=ha&live=true
```

### Response
#### Success Response (200)
- **stream_url** (string) - The URL for the customized camera stream.

#### Response Example
(No specific example provided in source text)
```

--------------------------------

### Dropping Sample Image for Object Detection Test

Source: https://docs.scrypted.app/scrypted-nvr/troubleshooting

This section demonstrates how to test the object detection functionality by dropping a sample image into the Scrypted NVR Object Detection interface. It assumes the user has saved a sample image and is using the desktop browser interface.

```Text/UI Interaction
Save the following image and dropping it into `Scrypted NVR Object Detection`:
```

--------------------------------

### Combine Multiple URL Parameters

Source: https://docs.scrypted.app/home-assistant

Demonstrates how to combine multiple parameters in a URL using the '&' character for various functionalities like click actions and live view.

```yaml
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?imageClick=ha&videoClick=ha&live=true
```

--------------------------------

### Configure Scrypted NVR Card Video Click Action

Source: https://docs.scrypted.app/home-assistant

Defines the behavior when the live video in the Scrypted NVR card is clicked. Setting 'videoClick=ha' will open the Home Assistant companion app, allowing interaction within the Home Assistant ecosystem.

```yaml
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?videoClick=ha
```

--------------------------------

### Configure Scrypted NVR Card Image Click Action

Source: https://docs.scrypted.app/home-assistant

Sets the action to perform when the snapshot image in the Scrypted NVR card is clicked. The 'imageClick=ha' parameter directs the action to open the Home Assistant companion app.

```yaml
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?imageClick=ha
```

--------------------------------

### Substream Resolution and Bitrate Settings

Source: https://docs.scrypted.app/camera-preparation

Recommended resolution and bitrate settings for substreams, which are typically used for lower-bandwidth scenarios like remote viewing or motion detection.

```General
Stream| Max Resolution| Bitrate  
---|---|---
Substream 1 or 2| 1280x720| 1 Mbit, variable  
Substream 1 or 2| 640x360| 500 Kbit, variable
```

--------------------------------

### Configure H.264 Video Codec

Source: https://docs.scrypted.app/camera-preparation

Sets the video codec to H.264 (or Main profile) for compatibility with HomeKit, Google Home, Alexa, and web clients. Disables special variants like H.264+ or Smart Codec.

```General
Set all the stream video codecs to `H.264` (M or Main profile if specifiable). Do **NOT** use `H.264+`, `Super H.264`, etc: **TURN OFF/DISABLE ALL SPECIAL VARIANTS**. Sometimes this unsupported variant setting is called `Smart Code(c)` and it should be set to `Close` or `Off`.
```

--------------------------------

### Customize Camera Grid Layout (Columns)

Source: https://docs.scrypted.app/home-assistant

Provides options to customize the Camera Grid layout by setting a fixed number of columns across all devices and screen orientations using the 'cols' parameter.

```yaml
# Example for setting a fixed number of columns
# cols: <number_of_columns>
```

--------------------------------

### Focus Camera Grid on Motion

Source: https://docs.scrypted.app/home-assistant

Configures the Camera Grid to focus on cameras with ongoing motion using the 'focus' parameter. When no motion is detected, all cameras are displayed.

```yaml
# Example for focusing on motion
# focus: true
```

--------------------------------

### Camera Grid Layout Customization

Source: https://docs.scrypted.app/home-assistant

Customize the layout of the Camera Grid card using parameters like `desktopMinWidth`, `cols`, and `focus` to control column behavior, cell width, and motion focus.

```APIDOC
## GET /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframegrid

### Description
Retrieves a camera grid with customized layout options.

### Method
GET

### Endpoint
`/api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframegrid`

### Query Parameters
- **ids** (string) - Required - Comma-separated list of device IDs.
- **phonePortraitCols** (string) - Optional - Columns for phone portrait view. Default: `1`.
- **phoneLandscapeCols** (string) - Optional - Columns for phone landscape view. Default: `2`.
- **tabletPortraitCols** (string) - Optional - Columns for tablet portrait view. Default: `2`.
- **tabletLandscapeCols** (string) - Optional - Columns for tablet landscape view. Default: `3`.
- **desktopMinWidth** (string) - Optional - Minimum width for desktop cells. Default: `480` (pixels).
- **cols** (string) - Optional - Fixed number of columns for all screen sizes.
- **focus** (string) - Optional - Focus on cameras with motion.

### Request Example
```yaml
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframegrid?ids=1,2,3&desktopMinWidth=720&cols=4&focus=true
```

### Response
#### Success Response (200)
- **grid_url** (string) - The URL for the customized camera grid.

#### Response Example
(No specific example provided in source text)
```

--------------------------------

### Configure Stream Resolution

Source: https://docs.scrypted.app/home-assistant

Control the resolution of the Card live stream by setting the `destination` parameter. Supported values are `low-resolution`, `remote`, and `local`. Using `local` is not recommended for multiple cards as it can cause sluggishness.

```APIDOC
## GET /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>

### Description
Retrieves a live stream for a specific camera.

### Method
GET

### Endpoint
`/api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>`

### Query Parameters
- **destination** (string) - Optional - Specifies the stream resolution. Supported values: `low-resolution`, `remote`, `local`.

### Request Example
```yaml
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?destination=local
```

### Response
#### Success Response (200)
- **stream_url** (string) - The URL for the live stream.

#### Response Example
(No specific example provided in source text)
```

--------------------------------

### Set Live Stream Resolution (local)

Source: https://docs.scrypted.app/home-assistant

Configures the live stream resolution for a card to 'local'. This uses the high-resolution stream, which is not recommended for multiple cards as it can impact performance.

```yaml
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?destination=local
```

--------------------------------

### Enable Auto Play for Scrypted NVR Card

Source: https://docs.scrypted.app/home-assistant

Configures the Scrypted NVR card to automatically play video content when the card loads. This is achieved by appending the 'live=true' query parameter to the card's URL.

```yaml
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?live=true
```

--------------------------------

### Make Camera Grid Scrollable

Source: https://docs.scrypted.app/home-assistant

Configures the Camera Grid card to be scrollable, allowing users to navigate through multiple camera feeds.

```yaml
type: iframe
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframegrid?ids=1,2,3&scrollable=true
allow_open_top_navigation: true
```

--------------------------------

### Enable Microphone and Speaker

Source: https://docs.scrypted.app/home-assistant

Enables two-way audio for the live stream by turning on both the microphone and speaker. Browsers may require user interaction (click) to allow microphone access.

```yaml
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?speaker=on&microphone=on
```

--------------------------------

### Set Live Stream Resolution (remote)

Source: https://docs.scrypted.app/home-assistant

Configures the live stream resolution for a card to 'remote'. This is the default and uses a lower resolution stream, suitable for small frames and minimal resource usage.

```yaml
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?destination=remote
```

--------------------------------

### Enable Audio and Microphone

Source: https://docs.scrypted.app/home-assistant

Enable two-way audio by setting `microphone=on` and `speaker=on`. Browsers may prevent autoplay with audio without user interaction. Ensure your browser is set to allow audio and microphone access.

```APIDOC
## GET /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>

### Description
Retrieves a live stream with two-way audio enabled.

### Method
GET

### Endpoint
`/api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>`

### Query Parameters
- **microphone** (string) - Optional - Enables the microphone. Value: `on`.
- **speaker** (string) - Optional - Enables the speaker. Value: `on`.

### Request Example
```yaml
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframe/<id>?speaker=on&microphone=on
```

### Response
#### Success Response (200)
- **stream_url** (string) - The URL for the live stream with audio enabled.

#### Response Example
(No specific example provided in source text)
```

--------------------------------

### Camera Grid Card Configuration

Source: https://docs.scrypted.app/home-assistant

Configure the Camera Grid card to display multiple cameras. The `ids` parameter takes a comma-separated list of device IDs. Layout options like `grid_columns` and `grid_rows` can be used for customization.

```APIDOC
## iframe

### Description
Card type for displaying camera feeds, including a grid of multiple cameras.

### Parameters
- **type** (string) - Required - The card type, must be `iframe`.
- **url** (string) - Required - The URL for the camera feed or grid. Format: `/api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframegrid?ids=<id1>,<id2>`.
- **allow_open_top_navigation** (boolean) - Optional - Allows opening top navigation.
- **layout_options** (object) - Optional - Options for grid layout.
  - **grid_columns** (string) - Optional - Sets the number of columns for the grid. Example: `full`.
  - **grid_rows** (number) - Optional - Sets the number of rows to display. Example: `9.5`.

### Request Example
```yaml
type: iframe
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframegrid?ids=<id1>,<id2>
allow_open_top_navigation: true
layout_options:
  grid_columns: full
  grid_rows: 9.5
```

### Response
#### Success Response (200)
- **card_configuration** (object) - The configuration for the iframe card.

#### Response Example
(No specific example provided in source text)
```

--------------------------------

### Configure Scrollable Camera Grid

Source: https://docs.scrypted.app/home-assistant

Make the Camera Grid card scrollable by setting `scrollable=true`. This is useful for displaying multiple cameras.

```APIDOC
## GET /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframegrid

### Description
Retrieves a scrollable camera grid.

### Method
GET

### Endpoint
`/api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframegrid`

### Query Parameters
- **ids** (string) - Required - Comma-separated list of device IDs to display.
- **scrollable** (string) - Optional - Enables scrolling for the grid. Value: `true`.

### Request Example
```yaml
type: iframe
url: >-
  /api/scrypted/<token>/endpoint/@scrypted/nvr/public/#/iframegrid?ids=1,2,3&scrollable=true
allow_open_top_navigation: true
```

### Response
#### Success Response (200)
- **grid_url** (string) - The URL for the scrollable camera grid.

#### Response Example
(No specific example provided in source text)
```

--------------------------------

### Stop Scrypted Server (Mac)

Source: https://docs.scrypted.app/maintenance/migration

Commands to stop and remove the Scrypted launch agent on macOS.

```shell
launchctl unload ~/Library/LaunchAgents/app.scrypted.server.plist 
rm ~/Library/LaunchAgents/app.scrypted.server.plist
rm -rf ~/.scrypted/node_modules
```

--------------------------------

### Scrypted Camera Device Validation Output

Source: https://docs.scrypted.app/camera-validation

This output shows the results of a device validation process for a 'Kitchen' camera within Scrypted. It lists various checks performed, such as device capabilities, motion detection, snapshot functionality, and stream integrity, indicating whether each check passed ('OK'), is running, or was skipped.

```text
============================================
Device Validation: Kitchen
============================================
Device Selected          Running
                         OK
Device Capabilities      Running
                         OK
Motion Detection         Running
                         OK
Recent Motion            Running
                         OK
Snapshot                 Running
                         OK
Streams                  Running
                         OK
Local                    Running
                         OK
Local (IDR)              Running
                         OK
Local Recorder           Running
                         Skipped (Duplicate)
Remote Recorder          Running
                         OK
Remote Recorder (IDR)    Running
                         OK
Remote                   Running
                         Skipped (Duplicate)
Low Resolution           Running
                         OK
Low Resolution (IDR)     Running
                         OK
Audio Codecs             Running
                         OK
============================================
Device Validation Complete: Kitchen
============================================

```

--------------------------------

### Stop Scrypted Server for Manual Backup (Mac)

Source: https://docs.scrypted.app/maintenance/migration

Commands to unload the Scrypted launch agent and remove its property list file on macOS for manual backup.

```shell
launchctl unload ~/Library/LaunchAgents/app.scrypted.server.plist 
rm ~/Library/LaunchAgents/app.scrypted.server.plist
```

--------------------------------

### Stop Scrypted Server (Docker Compose)

Source: https://docs.scrypted.app/maintenance/migration

Command to stop the Scrypted service using Docker Compose.

```shell
cd ~/.scrypted
docker compose down
rm -rf ~/.scrypted/node_modules
```

--------------------------------

### Stop Scrypted Server for Manual Backup (Windows)

Source: https://docs.scrypted.app/maintenance/migration

Commands to stop and delete the Scrypted service on Windows using sc.exe for manual backup.

```powershell
sc.exe stop scrypted.exe
sc.exe delete scrypted.exe
```

--------------------------------

### Stop Scrypted Server for Manual Backup (Linux)

Source: https://docs.scrypted.app/maintenance/migration

Commands to stop the Scrypted service and remove its systemd unit file on Linux for manual backup.

```shell
sudo systemctl stop scrypted.service
sudo rm /etc/systemd/system/scrypted.service
```

--------------------------------

### Create Reset File for Scrypted (Windows Command Prompt)

Source: https://docs.scrypted.app/maintenance/lost-password

Creates an empty file named 'reset-login' in the .scrypted\volume directory within the user's profile directory. This command is used on Windows systems to reset Scrypted user credentials.

```batch
type nul > %USERPROFILE%\.scrypted\volume\reset-login
```

--------------------------------

### Stop Scrypted Server for Manual Backup (Docker Compose)

Source: https://docs.scrypted.app/maintenance/migration

Command to stop Scrypted when using Docker Compose for manual backup operations.

```shell
cd ~/.scrypted
docker compose down
```

--------------------------------

### Stop Scrypted Server (Linux)

Source: https://docs.scrypted.app/maintenance/migration

Commands to stop the Scrypted systemd service and remove its configuration file on Linux.

```shell
sudo systemctl stop scrypted.service
sudo rm /etc/systemd/system/scrypted.service
rm -rf ~/.scrypted/node_modules
```

--------------------------------

### Stop Scrypted Server (Windows)

Source: https://docs.scrypted.app/maintenance/migration

Commands to stop and delete the Scrypted service on Windows using PowerShell.

```powershell
sc.exe stop scrypted.exe
sc.exe delete scrypted.exe
Remove-Item -Recurse -Force $env:USERPROFILE\.scrypted\node_modules
```

--------------------------------

### Create Reset File for Scrypted (Linux/Mac)

Source: https://docs.scrypted.app/maintenance/lost-password

Creates an empty file named 'reset-login' in the .scrypted/volume directory within the user's home directory. This action is used to reset Scrypted user credentials. It is designed for Unix-like systems.

```shell
touch ~/.scrypted/volume/reset-login
```

--------------------------------

### NVIDIA Docker Image for Scrypted

Source: https://docs.scrypted.app/scrypted-nvr/features

Specifies the NVIDIA Docker image required for Scrypted NVR to utilize NVIDIA GPUs for object detection. This image includes CUDA support.

```docker
koush/scrypted:nvidia
```

--------------------------------

### Remove Scrypted Configuration (Windows)

Source: https://docs.scrypted.app/maintenance/uninstallation

This command removes the Scrypted configuration directory on Windows using the deltree command. It targets the .scrypted folder within the user's home directory.

```bat
deltree %HOMEDRIVE%%HOMEPATH%\.scrypted
```

--------------------------------

### Remove Scrypted Configuration (Linux/macOS)

Source: https://docs.scrypted.app/maintenance/uninstallation

This command removes the Scrypted configuration directory, typically located at ~/.scrypted, on Linux and macOS systems. It performs a recursive and forced deletion.

```sh
sudo rm -rf ~/.scrypted
```

--------------------------------

### Set Custom Worker Name in Scrypted Cluster (.env)

Source: https://docs.scrypted.app/maintenance/cluster

An optional configuration to assign a custom name to a Scrypted cluster worker. This helps in identifying and managing individual nodes within the cluster.

```sh
# Custom name for the worker
SCRYPTED_CLUSTER_WORKER_NAME=my-worker-name
```
Tokens:
Raw