stop

The stop command stops one or more streams on one or more devices, and optionally frees the multicast address associated with each stopped stream so it can be reused.

Command Type	SDVoE
Minimum Version	2.x.x

Usage

stop <target>[:<stream_type>[:<stream_index>]] [free]

If stream_index is omitted, all streams of the given type are stopped. If stream_type is also omitted, all HDMI, HDMI_AUDIO, STEREO_AUDIO, and MULTICH_AUDIO streams on the target are stopped. In that form the target cannot be a receiver device or the ALL_RX group.

Arguments

Argument	Required	Description
target	Yes	Device ID of a single device, or a device group. See Targets.
stream_type	No	The type of stream to stop. See Stream types.
stream_index	No	The index of a stream of the specified type. Requires stream_type.
free	No	Frees the multicast address associated with each stopped stream. See Freeing addresses.

Targets

Value	Stops streams on
<device_id>	A single device
ALL	All devices
ALL_TX	All transmitter devices
ALL_RX	All receiver devices

Stream types

Supported on all device types:

Value	Stream
CEC	A CEC data stream
INFRARED	An infrared data stream
MULTICH_AUDIO	A multichannel (quad I2S) audio stream
RS232	An RS-232 data stream
USB_EXTENDER	A USB 2.0 stream

Supported on transmitter devices only:

Value	Stream
HDMI	An HDMI video stream
HDMI_AUDIO	An HDMI audio stream
STEREO_AUDIO	A stereo (single I2S) audio stream
THUMBNAIL	A video thumbnail stream

note

The stream-type literal was renamed from USB_ICRON to USB_EXTENDER in API 3.8 (alongside the USB_EXTENDER node), and the legacy USB_ICRON literal was removed in API 3.9. Use USB_EXTENDER as the stream_type argument for switch and stop; USB_ICRON is only accepted by Control Servers older than 3.9. See the USB Extender Node Rename Migration Guide for the full picture.

Freeing addresses

If the free keyword is present, the multicast IP address associated with each stopped stream is released for reuse. For RS232 and INFRARED streams, which have no associated multicast address, free is allowed but ignored, as it is for a THUMBNAIL stream that uses a unicast address (NT1000/NT2000 devices).

Examples

Stop the primary HDMI stream on a transmitter
stop 001ec0f04d9c:HDMI:0

Stop a stream and release its multicast address
stop 001ec0f04d9c:HDMI:0 free

Stop all AV streams on every transmitter
stop ALL_TX

Return value

stop is processed asynchronously. The immediate reply is PROCESSING with a request_id. Read the outcome with request.

stop 001ec0f04d9c:HDMI:0
{
  "status": "PROCESSING",
  "request_id": 61,
  "result": null,
  "error": null
}

Errors

Request-level errors:

Error	Cause
ILLEGAL_ARGUMENT	The target is an invalid device ID or group name

The operation may also fail for individual devices:

Error	Cause
DEVICE_TYPE	The device does not have the specified stream type or index
DEVICE_TYPE	stream_type was omitted and the device is a receiver

REST API

Endpoint type	SDVoE API command, forwarded to the Control Server
Address	/api/device/{target}
Role	Governed by the device lock rather than by a DisplayNet role

POST /api/device/{target}

{
  "op": "stop",
  "stream_type": "String (optional)",
  "stream_index": "Integer (optional)",
  "free": "Boolean"
}

Values labeled with a type name such as String or Integer are placeholders, not literal text. Replace them with actual values; fields marked (optional) can be omitted.

{target} takes a DisplayNet device name as readily as a device ID, and a locked device refuses a mutating operation. See SDVoE API operations for what DisplayNet adds to these calls.

See also

• start: start streams
• disconnect: tear down routing (stops and frees source streams as needed)