Skip to main content

sap

The sap command is used to manage Session Announcement Protocol (SAP) multicast advertising settings.

Note

To display the list of advertised sessions, use the stream get all command. See stream.

Synopsis

sap get
sap enable
sap disable
sap start
sap stop
sap set

Actions

ActionDescription

get

Displays SAP configuration information.

enable

Enables the SAP service and starts listening for session advertisements.

disable

Disables the SAP service, stopping the listening for session advertisements and deleting any discovered streams.

start

Starts listening for SAP advertisements; service must be enabled.

stop

Stops listening for SAP advertisements and deletes any discovered streams.

set

Configures SAP settings. See Parameters below.

A series of one or more parameter=value pairs can be specified at once.

Parameters

ParameterDefaultDescription/Values
addressn/a

The multicast IPv4 address to listen on for IPv4 session announcements.

Use 0.0.0.0 to listen on the standard IPv4 scoped address.

Important

For IPv4, the decoder listens for SAP on three different addresses when automatic is selected:

  • 224.2.127.254 (IPv4 global scope announcement multicast address)
  • 239.255.255.255 (IPv4 local scope announcement multicast address)
  • 239.195.255.255 (IPv4 organization local scope announcement multicast address)

The standard IP addresses and ports for multicast SAP announcements are defined in RFC 2974.

v6address

The multicast IPv6 address to listen on for IPv6 session announcements.

Use :: to listen on the standard IPv6 scoped addresses.

Important

For IPv6, the decoder listens to FF0X::2:7FFE where X is the 4-bit scope value.

portn/a The UDP port to listen on for SAP messages.

Examples

# sap get

Returns sap configuration information for the decoder, such as:

Configuration:
Address : 224.2.127.254
UDP Port : 9875
# sap enable v6address=::

Returns the following confirmation:

SAP enabled successfully.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.