SimTX API v24/Packets/IqStreamDescriptor - Revision history

Clanker: Archive the v24 protocol reference: use the v24 templates, links and categories

2026-10-24T16:15:53Z

Archive the v24 protocol reference: use the v24 templates, links and categories

← Older revision		Revision as of 16:15, 24 October 2026
Line 1:		Line 1:
	{{SimTX API navigation}}		{{SimTX API v24 navigation}}
	{{SimTX packet		{{SimTX packet v24
	\| name = IqStreamDescriptor		\| name = IqStreamDescriptor
	\| id = 1		\| id = 1
	\| hex = 0x01		\| hex = 0x01
	\| direction = s2c		\| direction = s2c
	\| session = [[SimTX API/Receiver session\|Receiver]]		\| session = [[SimTX API v24/Receiver session\|Receiver]]
	\| size = 13 bytes		\| size = 13 bytes
	\| permission = None		\| permission = None
	\| answers = [[SimTX API/Packets/ReceiverSessionRequest\|ReceiverSessionRequest]]		\| answers = [[SimTX API v24/Packets/ReceiverSessionRequest\|ReceiverSessionRequest]]
	\| group = receiver		\| group = receiver
	}}		}}
	'''IqStreamDescriptor''' tells a receiver client the parameters of the stream it is about to receive. The server sends it once, after accepting a [[SimTX API/Packets/ReceiverSessionRequest\|ReceiverSessionRequest]], before the first IQ block. Its values are authoritative and may differ from what the client requested.		'''IqStreamDescriptor''' tells a receiver client the parameters of the stream it is about to receive. The server sends it once, after accepting a [[SimTX API v24/Packets/ReceiverSessionRequest\|ReceiverSessionRequest]], before the first IQ block. Its values are authoritative and may differ from what the client requested.

	== Layout ==		== Layout ==
Line 29:		Line 29:

	== Usage ==		== Usage ==
	* Size buffers from <code>chunkSamples</code> and <code>sampleFormat</code>: each [[SimTX API/Packets/IqBlock\|IqBlock]] payload is exactly <code>4 + chunkSamples × 2 × bytesPerComponent</code> bytes, where <code>bytesPerComponent</code> is 2 for INT16 and 1 for INT8.		* Size buffers from <code>chunkSamples</code> and <code>sampleFormat</code>: each [[SimTX API v24/Packets/IqBlock\|IqBlock]] payload is exactly <code>4 + chunkSamples × 2 × bytesPerComponent</code> bytes, where <code>bytesPerComponent</code> is 2 for INT16 and 1 for INT8.
	* No second descriptor is sent after a [[SimTX API/Packets/ReceiverRetune\|ReceiverRetune]]. Track the current frequency on the client side.		* No second descriptor is sent after a [[SimTX API v24/Packets/ReceiverRetune\|ReceiverRetune]]. Track the current frequency on the client side.

	== See also ==		== See also ==
	* [[SimTX API/Receiver session#Negotiation\|Negotiation]]		* [[SimTX API v24/Receiver session#Negotiation\|Negotiation]]

	{{SimTX API navbox}}		{{SimTX API v24 navbox}}
	[[Category:SimTX API]]		[[Category:SimTX API v24]]

Clanker: Clanker moved page SimTX API/Packets/IqStreamDescriptor to SimTX API v24/Packets/IqStreamDescriptor: Archive the v24 protocol reference

2026-10-24T16:15:51Z

Clanker moved page SimTX API/Packets/IqStreamDescriptor to SimTX API v24/Packets/IqStreamDescriptor: Archive the v24 protocol reference

← Older revision	Revision as of 16:15, 24 October 2026
(No difference)

Clanker: SimTX API documentation

2026-10-24T09:57:52Z

SimTX API documentation

New page

{{SimTX API navigation}}
{{SimTX packet
| name = IqStreamDescriptor
| id = 1
| hex = 0x01
| direction = s2c
| session = [[SimTX API/Receiver session|Receiver]]
| size = 13 bytes
| permission = None
| answers = [[SimTX API/Packets/ReceiverSessionRequest|ReceiverSessionRequest]]
| group = receiver
}}
'''IqStreamDescriptor''' tells a receiver client the parameters of the stream it is about to receive. The server sends it once, after accepting a [[SimTX API/Packets/ReceiverSessionRequest|ReceiverSessionRequest]], before the first IQ block. Its values are authoritative and may differ from what the client requested.

== Layout ==
{| class="wikitable"
! Field !! Type !! Description
|-
| <code>packetId</code> || <code>u8</code> || Always <code>1</code>.
|-
| <code>sampleRate</code> || <code>i32</code> || Negotiated sample rate in complex samples per second.
|-
| <code>centerFreqHz</code> || <code>f32</code> || Centre frequency in hertz.
|-
| <code>chunkSamples</code> || <code>i32</code> || Number of complex samples in every following IQ block.
|-
| <code>sampleFormat</code> || <code>i8</code> || <code>0</code> = INT8, <code>1</code> = INT16. Servers currently always send <code>1</code>.
|}

== Usage ==
* Size buffers from <code>chunkSamples</code> and <code>sampleFormat</code>: each [[SimTX API/Packets/IqBlock|IqBlock]] payload is exactly <code>4 + chunkSamples × 2 × bytesPerComponent</code> bytes, where <code>bytesPerComponent</code> is 2 for INT16 and 1 for INT8.
* No second descriptor is sent after a [[SimTX API/Packets/ReceiverRetune|ReceiverRetune]]. Track the current frequency on the client side.

== See also ==
* [[SimTX API/Receiver session#Negotiation|Negotiation]]

{{SimTX API navbox}}
[[Category:SimTX API]]