Application note: SIP

Application note: SIP Rev 6

03/07/2019

CONTENT

Use .......................................................................................................................................................................... 3

Settings.................................................................................................................................................................... 3

Variable corresponding to the SIP device ........................................................................................................... 4

SIP server configuration ...................................................................................................................................... 6

SIP SERVER user’s credentials ............................................................................................................................. 7

Client interface ........................................................................................................................................................ 8

Troubleshooting ...................................................................................................................................................... 9

www.prysm.fr 2
 Application note: SIP Rev 6
03/07/2019

USE

SIP integration in AppVision allows you to communicate with SIP devices in peer-to-peer mode or
through a SIP server. AppVision works as a SIP client device using microphone and speakers of the client station.
Audio license is required for each SIP device declared in AppVision.

Available in Version 4.1.0.3 and above

SETTINGS

Like you would create a camera typed variable to represent a camera, you must create an audio typed
variable to represent an intercom. An intercom can be anything that support SIP protocol like intercom from the
market, SIP softphone (like X-Lite for exemple) or even an AppVision client.

Tree view of variables representing a SIP device:

- Node
o Client1
 Audio var
 Event var (Appvision client only)
 Cmd var

….

o Clientx
 Audio var
 Event var (Appvision client only)
 Cmd var

www.prysm.fr 3
 Application note: SIP Rev 6
03/07/2019

VARIABLE CORRESPONDING TO THE SIP DEVICE

Node variable

Create a “Node” variable corresponding to the SIP device, in our example: SIP1. Fill the address parameter of
the node variable with the SIP address of the device. If the device is Peer to peer just type the IP address
(192.168.0.88 for example). But if you are working with a SIP server, type the sip address like this:
client_name@sip_domain. Where client_name is the name inside the SIP server and sip_domain is the SIP domain
name (ex: client1@officesip.local).

Example: A variable named SIP.Client1 with the SIP address ‘client1@officesip.local’

This node variable can also be linked to a camera variable using the video field so during the call, the video will
display inside the remote client interface.

Example: A variable named SIP.Client1 with the Camera ‘Onvif cameras/AXIS A8004-VE/vidéo’

www.prysm.fr 4
 Application note: SIP Rev 6
03/07/2019

- Audio variable

Create an audio typed variable inside the above node. This variable must be named ‘Audio’.

- Event variable (only for device representing an AppVision SIP client).

Create an enumeration variable inside the above node. This variable must be named ‘Event’. This variable
will only be affected by the current AppVision client. This means that this variable will changes its value when the
corresponding client performs SIP operation (like called or being called).

When an AppVision client connect with the clien1 user on the officesip.local SIP server, this same client will update
the Event variable with the following values :

0:Normal Normal state (Not in communication)

1:Communicating Is actually communicating with a SIP device
2:Ringing Is actually being called by a SIP device
3:Calling Is actually calling a SIP device

- Cmd variable

You can create a logical typed variable named ‘Cmd’ with the flag command. When calling or being called by
someone, a command button will display inside the interface. A click on this very button will pulse the Cmd variable
to 1.

www.prysm.fr 5
 Application note: SIP Rev 6
03/07/2019

SIP SERVER CONFIGURATION

Like it says in the introduction, AppVision can work in peer to peer or through SIP server. Peer to peer
mode does not require any specific configuration. Registration on a SIP server must be configurate inside the
configurator. Each AppVision user can register to a SIP server. Once an AppVision user will open the AppVision
Windows Client, he will be registered to the SIP server declared in Configurator’s options / Audio.

SIP registration field must be checked.

Address: SIP Server IP address

Port: SIP port number (generally 5060)

Domain: SIP domain (information available in SIP server configuration)

Refresh interval: Interval in seconds of re-registration message to the SIP server. Example: A value of 300 will
tells each client to send a REGISTER message to SIP server every 300 seconds. (SIP server requires that each of
their client send REGISTER message every x seconds to tells them they are still online). If this field is empty, 180
will be used as default value.

SIP configuration sample:

www.prysm.fr 6
 Application note: SIP Rev 6
03/07/2019

SIP SERVER USER’S CREDENTIALS

For each AppVision user you can add the SIP user’s credentials inside the page users like below:

www.prysm.fr 7
 Application note: SIP Rev 6
03/07/2019

CLIENT INTERFACE

When connecting on AppVision, you can open the right Panel and click on the tab audio. (The audio
tab is only visible if an Audio license is available).

Actual SIP status of

the client. Peer to
peer or registered on
xxx (where xxx is a SIP
domain)
For calling an address
Ex: 192.168.0.2 or
client@officesip.local
List of Audio variables
inside AppVision (call by
double click)
List of AppVision client
Connected
(call by double click)

www.prysm.fr 8
 Application note: SIP Rev 6
03/07/2019

Incoming calls are displayed

here (You can accept or reject
the call).

Current call with video display.

TROUBLESHOOTING

This message means you need to plug a microphone on the compute

www.prysm.fr 9