Using the TeamSpeak Plugin

Explanations on how to use the plugin features in TeamSpeak

Prerequisites

Before continuing, it's expected that you've installed the plugin and understand the core concepts of Sonoran Radio.

Install TeamSpeak Plugin

Each user needs to install this to use the radio

Core Concepts

Understand the theory of our radio

Permissions

Restrict actions to specific groups, to help combat trolling and abuse

Unauthorized Servers

When connecting to a server that does not enable Sonoran Radio, the plugin will essentially stay dormant. It will display some basic information on the side panel when clicking the virtual server row (the top channel). If you expect the server to be authorized but it isn't, then contact the server owner for assistance.

Example

Permissions

Some actions in Sonoran Radio are permissioned. If some features in Sonoran Radio seem disabled for no reason, it is most likely because the server manager or owner has only enabled that action for a select few server groups. Please see permissions for more information about which permissions Sonoran Radio has.

Server Information

On authorized servers, the plugin will display much more information when compared to unauthorized servers. The information is displayed on the right sidebar of your TeamSpeak. The information displayed depends on what type of item you click (i.e. a user will display different info than the channel).

The virtual server (or topmost item) will display information about global authorization status and subscription tier that the TeamSpeak server has. A channel will display whether it is a patrol channel. A client will display information about their frequencies and plugin version (if they also have the plugin installed).

Examples

Virtual ServerChannelClient/User

Patrol Channels

All channels in a TeamSpeak server except patrol channels will have the same behavior as if the plugin weren't installed at all.

Once you have joined a patrol channel, special logic called "talk groups" will be automatically initialized.

Frequency Specific Audio

After joining a patrol channel, you may notice that you see people talking without actually hearing them. This is intentional and means that they are either in a different frequency or out of range from you.

Without being in-game, you are only able to hear units transmitting over statewide frequencies (aka repeated frequencies). If you are in-game, you will be able to hear statewide frequencies AND units transmitting to with the same XMIT frequency as your RECV frequency is set (only up to 500 meters).

The latter frequency type discussed above is called "talk around channels," and are only audible to those both in-game and in-range of your radio device. The further away you get from the transmitting radio device, the more interference in the transmission. This means that out-of-game users (like dispatchers) will be unable to hear you unless you switch to a statewide frequency.

Talkover Protection

In patrol channels configured as such, units will be unable to talk over each other. This feature is called "talkover protection." When trying to talk over another unit, you will hear an audible tone that indicates that you must wait for the other unit to stop transmitting to start your transmission.

If you need to make an emergent transmission, you can override this behavior by double-clicking your push-to-talk button and then transmitting.

Unit Quick Actions

These two features allow you to quickly interact with another units' radio if you need to stop them from transmitting or grab their attention.

  • Radio Lock will mute the specified client and play a warning tone for them. This can be used if they hotmic or are being excessive with their transmissions.

  • Radio Attention will play the same tone as Radio Lock to grab the attention of the unit.

Dispatch Panel

For authorized servers, you are able to open the Dispatch UI through Plugins > SonoranRadio > Dispatch UI (if permissioned)

An error will be displayed in the chat box if your current server is not correct or not authorized.

Self Radio Settings

The first page you will see after opening the UI is the tab to change your own radio settings. It will look similar to this:

You are able to modify your own frequency on this page. If the server has a Pro-level subscription, you will also be able to edit your scanned frequencies through this panel.

When editing scanned frequencies, you are able to add a frequency by changing the frequency spinner and pressing Add. You can remove frequencies by right-clicking them in the list and pressing Remove. Please note that scanner settings only take effect after pressing Set on the bottom.

Please note that when selecting a preset in the Fill Preset dropdown, it will not automatically change your frequency. It only fills the boxes for you in the UI, and you'll have to press Change Frequency yourself for it to take effect.

Channel Clients' Radio Settings

The server manager must grant explicit permission for this if permissions are enabled for the server.

The second page you will see in the UI is the tab to change the radio settings of clients in your current channel. It will look similar to this:

You can edit the XMIT/RECV frequencies of another unit by changing the spinners and pressing Change Frequency. Fill Preset has the same behavior as on the Self Radio Settings tab. Match Selected Client being checked means that as you click different clients, the XMIT/RECV frequencies will be automatically filled in for that client.

Pro Tip You are able to select multiple clients at the same time by control-clicking or shift-clicking the clients. You are not able to edit the nickname of a client while selecting multiple clients.

Transmit Log

The third tab in the UI displays a log of the transmissions of each unit.

A green log represents a client has begun and transmission, and a red log represents when a client has ended a transmission.

The timestamp and nickname of the client are displayed first, then either the preset name or, if that doesn't exist, the RECV Frequency of the client is shown after the /.

Last updated