Jump to content

SimTX API v24/Packets/IqStreamDescriptor

From SimTX Wiki
This page documents protocol v24, which current servers no longer accept. See SimTX API for v25.
IqStreamDescriptor
Packet ID 1(0x01)
Direction Server → client
Session Receiver
Body size 13 bytes
Permission None
Answered by
Answers ReceiverSessionRequest

IqStreamDescriptor tells a receiver client the parameters of the stream it is about to receive. The server sends it once, after accepting a ReceiverSessionRequest, before the first IQ block. Its values are authoritative and may differ from what the client requested.

Layout[edit | edit source]

Field Type Description
packetId u8 Always 1.
sampleRate i32 Negotiated sample rate in complex samples per second.
centerFreqHz f32 Centre frequency in hertz.
chunkSamples i32 Number of complex samples in every following IQ block.
sampleFormat i8 0 = INT8, 1 = INT16. Servers currently always send 1.

Usage[edit | edit source]

  • Size buffers from chunkSamples and sampleFormat: each IqBlock payload is exactly 4 + chunkSamples × 2 × bytesPerComponent bytes, where bytesPerComponent is 2 for INT16 and 1 for INT8.
  • No second descriptor is sent after a ReceiverRetune. Track the current frequency on the client side.

See also[edit | edit source]

SimTX API v24 reference (protocol v24, archived)
Start OverviewQuick startData typesLimits and errorsPacket list
Account service OverviewDevice loginServer directoryGame ticketsPermissionsPublic endpoints
Game protocol Connection and handshakeReceiver sessionTransmitter sessionControl sessionCatalogModeration
Handshake HandshakeHandshakeResult
Receiver ReceiverSessionRequestReceiverRetuneForwardedClientAddressIqStreamDescriptorIqBlockTimedIqBlock
Transmitter TransmitterSessionRequestSampleBlockTxModeInfoTxUpdateTxQueueTxAcceptTxRejectTxKickTxTelemetryTxUpdateAck
Control ControlAckBannerListStationsStationListServerHealthRequestServerHealthReportCoverageMapRequestCoverageMapResponseWeatherMapRequestWeatherMapResponseStartMonitorStopMonitorMonitorBlockMonitorEnd
Catalog CatalogListRequestCatalogListCatalogFetchCatalogEntryCatalogUploadCatalogUploadResultCatalogDeleteCatalogDeleteResult
Moderation KickRequestKickResultIpModerationRequestIpModerationResultBroadcastBannerModerationErrorStationImpactList
Current Protocol v25 reference