Table of Contents
List of Examples
janus_send_timeout parameterjanus_max_msg_chunks parameterjanus_cmd_timeout parameterjanus_cmd_polling_itv parameterjanus_ping_interval parameterjanus_db_url parameterjanus_db_table parameter
janus_send_request() usage
E_JANUS_EVENT exampleThe "janus" module is a C driver for the Janus websocket protocol. It can interact with one or more Janus servers either by issuing commands to them, or by receiving events from them.
This driver can be seen as a centralized Janus connection manager. It will connect to each Janus server, establish the connection hanler ID and the clients can be transparent from the connection handler ID point of view, simply passing the desired Janus commands that they want to run.
The following modules must be loaded together with this module:
an SQL DB module
The following libraries or applications must be installed before running OpenSIPS with this module loaded:
None
Time in milliseconds after a Janus WebSocket connection will be closed if it is not available for blocking writing in this interval (and OpenSIPS wants to send something on it).
Default value is “1000” (milliseconds).
Example 1.1. Setting the janus_send_timeout parameter
...
modparam("janus", "janus_send_timeout", 2000)
...
The maximum number of chunks in which a Janus message is expected to arrive via WebSocket. If a received packet is more fragmented than this, the connection is dropped
Default value is “4”
Example 1.2. Setting the janus_max_msg_chunks parameter
...
modparam("janus", "janus_max_msg_chunks", 8)
...
The maximally allowed duration for the execution of an Janus command. This interval does not include the connect duration.
Default value is “5000” (milliseconds).
Example 1.3. Setting the janus_cmd_timeout parameter
...
modparam("janus", "janus_cmd_timeout", 3000)
...
The sleep interval used when polling for an Janus command response. Since the value of this parameter imposes a minimal duration for any Janus command, you should run OpenSIPS in debug mode in order to first determine an expected response time for an arbitrary Janus command, then tune this parameter accordingly.
Default value is “1000” (microseconds).
Example 1.4. Setting the janus_cmd_polling_itv parameter
...
modparam("janus", "janus_cmd_polling_itv", 3000)
...
The time interval at which OpenSIPS will do keepalive pinging on the Janus connect
Default value is “5” (seconds).
Example 1.5. Setting the janus_ping_interval parameter
...
modparam("janus", "janus_ping_interval", 10)
...
Run an arbitrary command on an arbitrary Janus socket. The janus_id must be defined in the database
The current OpenSIPS worker will block until an answer from Janus arrives. The timeout for this operation can be controlled via the janus_cmd_timeout param.
Meaning of the parameters is as follows:
janus_id (string) - the ID of the janus connection as defined in the databsae.
janus_command (string) - the JANUS command to run.
response_var (var, optional) - a variable which will hold the text result of the Janus command.
Return value
1 (success) - the Janus command executed successfully and any output variables were successfully written to. Note that this does not say anything about the nature of the Janus answer (it may well be a "-ERR" type of response)
-1 (failure) - internal error or the Janus command failed to execute
This function can be used from any route.
Example 1.8.
janus_send_request() usage
...
# if the DB contains:
# id: 1
# janus_id: test_janus
# janus_url: janusws://my_janus_host:80/janus?room=abcd
$var(rc) = janus_send_request("test_janus", "{
"janus": "attach",
"plugin": "janus.plugin.videoroom",
"transaction": "abcdef123456",
"session_id": 987654321
}", $var(response));
if (!$var(rc)) {
xlog("failed to execute Janus command ($var(rc))\n");
return -1;
}
xlog("Janus response is $var(response) \n");
...
...
This event is raised when a notification is received from a Janus server.
Parameters represent the janus_id and the janus_url that originated the notification, and the full janus_body of the event received
janus_id - the janus id as defined in the database
janus_url - the janus url as defined in the database
janus_body - full body of the notification received from janus
Example 1.9.
E_JANUS_EVENT example
...
# if the DB contains:
# id: 1
# janus_id: test_janus
# janus_url: janusws://my_janus_host:80/janus?room=abcd
event_route[E_JANUS_EVENT] {
xlog("Received janus event from $param(janus_id) - $param(janus_url) - $param(janus_body) \n");
$json(janus_body) := $param(janus_body);
$avp(janus_sender) = $json(janus_body/sender);
if ($avp(janus_sender) != NULL) {
xlog("Received event from sender $avp(janus_sender) \n");
}
}
...
...
Documentation Copyrights:
Copyright © 2024 OpenSIPS Project;