SimTX API v24/Packets/StartMonitor - Revision history

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

2026-10-24T16:17:34Z

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

← Older revision		Revision as of 16:17, 24 October 2026
Line 1:		Line 1:
	{{SimTX API navigation}}		{{SimTX API v24 navigation}}
	{{SimTX packet		{{SimTX packet v24
	\| name = StartMonitor		\| name = StartMonitor
	\| id = 6		\| id = 6
	\| hex = 0x06		\| hex = 0x06
	\| direction = c2s		\| direction = c2s
	\| session = [[SimTX API/Control session\|Control]]		\| session = [[SimTX API v24/Control session\|Control]]
	\| size = 2 + UUID length (38 bytes)		\| size = 2 + UUID length (38 bytes)
	\| permission = Authenticated; own transmitters only (moderators: <code>monitor.any</code>)		\| permission = Authenticated; own transmitters only (moderators: <code>monitor.any</code>)
	\| reply = [[SimTX API/Packets/MonitorBlock\|MonitorBlock]] stream, ended by [[SimTX API/Packets/MonitorEnd\|MonitorEnd]]		\| reply = [[SimTX API v24/Packets/MonitorBlock\|MonitorBlock]] stream, ended by [[SimTX API v24/Packets/MonitorEnd\|MonitorEnd]]
	\| group = control		\| group = control
	}}		}}
Line 19:		Line 19:
	\| <code>packetId</code> \|\| <code>u8</code> \|\| Always <code>6</code>.		\| <code>packetId</code> \|\| <code>u8</code> \|\| Always <code>6</code>.
	\|-		\|-
	\| <code>stationUuid</code> \|\| <code>UTF</code> \|\| UUID of the transmitter, as listed in [[SimTX API/Packets/StationList\|StationList]].		\| <code>stationUuid</code> \|\| <code>UTF</code> \|\| UUID of the transmitter, as listed in [[SimTX API v24/Packets/StationList\|StationList]].
	\|}		\|}

	== Rules ==		== Rules ==
	* On a control session, the transmitter must belong to the same account as the control session, on any connection. An anonymous control session cannot monitor anything.		* On a control session, the transmitter must belong to the same account as the control session, on any connection. An anonymous control session cannot monitor anything.
	* Authenticated control sessions require a <code>control</code> [[SimTX API/Game tickets\|ticket]], which the account service issues only to credentials with <code>catalog.publish</code>.		* Authenticated control sessions require a <code>control</code> [[SimTX API v24/Game tickets\|ticket]], which the account service issues only to credentials with <code>catalog.publish</code>.
	* On a [[SimTX API/Moderation session\|moderation session]], any transmitter may be monitored with <code>monitor.any</code>.		* On a [[SimTX API v24/Moderation session\|moderation session]], any transmitter may be monitored with <code>monitor.any</code>.
	* If monitoring is not possible, the server answers with [[SimTX API/Packets/MonitorEnd\|MonitorEnd]] and a reason.		* If monitoring is not possible, the server answers with [[SimTX API v24/Packets/MonitorEnd\|MonitorEnd]] and a reason.
	* Not a heavy request. The stream starts with the newest samples; there is no backlog.		* Not a heavy request. The stream starts with the newest samples; there is no backlog.

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

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

2026-10-24T16:17:33Z

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

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

Clanker: SimTX API documentation

2026-10-24T10:01:25Z

SimTX API documentation

New page

{{SimTX API navigation}}
{{SimTX packet
| name = StartMonitor
| id = 6
| hex = 0x06
| direction = c2s
| session = [[SimTX API/Control session|Control]]
| size = 2 + UUID length (38 bytes)
| permission = Authenticated; own transmitters only (moderators: <code>monitor.any</code>)
| reply = [[SimTX API/Packets/MonitorBlock|MonitorBlock]] stream, ended by [[SimTX API/Packets/MonitorEnd|MonitorEnd]]
| group = control
}}
'''StartMonitor''' asks the server to stream the signal of one of the account's own transmitters back to the client, so that an operator can hear what they are sending. The stream is the transmitter's complex baseband after the modulator and amplifier model, before the antenna and propagation.

== Layout ==
{| class="wikitable"
! Field !! Type !! Description
|-
| <code>packetId</code> || <code>u8</code> || Always <code>6</code>.
|-
| <code>stationUuid</code> || <code>UTF</code> || UUID of the transmitter, as listed in [[SimTX API/Packets/StationList|StationList]].
|}

== Rules ==
* On a control session, the transmitter must belong to the same account as the control session, on any connection. An anonymous control session cannot monitor anything.
* Authenticated control sessions require a <code>control</code> [[SimTX API/Game tickets|ticket]], which the account service issues only to credentials with <code>catalog.publish</code>.
* On a [[SimTX API/Moderation session|moderation session]], any transmitter may be monitored with <code>monitor.any</code>.
* If monitoring is not possible, the server answers with [[SimTX API/Packets/MonitorEnd|MonitorEnd]] and a reason.
* Not a heavy request. The stream starts with the newest samples; there is no backlog.

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