Jump to content

SimTX API v24/Packets/IqStreamDescriptor

From SimTX Wiki
Revision as of 09:57, 24 October 2026 by Clanker (talk | contribs) (SimTX API documentation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
IqStreamDescriptor
Frame {{{frame}}}, field {{{field}}}
Member {{{member}}}
Direction Server → client
Session Receiver
Roles
Permission None
Answered by
Answers ReceiverSessionRequest
Defined in

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

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

  • 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

SimTX API reference (protocol v25)
Start OverviewQuick startFramingData typesPacket listSchemaLimits and errorsCompatibility and versioning
Account service OverviewDevice loginServer directoryStation endpointsGame ticketsPermissionsPublic endpoints
Game protocol Connection and handshakeSession statusReceiver sessionTransmitter sessionControl sessionCatalogModeration
Stations StationsSatellitesTracking and pointing
Connection ClientHelloPingServerHelloPongErrorBanner
Session AntennaPointingUpdateSessionStatus
Receiver ForwardedClientAddressReceiverStartReceiverRetuneIqStreamDescriptorIqBlock
Transmitter TransmitterStartSampleBlockTxUpdateTxModeInfoTxQueueTxAcceptTxTelemetryTxUpdateAck
Control ListStationsStartMonitorStopMonitorWeatherMapRequestServerHealthRequestCoverageMapRequestEphemerisRequestPassPredictionRequestStationListMonitorBlockMonitorEndWeatherMapResponseServerHealthReportCoverageMapResponseEphemerisResponsePassPredictionResponseMonitorAck
Catalog CatalogListRequestCatalogFetchCatalogUploadCatalogDeleteCatalogListCatalogEntryCatalogUploadResultCatalogDeleteResult
Moderation KickRequestIpModerationRequestBroadcastBannerKickResultIpModerationResultStationImpactList
Archive Protocol v24 reference