Body Camera
The Sonoran CAD bodycam enables dispatchers to see live images from units in-game.
This submodule utilizes API endpoints that require the Pro version of Sonoran CAD or higher. For more information, view our pricing page.
Looking for VPS, web, or dedicated hosting? Check out our official server hosting!
What is the live Body Camera?
Sonoran CAD is the only external CAD system offering live image feeds from in-game users accessible through the live map, active units preview, or a dedicated window.
This feature updates the image feed at intervals that can be configured by the user (1-10 seconds).
Learn more about the technology and limitations of this system.
Activation Guide
1. Download and Install the Core
If you haven't already, be sure to install and configure the SonoranCAD Core first.
2. Activate Locations
The locations submodule includes all logic required to send bodycam images to the CAD.
3. Adjust the Core Configuration
The bodycam settings are stored inside of the core configuration file.
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: 30000 (30 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
In-Game Usage
When in-game, units must also be actively signed into the dispatch, police, fire, or EMS panel.
Use the /bodycam command to toggle your body camera on or off.
Body Camera Overlay
If enabled in your framework configuration, a periodic beep and blinking body camera logo will appear on your screen reflecting that your body camera is active.
Beeps
The body camera plays server-sided beeps periodically while activated.
beepFrequencydetermines how often these beeps are playedbeepRangedetermines how far away these beeps are heard
Automatic Activation
The body camera will automatically activate when an officer activates their lights or draws a firearm.
autoEnableWithWeaponsenables automatic activation when one of theweaponsitems are used.autoEnableWithLightsto enabled automatic activation when emergency lights are enabled.
Unit Duty Requirement
You can enable or disable the requirement for a unit to have to be logged into the Police, EMS or Fire portions of CAD in order to activate their bodycam by setting requireUnitDuty to true.
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
Animation
When toggling your body camera on or off, an animation will play if enableAnimation is true.
CAD Usage
Active Units
In the active units panel, units with their body camera enabled will show a pulsing camera icon.
Preview:
Hover over this icon to see a preview image of their body camera.
Window:
Click the icon to open an adjustable window of their body camera.
Live Map
In the live map, units with their body camera enabled will show a pulsing camera icon.
Preview:
Click on the unit blip to view a live preview of their body camera in the unit action menu.
Troubleshooting
No such export requestClientScreenshot in resource screenshots-basic
Some servers may see the following error print in their console:
SCRIPT ERROR: @sonorancad/core/screenshot.lua:15: No such export requestClientScreenshot in resource screenshots-basic
This means that you do not have the screenshot-basic resource installed on your server.
We recommend that you update your server artifacts, as newer versions come with this resource installed by default. Alternatively, you can manually install it from GitHub.
No Images/Loading on ZAP Hosting
We are aware of an issue with the CFX proxy being unreachable on ZAP Hosting, a required piece for the body camera functionality.
Your CFX proxy URL is formatted as https://someCFXUsernameHere.users.cfx.re/ with someCFXUsernameHere being your CFX username. This proxy is native functionality to all FiveM servers.
We suggest contacting ZAP hosting directly (your game server provider) to try and resolve this issue.
Technology and Limitations
The Goal:
Real-time video streams from in-game, right in the CAD panel.
The Limitations:
Individual users require significantly upgraded PC hardware and networking to transcode and upload live video feeds.
The infrastructure to host and share these streams would require massive amounts of new hardware, making the service unaffordable for gaming communities.
The Resolution:
Client Image Handling
Units in-game have local screenshots created and sent to the local game server for processing. These screenshots result in next to zero noticeable performance drop in comparison to transcoding live video streaming.
The local game server stores and serves these images to Sonoran CAD when requested by a CAD user. An on-going "feed" of images is sent, stored, and replaced as newer images replace the old ones. When the body camera is toggled off, or the server restarts, these folders are completely wiped to ensure your game server isn't bloating with old images.
CAD Image Requests
When a CAD dispatcher requests to look at a unit's body camera, they ask the game server for the screenshot and continually request new screenshots at the rate they're being generated. The current default is 2000ms (2 seconds) but can be lowered to as little as 1000ms (1 second).
End Result:
This "screenshot feed" system allows dispatchers to stay up-to-date without requiring massive amounts of bandwidth, expensive processing for the user's PCs, and ensures quick responsiveness within the CAD.
Disclaimer
Please note that this feature is in early development and may exhibit instability, influenced by server and network performance. Body camera images are generated by the client and temporarily stored on the community's server. Viewing these images, whether by dispatchers or units, involves active requests to your CFX nucleus proxy, leading to increased network traffic and processing demands.
Last updated
Was this helpful?