> For the complete documentation index, see [llms.txt](https://docs.sonoransoftware.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/available-plugins/bodycam.md). # Body Camera The Sonoran CAD bodycam enables dispatchers to see live video from units in-game. {% hint style="warning" %} Bodycam cloud footage storage is limited based on your subscription plan. [View our pricing page](/cad/pricing/faq.md) for more information. {% endhint %}
## What is the live Body Camera? Sonoran CAD is the only external CAD system offering livestream video from in-game users accessible through the [live map](#live-map), [active units preview](#preview), or a [dedicated window](#window). ## Activation Guide ### 1. Download and Install the Resource {% hint style="info" %} This submodule is already **enabled by default** when installing the [Sonoran CAD FiveM resource](/cad/integration-plugins/in-game-integration/fivem-installation.md). \ The [locations submodule](/cad/integration-plugins/in-game-integration/available-plugins/locations.md) includes all logic required to send bodycam images to the CAD and is **already enabled by default**. Keep this submodule enabled to maintain functionality. {% endhint %} ### 2. Adjust the Configuration The bodycam settings are stored inside of the `/configuration/bodycam_config.lua` file.
Configuration Options | Variable | Description | | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `command` | The command name to toggle your body camera on or off. | | `requireUnitDuty` | If enabled, the player must be logged into the CAD to use the body camera. | | `enableAnimation` | Play an in-game animation when activating or deactivating the body camera. | | `enableOverlay` |

Enables or disables the blinking body camera image on screen when enabled.
Default true

| | `overlayLocation` |

The position (corner) of the screen where the body camera image is displayed.
Options: top-left, top-right, bottom-left, bottom-right
Default: top-right

| | `enableBeeps` |

Enables or disables the body camera beeping when turned on.
Default: true

| | `beepType` |

Type of audio that the beeps use.

native = GTAV Native Sounds

nui = Custom Sound File

| | `beepFrequency` |

Adjusts the frequency at which unit body camera beeps when turned on(in milliseconds).
Default: 60000 (60 seconds)

| | `beepRange` | The range at which a person can hear the bodycam beeps | | `screenshotFrequency` |

Adjusts the frequency at which unit body cameras update (in milliseconds).
Default: 2000 (2 seconds)

| | `defaultKeybind` | The default keybind for toggling the bodycam. | | `autoEnableWithLights` | Automatically enable bodycam when emergency lights are enabled/disabled. | | `autoEnableWithWeapons` | Automatically enable bodycam when a weapon is drawn. | | `clothing` | Clothing items that must be worn in order to have a body camera. | | `weapons` | Weapons that when drawn enable bodycam. | | `bodycamCommandChangeFrequency` |

The command to adjust your individual body camera screenshot frequency to be different than the server's screenshotFrequency value.
Default: bodycamFreq

|
### 3. Ensure Players are Linked Ensure the player has already [linked their CAD](/cad/integration-plugins/in-game-integration/link-user-in-game.md) for this integration to work. ## In-Game Usage When in-game, units [must also be actively signed into the dispatch, police, fire, or EMS panel](#unit-duty-requirement). On first usage, players will be prompted to grant permission for the bodycam:
#### Commands In-game commands can be used to * `/bodycam` Toggle the bodycam on or off * `/bodycam sound` Displays your current local sound volume * `/bodycam sound 0` Mutes bodycam sounds locally; use a value from `0` to `1`, such as `/bodycam sound 0.2` for 20% volume * `/bodycam frequency` Displays your current beep interval in seconds * `/bodycam frequency 30` Sets your bodycam beep interval to 30 seconds; accepts whole seconds from `1` to `3600` * `/bodycam anim` Toggles the [bodycam animation](#animation) on and off locally * `/bodycam overlay` Toggles the [bodycam overlay](#body-camera-overlay) on and off locally * `/bodycam forceoff` Enables the [force-off state](#force-off)
### Keybind Users can customize a keybind to toggle their bodycams on and off. Navigate to **Settings** > **Keybinds** > **FiveM** and look for the keybind **Toggle BodyCam** under the resource `sonorancad`.
#### Body Camera Overlay When your bodycam is on and being viewed in the CAD a periodic beep and body overlay will appear on your screen.
### Beeps The FiveM body camera plays periodic beeps while activated. These settings are separate from the desktop/web screen-sharing camera, even when CAD is opened inside an in-game tablet. Changing the CAD **Modify Identifier > Bodycam** sound settings does not change FiveM's bodycam sounds. #### Per-Player Commands * `/bodycam sound 0` or `/bodycam sound 0.0` mutes local bodycam sounds, including start/stop and reminder beeps. `/bodycam sound 0.2` restores the default 20% volume. * `/bodycam sound` displays your current volume. Values from `0` to `1` are accepted. With `beepType = "native"`, zero mutes the beeps, but nonzero values do not adjust GTA's native sound volume. * `/bodycam frequency 30` sets a 30-second interval. `/bodycam frequency 290` sets a 290-second interval. Use whole seconds from `1` to `3600`; `/bodycam frequency` displays the current value. A frequency change restarts the reminder countdown using the new interval. It applies to your camera's reminders, including the sound requests sent to nearby players; it does not change other players' camera intervals. Local muting does not prevent nearby players from hearing your camera. Your volume and interval overrides reset when you reconnect or the resource restarts. If your server renamed the `bodycam` command, use its configured name instead. These commands require the updated FiveM resource. Server administrators must install the update and restart the resource before players can use zero-volume muting or the frequency command. #### Server Configuration In `sonorancad/configuration/bodycam_config.lua`: ```lua enableBeeps = true, beepType = "nui", beepFrequency = 60000, -- milliseconds: 60 seconds ``` * `beepFrequency` sets the default interval in **milliseconds**. Use `30000` for 30 seconds or `290000` for 290 seconds. The in-game `frequency` command uses **seconds**. * `enableBeeps = false` disables the recurring beep loop, but does not silence start/stop tones or received nearby-camera beeps. A player frequency override does not re-enable a disabled loop. * `beepRange` determines how far away nearby players can hear the camera. Restart the resource after changing its configuration. ### Automatic Activation The body camera will automatically activate when an officer activates their lights or draws a firearm. * `autoEnableWithWeapons` enables automatic activation when one of the `weapons` items are used. * `autoEnableWithLights` to enabled automatic activation when emergency lights are enabled. ### Force Off Use `/bodycam forceoff` to keep your bodycam off, including automatic activation and viewing requests. Use `/bodycam` to turn it back on. By default, force off requires the `sonorancad.bodycam.forceoff` FiveM ACE permission. CAD account permissions do not grant this access. #### Grant Access Add this example to `server.cfg` (or a permissions file executed by it), replacing `YOUR_LICENSE` with the player's license identifier: ```cfg add_ace group.sonoran_cad_bodycam sonorancad.bodycam.forceoff allow add_principal identifier.license:YOUR_LICENSE group.sonoran_cad_bodycam ``` Repeat the `add_principal` line for each player. Restart the server to apply, or run the lines in the server console for immediate access. #### Disable the Permission Check To allow everyone to use force off, set this value in `sonorancad/configuration/bodycam_config.lua`: ```lua forceOffAce = "", ``` Restart `sonorancad` to apply. To require a different ACE permission instead, set `forceOffAce` to that permission and use it in your `add_ace` rule. Other bodycam subcommands do not require this ACE permission. The bundled keybind permissions do not grant force-off access. ### Unit Duty Requirement By default, the `requireUnitDuty` configuration value is set to `true`. This requires the unit to be logged into the Police, EMS or Fire portions of CAD in order to activate their bodycam. ### Animation When toggling your body camera on or off an animation will play. To disable this, set `enableAnimation` to `false`. ### In-Game Recording By default, each recording includes a 30-second shadow buffer followed by 1 minute 30 seconds of video, for a maximum total length of 2 minutes. The shadow buffer length can be adjusted with `recording.shadowBufferSeconds`, but the total recording length cannot exceed 2 minutes. Recording can be started manually using a configurable keybind located under **Keybinds -> FiveM -> Sonoran CAD**. You can also enable automatic bodycam recording through `recording.autoRecordEvents`. Developers can also trigger bodycam recordings with a [client event](/cad/integration-plugins/in-game-integration/framework-development-documentation/client-events.md#bodycam-record-toggle). Recordings can be viewed in the CAD under **Unit Management** > **Body Cam Recordings**
## CAD Usage
### Active Units In the active units panel, hover over the camera icon to view a preview of their bodycam.
### Window Click on the active unit preview or the pop out button on the live map to open a dedicated bodycam viewer window.
### Live Map In the live map, selecting a unit or hovering near a unit in the 3D map will show the bodycam.
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.sonoransoftware.com/cad/integration-plugins/in-game-integration/available-plugins/bodycam.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.