Editing SimTX API v24/Packets/ReceiverRetune

{{SimTX API v24 navigation}}
{{SimTX packet v24
| name = ReceiverRetune
| id = 13
| hex = 0x0D
| direction = c2s
| session = [[SimTX API v24/Receiver session|Receiver]]
| size = 4 bytes
| permission = None
| group = receiver
}}
'''ReceiverRetune''' moves a running receiver to a new centre frequency without reconnecting. It is the only packet a client may send on a receiver connection after the [[SimTX API v24/Packets/ReceiverSessionRequest|ReceiverSessionRequest]].

== Layout ==
{| class="wikitable"
! Field !! Type !! Description
|-
| <code>packetId</code> || <code>u8</code> || Always <code>13</code>.
|-
| <code>centerFreqHz</code> || <code>f32</code> || New centre frequency in hertz. Finite and ≥ 0.
|}

== Behaviour ==
* There is no acknowledgement and no new [[SimTX API v24/Packets/IqStreamDescriptor|IqStreamDescriptor]]. Sample rate, block size and bandwidth stay the same.
* The new frequency takes effect after a settling time of about 120 ms. Retunes received during that time are coalesced; only the latest is applied.
* Expect a short gap or transient in the stream around the change.
* A negative or non-finite frequency closes the connection. So does any packet other than ReceiverRetune.

== Example ==
<syntaxhighlight lang="text">
0D              packetId 13
4A 0C 61 80     centerFreqHz 2300000.0
</syntaxhighlight>

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

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