SimTX API v24/Packets/IqStreamDescriptor
Appearance
| Frame | {{{frame}}}, field {{{field}}}
|
|---|---|
| Member | {{{member}}}
|
| Direction | Server → client |
| Session | Receiver |
| Roles | |
| Permission | None |
| 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
chunkSamplesandsampleFormat: each IqBlock payload is exactly4 + chunkSamples × 2 × bytesPerComponentbytes, wherebytesPerComponentis 2 for INT16 and 1 for INT8. - No second descriptor is sent after a ReceiverRetune. Track the current frequency on the client side.