Ctrlk
FiveM HostingCustomer SupportDiscord
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Stream Deck Plugin

Sonoran Radio's official Stream Deck plugin gives you faster, customizable control over channels, volume, presets, and more.

Introduction

Sonoran Radio's MacOS and Windows desktop applications offer direct integration with Stream Deck hardware. By installing our official Stream Deck plugin, users can change channels, toggle preset channel groups, change channel and system volumes, and more - faster than ever before.

Don't have a physical Stream Deck? Download the free Stream Deck Mobile app!

Installation

1. Download and Install the Plugin

Download the official Sonoran Radio Stream Deck plugin from the Elgato Marketplace.

2. Configure Actions

Using the Stream Deck desktop application search for Sonoran Radio in the Keys and Dials sections.

Drag-and-drop an action category to the Stream Deck. Select the action to update the sub-type.

Ex: Channel key type > Toggle XMIT Channels > Select Channels

3. Optional: FiveM Integration

Each action can be configured to control the desktop app (default) or FiveM in-game resource.

For clients using the in-game radio in FiveM, simply toggle each action from Desktop to FiveM.

Sonoran Radio then acts as a local bridge between the Stream Deck, the desktop app, and the FiveM radio. The desktop app must be running, but does not have to have any radio community open or selected.

  1. Stream Deck sends the action to Sonoran Radio Desktop on localhost

  2. Sonoran Radio Desktop forwards the command to a localhost WebSocket

  3. your FiveM client script listens to that socket and forwards the event into the radio iframe/NUI

  4. the iframe/NUI sends radio state snapshots back through your FiveM client script to Sonoran Radio Desktop

  5. Stream Deck reads those snapshots for channel lists, labels, and action state

This means the normal setup for users is:

  • keep Sonoran Radio Desktop running

  • switch the Stream Deck action target to FiveM

  • run a FiveM client script that connects to the desktop socket and forwards the documented messages

4. FiveM Developer Setup

If you are implementing the FiveM side yourself, use the documented developer contract here:

Stream Deck API

Capabilities

Keys

Channel Category Buttons

Channel actions allow you to do somethin

  • Next Group

  • Previous Group

  • Next Channel

  • Previous Channel

  • Toggle XMIT Channels

    • Select one or more channels

    • Toggling this action will add and remove the selected channel(s) from your transmit list

  • Temporary XMIT Channel

    • Select a channel

    • Pressing this action will temporarily transmit in the selected channel and return to your previous channel(s) after release

  • Toggle Scan Channels

    • Select one or more channels

    • Toggling this action will add and remove the selected channel(s) from your scan list

Toggle Category Buttons

  • Push to Talk

  • Toggle AI Mode

  • Toggle Tone Board

Audio Category Buttons

  • Volume Up

  • Volume Down

  • SFX Volume Up

  • SFX Volume Down

  • AI Volume Up

  • AI Volume Down

Desktop Category Buttons

  • Connected Users Overlay

  • Focus Radio Overlay

  • Toggle Radio Overlay

Dials

Stream Deck hardware with dials have the following supported actions:

Dial Options

  • Cycle Groups (Prev/Next)

  • Cycle Channels (Prev/Next)

  • Adjust Volume

    • Optional Press to Mute

  • Adjust SFX Volume

    • Optional Press to Mute

  • Adjust AI Volume

    • Optional Press to Mute

  • Adjust Current Channel Volume

    • Optional Press to Mute

PreviousIntegrationsNextDispatch AI

Last updated

Was this helpful?