Editing SimTX API/Packets/MonitorEnd

{{SimTX API navigation}}
{{SimTX packet
| name = MonitorEnd
| frame = ServerFrame
| field = 32
| member = monitor_end
| direction = s2c
| session = [[SimTX API/Control session|Control]], [[SimTX API/Moderation session|moderation]]
| roles = <code>ROLE_CONTROL</code>, <code>ROLE_MODERATION</code>.
| permission = None
| group = control
| file = control.proto
}}
'''MonitorEnd''' tells the client that the server ended a running monitor stream, for example because the transmitter went off the air. A monitor that cannot be started is answered with [[SimTX API/Packets/Error|Error]] instead, and one stopped by the client with [[SimTX API/Packets/MonitorAck|MonitorAck]].

== Definition ==
<syntaxhighlight lang="protobuf">
message MonitorEnd {
  bytes session_id = 1;
  string reason = 2;
}
</syntaxhighlight>

== Fields ==
{| class="wikitable"
! # !! Field !! Type !! Description
|-
| 1 || <code>session_id</code> || <code>bytes</code> || The transmitter.
|-
| 2 || <code>reason</code> || <code>string</code> || Human-readable reason, for example <i>Transmitter went off the air</i>.
|}

== Reasons ==
{| class="wikitable"
! Reason !! Meaning
|-
| ''Transmitter went off the air'' || The monitored session ended.
|-
| ''Shard connection ended'' || The server hosting the transmitter became unreachable.
|}

== See also ==
* [[SimTX API/Packets/StartMonitor|StartMonitor]]

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