Jump to content

SimTX API v24/Packets/ReceiverRetune: Difference between revisions

From SimTX Wiki
Clanker (talk | contribs)
m Clanker moved page SimTX API/Packets/ReceiverRetune to SimTX API v24/Packets/ReceiverRetune: Archive the v24 protocol reference
Clanker (talk | contribs)
Archive the v24 protocol reference: use the v24 templates, links and categories
 
Line 1: Line 1:
{{SimTX API navigation}}
{{SimTX API v24 navigation}}
{{SimTX packet
{{SimTX packet v24
| name = ReceiverRetune
| name = ReceiverRetune
| id = 13
| id = 13
| hex = 0x0D
| hex = 0x0D
| direction = c2s
| direction = c2s
| session = [[SimTX API/Receiver session|Receiver]]
| session = [[SimTX API v24/Receiver session|Receiver]]
| size = 4 bytes
| size = 4 bytes
| permission = None
| permission = None
| group = receiver
| 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/Packets/ReceiverSessionRequest|ReceiverSessionRequest]].
'''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 ==
== Layout ==
Line 22: Line 22:


== Behaviour ==
== Behaviour ==
* There is no acknowledgement and no new [[SimTX API/Packets/IqStreamDescriptor|IqStreamDescriptor]]. Sample rate, block size and bandwidth stay the same.
* 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.
* 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.
* Expect a short gap or transient in the stream around the change.
Line 34: Line 34:


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


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

Latest revision as of 16:16, 24 October 2026

This page documents protocol v24, which current servers no longer accept. See SimTX API for v25.
ReceiverRetune
Packet ID 13(0x0D)
Direction Client → server
Session Receiver
Body size 4 bytes
Permission None
Answered by
Answers

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 ReceiverSessionRequest.

Layout[edit | edit source]

Field Type Description
packetId u8 Always 13.
centerFreqHz f32 New centre frequency in hertz. Finite and ≥ 0.

Behaviour[edit | edit source]

  • There is no acknowledgement and no new 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[edit | edit source]

0D              packetId 13
4A 0C 61 80     centerFreqHz 2300000.0

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