Skip to main content

session

The session command is used to manage Session Announcement Protocol (SAP) multicast advertising sessions on the encoder.

Synopsis

session create stream=id/name name=sessname advertise=yes/no 
 description=text keywords=text author=text copyright=text
[id=number] [addr=advipaddr] [port=advudpport]
session id/name delete
session id/name start
session id/name stop
session id/name get

Actions

ActionDescription

create

Creates an SAP session on the encoder. A series of one or more parameter=value pairs can be specified at once.

delete

Deletes the specified SAP session.

start

Starts the specified SAP session.

stop

Stops the specified SAP session.

get

Displays configuration information for the specified SAP session.

Parameters

ParameterDefaultDescription/Values
stream
n/a

A unique number or name assigned to the stream. The ID of the existing stream to be advertised via SAP.

Tip

Use “stream get all” to find the available streams and their IDs.

name
n/a

(Optional) Enter a unique name for the session. 1 to 63 characters

advertise
no

Enables or disables SAP network announcements.

description
n/a

(Optional) Enter an expanded description of the session.

keywords
n/a

(Optional) Enter one or more keywords to associate with the session. Keywords can serve as filters.

author
n/a

(Optional) Enter the name of the program's author.

copyright
n/a

(Optional) Enter the copyright information for the session.

[id]
n/a

When creating an SAP session, you can specify a unique id to assign to it or let the system assign one (a sequential number) for you.

addressBased on the stream’s destination IP address

(Optional) Use to overwrite the default to use specific non-standard advertising addresses for SAP messages.

port9875

Enter the SAP advertising UDP port.

Example

# session 1 get

Returns SAP session configuration information for the encoder, such as:

Session ID : 1
Name : "InfoDevSAP"
Configuration :
Description : "Test to document session command"
Keywords : "session"
Author : (None)
Copyright : "2018"
Advertise : Yes
Advertisement Address : Auto-Assign (224.2.127.254)
Advertisement Port : 9875
Streams : 8




JavaScript errors detected

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

If this problem persists, please contact our support.