LogoLogo
SupportServer Hosting
  • Sonoran CAD
  • 📱Download The App
    • Steam Browser - Workaround
    • Web Browser - Clear Cache
    • Desktop App - Clear Cache
    • GTA RP Tablet - Clear Cache
    • Steam Browser - Clear Cache
  • Why Choose Sonoran CAD?
    • 🏆Why Choose Sonoran CAD?
  • Other Products
    • 🖥️FiveM Hosting
    • 📝Sonoran CMS
    • 📡Sonoran Radio
  • Tutorials
    • Getting Started
      • Registering Your Account
      • Registering Your Community
      • Inviting Users to Your CAD
      • Granting Account Permissions
      • View Your Limits
      • Community ID and API Keys
      • Troubleshooting
    • Customization
      • Custom Domain & Login Page
      • Customizing Your Layout
      • Community Branding and Settings
      • Creating Custom Record and Report Types
      • Sharing Custom Records
      • Custom Search Types
      • Geographical Settings
      • Penal Codes
      • 10-Codes
      • Addresses and Street Names
      • Unit Status Codes
      • Tone Board
      • Custom Audio Notifications
      • Custom Emails
      • Quick Links
      • Custom Page Colors
      • User Account Restrictions
      • Configuring Multiple Servers
      • Advanced Query Strings
    • Dispatching
      • Creating a Call
      • Self Dispatch
      • Timers
      • Command Line Interface (CLI)
    • Records Management
      • Record Lookups
      • Adding a Record
      • PDF Records
      • Scene Diagram Builder
    • Administration
      • System Logs
      • Remove User Account
      • Deleting or Transferring your CAD
    • Other Features
      • Configurable Hotkeys
      • Voice Commands
      • Volume and Language
  • Integration Capabilities
    • 🗃️Paid Integration Resources
      • Mobile Command Center
      • ATM Robbery
      • In-Vehicle Radar
      • Evidence Camera
      • Power Grid
      • Speed Cameras
      • Shot Spotter
    • 🛠️Integrated Vendors
    • 📺Twitch Bodycam, Bot, & Lighting Integration
    • Database Sync and Merge
      • Database Sync Credentials
      • QB Core Mapping Tutorial
      • Troubleshooting
    • Discord Bot Integration
    • Discord Rich Presence
    • Discord Webhooks
    • TeamSpeak 3 Integration
    • Stream Deck Integration
    • 🎮FiveM
      • FiveM Installation
        • Submodule Configuration
          • Submodule Troubleshooting
          • Submodule Configuration Updates
        • FiveM Submodules
          • Body Camera
          • Call Commands
          • Check API ID
          • Civilian Integration
          • Dispatch Notify
          • Emergency Response Simulator (ERS)
          • Framework Support (ESX/QBCore) and Auto Fines
          • FivePD
          • ForceReg
          • Kick
          • Locations
          • Live Map
          • Lookups
          • Postals
          • Smart Signs
          • Sonoran Radio (sonrad)
          • Station Alert
          • Tablet & Mini-CAD
          • TeamSpeak 3
          • Traffic Stop
          • Unit Status
          • VehReg
          • WraithV2
      • FiveM Development Documentation
        • Client Functions
        • Shared Functions
        • Server Functions
        • Server Events
        • HTTP Request Handling
      • Error Codes
    • 🎮Roblox ER:LC
  • Developer API Documentation
    • 📖API Integration
      • Getting Started
        • Retrieving Your Credentials
        • Integration API ID
        • Account Secret ID
      • Push Events
        • Event Restrictions
        • Record Events
          • Record Added
          • Record Edited
          • Record Removed
        • Unit Events
          • Unit Panic
          • Unit Login
          • Unit Logoff
          • Unit Status Update
          • Unit Group Name Change
          • Unit Group Add
          • Unit Group Remove
        • Dispatch Events
          • New Dispatch
          • Modified Dispatch
          • Closed Dispatch
          • Dispatch Note
          • Attach Unit
          • Detach Unit
          • Toggle Bodycam
        • Event 911
        • Remove 911
        • Sign Updated
        • Tone Played
        • Civilian
          • Character Selected
        • ERS
          • New Callout
        • Station Alert
          • New Station Alert
      • API Endpoints
        • API Restrictions
        • Emergency
          • Identifiers
            • Get Identifiers
            • Modify Identifier
            • Set Identifier
            • Unit Panic
            • Kick Unit
            • Unit Status
            • Get Active Units
            • Update Unit Location
          • Dispatch and Emergency Calls
            • Get Calls
            • New Dispatch
            • Attach Unit
            • Detach Unit
            • Update Call Postal
            • Add Call Note
            • Update Call Primary
            • Close Dispatch
            • New 911 Call
            • Remove 911
          • Custom Blips
            • Get Map Blips
            • Add Blip
            • Modify Blip
            • Remove Blip
          • Street Signs
            • Set Street Sign Config
            • Update Street Sign
          • ERS
            • Set Available Callouts
          • Station Alert
            • Set Stations
        • Civilian
          • Set Character
          • Get Characters
          • New Character
          • Edit Character
          • Remove Character
          • DB Sync: Get Character Links
          • DB Sync: Link Character
        • General
          • Get Servers
          • Set Servers
          • Get Version
          • Set Penal Codes
          • Set API IDs
          • Custom Records
            • API Options for Adding and Modifying Records
            • Get Record Templates
            • New Record
            • Edit Record
            • Remove Record
          • Lookup By Value
          • Lookup Name or Plate
          • Get Account
          • Get Accounts
          • Check API ID
          • Apply Permission Key
          • Modify Account Permissions
          • Kick or Ban User
          • Verify Secret
          • Auth Street Signs
          • Set Postal Config
          • Set Clock Time
          • Send Photo
          • Leave Community
          • Join Community
        • Local Endpoints
          • Smart Lighting
        • Internal
          • FiveM Download
      • API Examples
        • Emergency
          • LUA Examples
            • Dispatch and Emergency Calls
              • New 911 Call
              • Remove 911
              • Add Call Note
              • Set Call Postal
            • Custom Blips
              • Add Blip
              • Add Blips
              • Add Temp Blip
              • Get Map Blips
              • Remove Blip
              • Remove Blip With Subtype
            • General
              • Lookup Name or Plate
          • JavaScript Examples
            • Dispatch and Emergency Calls
              • New 911 Call
              • Remove 911
              • Add Call Note
              • Set Call Postal
            • Custom Blips
              • Add Blip
              • Add Blips
              • Add Temp Blip
              • Get Map Blips
              • Remove Blip
              • Remove Blip With Subtype
            • General
              • Lookup Name or Plate
      • Development Branch
    • 💵Developer Bounties
    • 🌎Translation Support
  • Pricing
    • Pricing FAQ
      • Military and First Responder Discount
      • Expert Installation
      • Accessing the Payment Center
      • Create and Manage a Subscription
      • Request Discord Role
    • View and Compare Plans
  • Roadmap
    • 📋Changelog
  • Other
    • AI QA
    • Contact Us
    • Policy
      • Rocket CAD Closure
      • Terms of Service
      • Privacy Policy
      • Refund and Purchase Policy
      • Discord Bot
    • Archive
      • Fire Siren
Powered by GitBook
On this page
  • What is the live Body Camera?
  • Installation Guide
  • 1. Download and Install the Framework
  • 2. Install Locations
  • 3. Adjust the Framework Configuration
  • In-Game Usage
  • CAD Usage
  • Active Units
  • Live Map
  • Troubleshooting
  • No such export requestClientScreenshot in resource screenshots-basic
  • No Images/Loading on ZAP Hosting
  • Technology and Limitations
  • The Goal:
  • The Limitations:
  • The Resolution:
  • End Result:
  • Disclaimer

Was this helpful?

Edit on GitHub
  1. Roadmap
  2. v2.X.X - Legacy
  3. Available Plugins

Body Camera

The Sonoran CAD bodycam enables dispatchers to see live images from units in-game.

Last updated 11 months ago

Was this helpful?

This plugin utilizes API endpoints that require the Pro version of Sonoran CAD or higher. For more information, view our page.

Looking for VPS, web, or dedicated hosting? Check out our official !

What is the live Body Camera?

This feature updates the image feed at intervals that can be configured by the user (1-10 seconds).

Installation Guide

1. Download and Install the Framework

2. Install Locations

3. Adjust the Framework Configuration

The bodycam settings are stored inside of the framework configuration file.

Variable
Description

bodycamEnabled

Enables or disables the body camera command. Default: true

bodycamBeepFrequency

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

bodycamPlayBeeps

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

bodycamScreenshotFrequency

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

bodycamOverlayEnabled

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

bodycamOverlayLocation

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

bodycamCommandToggle

The command name to toggle your body camera on or off. Default: bodycam

bodycamCommandChangeFrequency

The command to adjust your individual body camera screenshot frequency to be different than the server's bodycamScreenshotFrequency 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.

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

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.

Sonoran CAD is the only external CAD system offering live image feeds from in-game users accessible through the , , or a .

If you haven't already, be sure to install and configure the first.

The includes all logic required to send bodycam images to the CAD.

This means that you do not have the 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 .

plugin framework
locations plugin
screenshot-basic
GitHub
live map
active units preview
dedicated window
Learn more about the technology and limitations of this system.
pricing
server hosting