disconnect

The disconnect command tears down routed connections in a DisplayNet system, regardless of the signal or connection type. For multicast streams (such as HDMI), the receiver leaves the stream and the source stream is stopped and its multicast address freed. For unicast connections (such as RS232 or USB), the connection is terminated.


Command Type	DisplayNet
Minimum Version	2.x.x

Usage

disconnect <type | type_macro> <destination>[,<destination>...] [tx | rx]
disconnect wall <wall_name>

Arguments

Argument	Required	Description
`type`	Yes	The signal layer to disconnect, or a macro covering several layers. See Types and Type macros.
`destination`	Yes	Device(s) to disconnect. See Destinations. For `wall`, the name of the wall.
`tx` / `rx`	No	Restricts the disconnect to the device's transmit or receive side. See Side restriction.

Types

Value	Disconnects
`HDMI`	The primary HDMI video stream
`SCALER`	The scaled HDMI video stream (used in multiviews)
`THUMBNAIL`	The thumbnail stream
`STEREO_AUDIO`	The analog stereo audio stream
`HDMI_AUDIO`	The HDMI audio stream
`MULTICH_AUDIO`	The multichannel audio stream
`RS232`	RS-232 connections (both directions of a bidirectional link)
`INFRARED`	Infrared connections
`CEC`	CEC connections
`USB`	USB pairings (aliases: `USB2`, `USB_EXTENDER`)
`USB_HID`	HID (keyboard/mouse) pairings
`MTV`	A multiview connection on the given receiver(s)
`WALL`	A wall's routing. The destination is a wall name, not a device

Type macros

A type macro disconnects several layers in a single command:

Macro	Expands to
`ALL_VIDEO`	`HDMI`, `SCALER`, `THUMBNAIL`
`ALL_AUDIO`	`STEREO_AUDIO`, `HDMI_AUDIO`, `MULTICH_AUDIO`
`ALL_SERIAL`	`RS232`, `INFRARED`, `CEC`
`ALL_LAYERS`	All video, audio, and serial layers, plus `USB`

Destinations

Value	Disconnects
`<device>`	A single device, by hostname or MAC address
`<device>,<device>,...`	Each listed device
`ALL`	All devices in the system
`ALL_TX`	All transmitter devices
`ALL_RX`	All receiver devices

Disconnecting a transmitter detaches every receiver subscribed to its stream, then stops the stream and frees its multicast address. Disconnecting a receiver only detaches that receiver; the source continues streaming for any other subscribers.

A multiview configuration name is also accepted as a destination: it disconnects every receiver currently showing that multiview.

Side restriction

When a destination acts as both a source and a sink (a transceiver, or a device list that mixes both), the optional trailing tx or rx keyword limits the disconnect to one role. Without it, both roles are torn down.

Value	Effect
`tx`	Only tear down the device's outgoing connections. Subscribed receivers detach; the device's own incoming subscriptions stay up.
`rx`	Only tear down the device's incoming connections. The device's outgoing streams keep running for their subscribers.

The keyword is case-insensitive. Any other value is an error and no routing changes are applied.

The restriction applies to the video, audio, and serial types. A USB, USB_HID, or MTV connection has no separate sides, and naming a side with those types is an error. Within ALL_LAYERS, the USB layer is skipped when a side is given.

Examples

Disconnect everything from every device
disconnect all_layers all

Disconnect HDMI video from two receivers
disconnect hdmi lobby_left,lobby_right

Disconnect all audio layers from a source
disconnect all_audio bluray_player

Remove a seat's USB pairing
disconnect usb front_desk

Exit multiview on a receiver
disconnect mtv control_room_rx

Detach every receiver without stopping any source streams
disconnect hdmi all rx

Stop a transceiver's outgoing stream only
disconnect hdmi conference_trx tx

Return value

On success, the result lists the low-level SDVoE commands that were issued:

disconnect hdmi lobby_left
{
  "status": "SUCCESS",
  "request_id": null,
  "result": {
    "rawcommands": ["leave 001ec0f04d9c:HDMI:0"]
  },
  "error": null
}

Errors

On failure, no routing changes are applied and status is "ERROR":

Error	Cause
`Invalid Arguments`	Missing destination, or an unrecognized type
`Invalid device type '<value>': expected tx or rx`	The trailing side keyword is not `tx` or `rx`
`'<side>' cannot be used with <type>: this layer has no separate tx or rx sides`	A side keyword with `USB`, `USB_HID`, or `MTV`
`Cannot disconnect locked device <name>`	The receiver is locked in DisplayNet Manager
`Cannot stop stream on locked source <name>`	The source is locked in DisplayNet Manager
`Cannot disconnect: subscribed device <name> is locked`	A locked receiver is subscribed to the source being disconnected

State and side effects

The routing record created by connect is cleared, so DisplayNet Manager and any later snapshot preset match the system. An SDVoE leave or stop tears down the stream without clearing the record, leaving DisplayNet reporting a route that no longer exists.
MultiView sessions on the affected devices are updated, so a session is not left pointing at a stream that has stopped.
A locked device is refused. See lock.

Notifications

Disconnecting devices generally results in one or more NOTIFICATION or DN_NOTIFICATION replies reflecting the updated state of the devices. See Notifications.

REST API

Endpoint type	DisplayNet API command
Address	`POST /api/displaynet/<operation>`, or name the operation in the body of a `POST /api/displaynet`. See Sending commands.
Role	`User`

Subcommand	Operation	Parameters
`all_audio`	`disconnect_all_audio`	`devices` `[device_type]`
`all_layers`	`disconnect_all_layers`	`devices` `[device_type]`
`all_serial`	`disconnect_all_serial`	`devices` `[device_type]`
`all_video`	`disconnect_all_video`	`devices` `[device_type]`
`cec`	`disconnect_cec`	`devices` `[device_type]`
`hdmi`	`disconnect_hdmi`	`devices` `[device_type]`
`hdmi_audio`	`disconnect_hdmi_audio`	`devices` `[device_type]`
`infrared`	`disconnect_infrared`	`devices` `[device_type]`
`mtv`	`disconnect_mtv`	`devices` `[device_type]`
`multich_audio`	`disconnect_multich_audio`	`devices` `[device_type]`
`rs232`	`disconnect_rs232`	`devices` `[device_type]`
`scaler`	`disconnect_scaler`	`devices` `[device_type]`
`stereo_audio`	`disconnect_stereo_audio`	`devices` `[device_type]`
`thumbnail`	`disconnect_thumbnail`	`devices` `[device_type]`
`usb`	`disconnect_usb`	`devices` `[device_type]`
`usb_extender`	`disconnect_usb_extender`	`devices` `[device_type]`
`usb_hid`	`disconnect_usb_hid`	`devices` `[device_type]`
`usb_icron`	`disconnect_usb_icron`	`devices` `[device_type]`
`usb2`	`disconnect_usb2`	`devices` `[device_type]`
`wall`	`disconnect_wall`	`wall`

A parameter in brackets is optional.

Usage​

Arguments​

Types​

Type macros​

Destinations​

Side restriction​

Examples​

Return value​

Errors​

State and side effects​

Notifications​

REST API​

See also​