# Using the In-Game Radio

{% embed url="<https://youtu.be/x51SsH0LHUM>" %}

## Initial Setup

### Displaying the In-Game Radio

By default, the radio display remains visible on-screen at all times. Users can toggle focus on the radio, enabling interaction when needed and un-focusing when done.

1. Use the [customizable keybind](#setting-your-push-to-talk-ptt-keybind) (Default is `~` right above tab)
2. Use the `/radio` command

Access to the radio can be restricted with [ACE permissions](https://docs.sonoransoftware.com/radio/tutorials/usage/in-game-radio/configuring-ace-permissions).

### Hiding the In-Game Radio

#### A. Via Button

Use the purple button or icon on the radio frames:

<div><figure><img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2F3RZkPPJkEZBEjd4nwcZ9%2Fimage.png?alt=media&#x26;token=1bf28c62-2a6d-437a-bf88-dde715267737" alt="" width="375"><figcaption><p>Vehicle Radio: Hide Button</p></figcaption></figure> <figure><img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FXsXu2NGYGXpCnHJOHtpd%2FScreenshot%202024-12-05%20124319.png?alt=media&#x26;token=7247735d-177d-4ec9-9c21-1ff967dc4e21" alt="" width="208"><figcaption><p>Handheld Radio: Hide Button</p></figcaption></figure></div>

#### B. Via Command

Use the `/radio hide` command in-game to hide the radio.

#### C. ESC Options

You can also [customize the display behavior when pressing `ESC`](#escape-mode).

### Logging In

<details>

<summary>Login with Account</summary>

When you first use the in-game resource, you'll need to log in.\
A 4-digit code will appear for you to sign in from your browser.

<figure><img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FvL8DVmxoIia6ymw84D0A%2Fimage.png?alt=media&#x26;token=e348da85-621a-4e58-bde9-0f06329f0505" alt=""><figcaption></figcaption></figure>

Open [sradio.link](https://sradio.link) in a web browser, log in if needed, enter your code, and click "Activate" to log in to the game.

<figure><img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2F2fVuHibdGH4LQPvhCh58%2Fimage.png?alt=media&#x26;token=d4c47ac4-11d1-48eb-a7e5-c80ebd20105b" alt="" width="375"><figcaption><p>Sonoran Radio - Activate Link</p></figcaption></figure>

</details>

<details>

<summary>Login as Guest</summary>

When you first use the in-game resource, you'll need to log in.\
If your community has ACE permissions configured, no account creation or link is necessary.

<figure><img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FVIJBf0AiP7XwmKWlo2LC%2Fimage.png?alt=media&#x26;token=8fe92309-ad89-4ff7-a824-77e3bcbe85ac" alt=""><figcaption></figcaption></figure>

Select **Login as guest** to bypass the account link and start using your radio. This guest option will only display if `acePermsForGuests` is set to `true`.

### Permission Configuration

Learn how to [configure ACE permissions for the radio](https://docs.sonoransoftware.com/radio/tutorials/usage/configuring-ace-permissions#ace-permission-sync).

### Display Name

Custom display names are saved locally in your cache and automatically restored on future guest logins.

Guest usernames are set in the following priority order (whichever is found first):

* Last used guest display name
* [Custom framework function](https://docs.sonoransoftware.com/radio/developer-documentation/developer-documentation/resource-events#guest-display-names)
* First and last name from QBCore, QBox, or ESX.
* In-game display name

[Users with permission can change this name](https://docs.sonoransoftware.com/radio/tutorials/dispatch-panel/using-the-dispatch-panel#display-names).

</details>

### Logging Out

You can logout/un-link your in-game radio via the settings menu (gear icon).

<div><figure><img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2Faz9R0Nxy1PlZPZy9uqyO%2Fimage.png?alt=media&#x26;token=bf41a25b-fa10-4b13-bf43-e260551a9bd2" alt=""><figcaption><p>In-Game Radio - Settings</p></figcaption></figure> <figure><img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FvDzp7mgdJyKyV7QaMrJ0%2Fimage.png?alt=media&#x26;token=eecc43ca-a55c-4ca5-a419-af04e5d30216" alt=""><figcaption><p>In-Game Radio - Unlink</p></figcaption></figure></div>

***

## Using the In-Game Radio

### Setting your Push-To-Talk (PTT) Keybind

[You can customize your PTT button in your GTA Settings.](https://docs.sonoransoftware.com/radio/tutorials/usage/in-game-radio/using-the-in-game-radio/fivem-keybinds-and-commands)

### Connecting and Switching Channels

<details>

<summary>Channel Selection via Knob</summary>

The radio will connect when you turn it on with the power button ([unless you need to login first](#logging-in)).

**Previous/Next Channel (In Group)**

* Left click the top knob to rotate to the next channel inside the channel group.

**Previous/Next Group**

* Right-click the top knob to change its mode from channel changing to group changing.
* Left click the top knob to rotate to the next channel group.

<img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FYEOTSgcm7xX35ExRcBuI%2FFiveM_b3095_GTAProcess_y5BTRN8idW.png?alt=media&#x26;token=0cd8bdd2-7349-4059-a94b-7fc0e361f701" alt="Sonoran Radio: Power Button" data-size="original"><img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FwPong9YLjsvAOXIYOmXq%2FFiveM_b3095_GTAProcess_8EDvlAfgKq.png?alt=media&#x26;token=6bc564a5-1bcb-4150-b29b-ecaab6074b5d" alt="Sonoran Radio: Channel List" data-size="original">

</details>

<details>

<summary>Channel Selection via Menu</summary>

Select the channel menu icon to open the channel selection options. Click on the channel you wish to transmit on.

`CTRL` + `Click` allows you to select multiple channels to transmit on at once.

<div><figure><img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2F7Eqbl2xspEcqUXl2cTdL%2Fimage.png?alt=media&#x26;token=5b575fd2-e943-4539-8460-1bc22f01375c" alt="" width="279"><figcaption><p>Modern UI - Channel Menu Icon</p></figcaption></figure> <figure><img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FyRwiRKOMz72nSuratVGu%2Fimage.png?alt=media&#x26;token=e101ce1a-61f9-447d-b7fc-89c41eabc6f4" alt="" width="279"><figcaption><p>Text UI - Channel Menu Icon</p></figcaption></figure></div>

<div><figure><img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2F7VzNof62DXtRydH8oits%2Fimage.png?alt=media&#x26;token=8d88c253-98fe-4045-b188-b8cf02def93d" alt="" width="277"><figcaption><p>Modern UI - Channel Selection</p></figcaption></figure> <figure><img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FJBjp5X1Qc1q1KDpsBKVe%2Fimage.png?alt=media&#x26;token=38ccc5b6-fec0-447f-823a-ac47d9a316ce" alt="" width="280"><figcaption><p>Text UI - Multi-Channel Selection</p></figcaption></figure></div>

</details>

<details>

<summary>Channel Selection via Hotkeys, Commands, and Stream Deck</summary>

Channels can also be changed via:

* [Channel Change Keybind](https://docs.sonoransoftware.com/radio/tutorials/usage/in-game-radio/fivem-keybinds-and-commands#prev-next-channel-in-group)
* [In-Game Commands (Optional Stream Deck Integration)](https://docs.sonoransoftware.com/radio/tutorials/usage/in-game-radio/fivem-keybinds-and-commands#fivem-client-commands)

</details>

### Channel Scanning/Listening

<details>

<summary>Scanning Radio Channels</summary>

Scanning a radio channel allows users to hear all transmissions, even if they are not actively transmitting on that channel. However, transmissions on the primary channel (the one you are actively talking on) will take priority, muting transmissions from scanned channels whenever someone speaks on the primary channel.

#### Selecting Scanned Channels ([Modern or Text Display](https://docs.sonoransoftware.com/radio/tutorials/usage/customizing-radio-frames#screen-styles))

1. Select the Channel Scan Icon
2. Select the channel group to view the contained channels
3. Click on a channel to toggle on/off scanning

[Learn how to toggle a channel scan via command or Stream Deck!](https://docs.sonoransoftware.com/radio/tutorials/usage/in-game-radio/fivem-keybinds-and-commands#toggle-channel-scan)

![](https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2F7YXZa3ZdLagv5sy3R3Yv%2Fimage.png?alt=media\&token=64416424-d03c-47d2-b990-16fdfa45a2a1)![](https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2Fp8wQx13UA1ZmCJFg4Nku%2Fimage.png?alt=media\&token=250f5513-1d40-4155-ab8b-05b997325ab3)

Users can also [create a scan list](#scan-lists) to swap between multiple scanned channels at once.

</details>

### Custom Scan Lists

<details>

<summary>Scan Lists</summary>

Users can scan one or more channels to listen without transmitting. For monitoring multiple channels, "Scan Lists" let users group channels and easily switch between them.

#### Creating a Scan List ([Modern or Text Display](https://docs.sonoransoftware.com/radio/tutorials/usage/customizing-radio-frames#screen-styles))

1. Toggle scanning on one or more channels.
2. Select the `+` icon next to `Scan Lists` to create a new scan list with the current selection.
3. Scan lists can be reordered via drag-and-drop.
4. Select the adjust button to rename or remove the scan list.
5. Click on the scan list to scan all of the channels inside of it.
6. Scan lists can be reordered via drag-and-drop

[Learn how to toggle a scan list via command or Stream Deck](https://docs.sonoransoftware.com/radio/tutorials/usage/in-game-radio/fivem-keybinds-and-commands#toggle-scan-list)!

![](https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FjvoVIdqrC6eTg5D6PdgQ%2Fimage.png?alt=media\&token=bf54feac-b279-4c78-9f6d-672cbb2e4543)![](https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FX6nAX9Yx2K2oZBPcyrKe%2Fimage.png?alt=media\&token=2e9bf929-1cbb-4b99-8a93-5c2d1340a037)

</details>

### Adjust Volume

{% hint style="info" %}
Your radio volume also controls how loudly [nearby users hear the radio chatter](https://docs.sonoransoftware.com/radio/tutorials/usage/in-game-radio/hear-nearby-radio-chatter).
{% endhint %}

<details>

<summary>Radio Volume</summary>

#### System-Wide Volume

In the settings menu (gear icon) you can adjust the radio's total volume output.

<img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2Faz9R0Nxy1PlZPZy9uqyO%2Fimage.png?alt=media&#x26;token=bf41a25b-fa10-4b13-bf43-e260551a9bd2" alt="In-Game Radio - Settings" data-size="original">![](https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FdwaKgun7UGHXSI7KQmbf%2Fimage.png?alt=media\&token=1e9de9fa-3bae-454c-9f5a-1efa95077999)

#### Per-User Volume

You can also right-click on any user to adjust their volume specifically.

<img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FP4jSb2r0hrwPGgO53KCe%2Fimage.png?alt=media&#x26;token=c16708df-8112-4a65-bc94-3ffc2857da16" alt="In-Game Radio - Per-User Volume" data-size="original">

#### Per-Channel Volume

Select the volume icon to change the current channel's transmission volume.

<div><figure><img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2F7R8qpfW2EmvlHVuyBDxm%2Fimage.png?alt=media&#x26;token=88e534e9-a946-43ad-8d47-c57ceb4a8682" alt=""><figcaption></figcaption></figure> <figure><img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FAL8Uo37jLZfTr4AQjWwx%2Fimage.png?alt=media&#x26;token=54677c84-64d7-417e-906d-ed2c832b09a1" alt=""><figcaption></figcaption></figure></div>

#### Volume Hotkey

[You can also use the in-game keybind to quickly adjust volume.](https://docs.sonoransoftware.com/radio/tutorials/usage/in-game-radio/fivem-keybinds-and-commands#volume-up-down)

The adjustment amount is customizable in the settings menu.

![](https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2Fg5ke2tQskfelg9nTZPpl%2Fimage.png?alt=media\&token=55f322fc-bae7-44f2-a836-91d06422f21e)

</details>

### Adjust Volume With Sirens

<details>

<summary>Automatic Volume Increase w/Sirens</summary>

When in-game, turning on your sirens will increase your overall radio volume by the configured amount. Turning your sirens back off will lower the volume back down.

This feature is automatically integrated with [Luxart Vehicle Control](https://github.com/TrevorBarns/luxart-vehicle-control).\
If the resource is not named `LVC`, the [`config.luxartResourceName` value must be updated](https://docs.sonoransoftware.com/radio/getting-started/installing-the-in-game-resource#updates).

For communities not using LVC, the functionality will fall back to a FiveM native that will trigger the functionality if either lights or sirens are activated.

![](https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FcQPS6uPDRrZCzgiG8fvf%2Fimage.png?alt=media\&token=2ad6b30f-3135-4e83-84c3-76d41a6bf1b8)

</details>

### Move and Resize the Radio

{% hint style="info" %}
**If you move your radio too far off of your screen:**

Use `/radio reset` to reset the size and position.
{% endhint %}

<details>

<summary>Radio Move and Resize</summary>

On the radio screen, open the `Settings` modal by pressing the gear icon.

Select `Move/Resize`

* Click and drag the radio to change it's position on your screen.
* Hold `ctrl` and drag to resize the radio.
* Press `esc` to save the new size and position.

<img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2Faz9R0Nxy1PlZPZy9uqyO%2Fimage.png?alt=media&#x26;token=bf41a25b-fa10-4b13-bf43-e260551a9bd2" alt="In-Game Radio - Settings" data-size="original"><img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FjstdDI1DBHxhO0KeG2ja%2Fimage.png?alt=media&#x26;token=1aa1ab50-2c8d-4524-9253-3c6401db19d3" alt="In-Game Radio - Move/Resize" data-size="original">

<img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2F9vlpBv9lsDKRt2UgbUB9%2Fimage.png?alt=media&#x26;token=0e3d24c4-bfea-47cf-a62a-29fcb55edfaa" alt="In-Game Radio - Adjustment" data-size="original">

</details>

### Escape Mode

<details>

<summary>ESC Radio Display Behavior</summary>

The Escape Mode selector changes the in-game radio display behavior after pressing `ESC`.\
The server default for this setting can be configured in the [config's `defaultEscapeMode` property](https://docs.sonoransoftware.com/radio/getting-started/installing-the-in-game-resource#updates).

`Keep Radio Visible`

* The radio stays visible on `ESC`

`Hide Radio`

* The radio closes on `ESC`

`XMITT (PTT)`

* The radio closes on `ESC`, but is visible while transmitting

![](https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FDolStOnTRi5HrAwsnCQe%2Fimage.png?alt=media\&token=00f0570f-fa02-4c11-835d-7815a3740172)

</details>

### Panic

<details>

<summary>In-Game Panic</summary>

Pressing the orange panic button on the in-game radio toggles your panic status.

This can also toggle your panic status in [Sonoran CAD](https://docs.sonoransoftware.com/radio/integrations/sonoran-cad-integration#cad-panic).

[Dispatchers will also be able to see and clear your panic status.](https://docs.sonoransoftware.com/radio/tutorials/dispatch-panel/using-the-dispatch-panel#unit-panic)

Sonoran Radio has a [configurable option](https://docs.sonoransoftware.com/radio/getting-started/installing-the-in-game-resource#updates) to automatically press a users PTT button for a configurable amount of time when the user presses their radio panic button:

```lua
Config.autoPttOnPanic = {
	enabled = true, -- Enable automatic PTT when panic button is pressed
	duration = 15 -- Duration in seconds to hold PTT when panic button is pressed
}
```

![](https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FcAvYNxqRtnpUWpiMfZ6I%2Fimage.png?alt=media\&token=16d4eeb2-45b7-47b5-85e2-d8bd949d52c6)

</details>

### Display Names

<details>

<summary>Update User Display Name</summary>

[View several different methods to update a user's display name in the radio.](https://docs.sonoransoftware.com/radio/tutorials/dispatch-panel/using-the-dispatch-panel#display-names)

</details>

### Radio Types

Sonoran Radio offers three radio platforms: handheld, top-down HUD, and vehicle.\
All three radio platforms can have [customizable frame styles](#change-radio-frames).

<figure><img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FWBQWsPDtmSyeNC0OTdUM%2Fimage.png?alt=media&#x26;token=35e81133-2d45-4961-ba5b-908eb5ab8f39" alt=""><figcaption></figcaption></figure>

When opening the radio via `/radio` the handheld radio will display on-screen.\
The vehicle UI will display when opening the radio inside of a vehicle.\
The top-down HUD style can be viewed with the `/radiohud` command.

### Change Radio Frames

The settings menu also allows you to customize your radio frame:

<figure><img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FBH26VWt1CkwrKM1Y5tES%2Fimage.png?alt=media&#x26;token=4446e671-d4ca-4939-8d09-00ba27e80db9" alt="" width="165"><figcaption><p>Sonoran Radio - Custom Frames</p></figcaption></figure>

Learn more about customizable radio frames:

{% content-ref url="customizing-radio-frames" %}
[customizing-radio-frames](https://docs.sonoransoftware.com/radio/tutorials/usage/in-game-radio/customizing-radio-frames)
{% endcontent-ref %}

## Civilian Usage

### Placing an Emergency (911) Call

Civilians can place an emergency call to speak directly with dispatchers:

{% content-ref url="../dispatch-panel/emergency-calls" %}
[emergency-calls](https://docs.sonoransoftware.com/radio/tutorials/usage/dispatch-panel/emergency-calls)
{% endcontent-ref %}

## Custom Animations

Unlock multiple more custom radio animations, FREE with Sonoran Radio pro!

<figure><img src="https://1542307009-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FfCk5zoeun5gx3ujYW6eg%2Fuploads%2FK1i90hGMICqRQC9bdvJX%2FSONORAN%20X%20BIGPAPA2.png?alt=media&#x26;token=84d2068f-8e75-47c2-b287-87a69dc7c120" alt=""><figcaption><p>Sonoran Radio x Big Daddy Scripts</p></figcaption></figure>

{% content-ref url="../../integrations/big-daddy-radio-animations" %}
[big-daddy-radio-animations](https://docs.sonoransoftware.com/radio/tutorials/integrations/big-daddy-radio-animations)
{% endcontent-ref %}
