package dcs.srs.v0

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc GetClients (GetClientsRequest, GetClientsResponse)

  srs.proto:17

  Retrieve a list of units (players) and their active frequencies that are connected to SRS.

  message GetClientsRequest

  srs.proto:93

  (message has no fields)

  message GetClientsResponse

  srs.proto:96

  • repeated GetClientsResponse.Client clients = 1

• rpc Transmit (TransmitRequest, TransmitResponse)

  srs.proto:14

  Synthesize text to speech and transmit it over SRS. By default, this blocks until a transmission completed (unless `async` is set to `true`). This can be used to prevent transmission to overlap each other, by not sending another transmission on the same frequency until you've received the response from the previous transmission on that frequency. However, it does not block or prevent any other client from transmitting over the same frequency at the same time.

  message TransmitRequest

  srs.proto:20

  • string ssml = 1

    The text that is synthesized to speech and transmitted to SRS. Supports SSML tags (you should not wrap the text in the root `<speak>` tag though).

  • optional string plaintext = 2

    The plain text without any transformations made to it for the purpose of getting it spoken out as desired (no SSML tags, no FOUR NINER instead of 49, ...). Even though this field is optional, please consider providing it as it can be used to display the spoken text to players with hearing impairments.

  • uint64 frequency = 3

    The radio frequency in Hz the transmission is send to. Example: 251000000 for 251.00MHz.

  • optional string srs_client_name = 4

    Name of the SRS client. Defaults to "DCS-gRPC".

  • optional common.v0.InputPosition position = 5

    The origin of the transmission. Relevant if the SRS server has "Line of Sight" and/or "Distance Limit" enabled.

  • common.v0.Coalition coalition = 6

    The coalition of the transmission. Relevant if the SRS server has "Secure Coalition Radios" enabled. Only Blue and Red are supported, all other values will fallback to Spectator.

  • bool async = 7

    Whether to keep the request open until the whole transmission was sent. If enabled, you can send the next transmission after you've received the response for the previous one and be sure that they don't overlap (talk over each other). If disabled, you'll receive a response right away (kind of fire and forget). You can use the returned duration as a spacing between TTS requests to prevent the overlap of multiple playbacks yourself.

  • oneof provider

    Optional TTS provider to be use. Defaults to the one configured in your config or to Windows' built-in TTS.

    • TransmitRequest.Aws aws = 8

    • TransmitRequest.Azure azure = 9

    • TransmitRequest.GCloud gcloud = 10

    • TransmitRequest.Windows win = 11

  message TransmitResponse

  srs.proto:88

  • uint32 duration_ms = 1

    The duration in milliseconds it roughly takes to speak the transmission.

Used in: GetClientsResponse

• optional common.v0.Unit unit = 1

  The unit that is connected to SRS.

• repeated uint64 frequencies = 2

  The radio frequencies in Hz the unit is connected to.

Used in: TransmitRequest

• optional string voice = 1

  The voice the text is synthesized in, see: https://docs.aws.amazon.com/polly/latest/dg/voicelist.html

Used in: TransmitRequest

• optional string voice = 1

  The voice the text is synthesized in, see: https://learn.microsoft.com/azure/cognitive-services/speech-service/language-support

Used in: TransmitRequest

• optional string voice = 1

  The voice the text is synthesized in, see: https://cloud.google.com/text-to-speech/docs/voices

Used in: TransmitRequest

• optional string voice = 1

  The voice the text is synthesized in.