Configuring the Test Call Service

Pexip Infinity provides a test loopback service that allows users to check the quality of their video and audio (i.e. that their local camera, microphone and speakers are working properly), and verifies that they can connect to a Conferencing Node.

Test Call Services are configured within Pexip Infinity in the same manner as other services such as Virtual Receptions. By default, Pexip Infinity includes a preconfigured Test Call Service (called "Test Call Service") and an associated alias of "test_call" that can be used to dial into the Test Call Service. Additional test call services and aliases can be added if required.

We recommend that you add a test_call@<yourdomain> alias to the preconfigured Test Call Service to cater for devices that automatically add a domain to their called alias.

After a call into a Test Call Service (e.g. to the "test_call" alias) is answered, the user receives some instructions and then the user's video and audio of themselves is played back from the Conferencing Node with a 2 second delay. The test call then automatically disconnects after approximately 20 seconds.

The instructions and timeouts can all be customized via themes, and different themes can be applied to different Test Call Services, if required.

As an administrator, you also have the ability to dial out to a user (alias) to initiate a test call from within Pexip Infinity.

Configuring Test Call Services and aliases

To configure Test Call Services and their associated aliases, go to Services > Test call service. The options are:

Option Description
Name The name used to refer to this Test Call Service.
Description A description of the Test Call Service.
Theme

The theme for use with this Test Call Service. For more information, see Customizing conference images and voice prompts using themes.

Default: <use Default theme> (the global default theme is used).

Advanced options
Maximum inbound call bandwidth (kbps) Enter a value in this field to limit the bandwidth of media being received by Pexip Infinity from the user dialed in to this Test Call Service. For more information see Managing and restricting call bandwidth.
Conference capabilities

Allows you to limit the media content of the conference. For more information, see Controlling media capability.

Default: Main video + presentation.

Maximum call quality

Controls the maximum call quality for participants connecting to this service:

  • Use global setting: use the global maximum call quality setting.
  • SD: each participant is limited to SD quality.
  • HD: each participant is limited to HD (720p) quality.
  • Full HD (1080p): allows any endpoint capable of Full HD to send and receive its main video at 1080p.

Default: Use global setting

See Setting and limiting call quality for more information.

Media encryption

Controls the media encryption requirements for participants connecting to this service.

  • Use global setting: use the global media encryption setting.
  • Best effort: each participant will use media encryption if their device supports it, otherwise the connection will be unencrypted.
  • Required: all participants (including RTMP participants) must use media encryption.
  • No encryption: all H.323, SIP and MS-SIP participants must use unencrypted media. (RTMP participants will use encryption if their device supports it, otherwise the connection will be unencrypted.)

Default: Use global setting

Service tag This optional field lets you assign a unique identifier to this service, which you can then use to track use of the service.
Aliases
Alias: #1
Alias

The alias that, when received by Pexip Infinity, is used to route the call to this service.

The alias entered here must match the alias as it is received by Pexip Infinity. Wildcards and regular expressions are not supported.

In most cases, the alias received by Pexip Infinity is the same as the alias that the participant used to call the service, but there are some exceptions, described in About aliases and access numbers.

You may also want to define multiple aliases for the same service to ensure that it can be accessed by devices and protocols that enforce specific alias formats — for more information, see Using multiple aliases to access the same service.

Description An optional description of the alias. This is useful if you have more than one alias for a service. Note that this description may be displayed to end users on registered Connect apps who are performing a directory search.
Add another Alias Select this option if you want the Test Call Service to be accessible by more than one alias. For more information, see Using multiple aliases to access the same service.

Customizing the Test Call Service via themes

As with other Pexip Infinity services, the images that are shown, and the audio prompts that the end-user hears, can all be fully customized via themes. You can also control the playback delay and the duration of the test call by configuring settings in the themeconfig.json theme file.

The following theme files, splash screens and settings are used during a test call:

Theme file/setting Default content Notes
conf-test_call_48kHz_mono.wav

"Let's test your video and audio. Count out loud from one to three, now."

Audio file played at the start of a video call to a Test Call Service.
conf-test_call_audio_only_48kHz_mono.wav

"Let's test your audio settings. Count out loud from one to three, now."

Audio file played at the start of an audio-only call to a Test Call Service.
conf-test_call_disconnect_48kHz_mono.wav

"If you have technical issues, check your settings or contact your administrator."

Audio file played at the end of a call to a Test Call Service.
background_test_call.jpg The background image (a black screen) used by default on the Test Call Service splash screens.
test_call_welcome splash screen

Shown at the start of a call to a Test Call Service.

Theme elements used:

  • Icon: icon_test_call_welcome.svg
  • Label: test_call_welcome_header and test_call_welcome_text
  • Background: background_test_call.jpg
test_call_in_progress splash screen

Shown during a call to a Test Call Service. Note that a large, live (with a short delay) video image of the test call participant is shown on top of this screen during a test call.

Theme elements used:

  • Label: test_call_in_progress
  • Background: background_test_call.jpg
test_call_complete splash screen

Shown briefly prior to automatically disconnecting the participant from a Test Call Service.

Theme elements used:

  • Icon: icon_test_call_complete.svg
  • Label: test_call_complete
  • Background: background_test_call.jpg
test_call_service_media_delay
(in themeconfig.json)

2

The number of seconds that media is delayed before being looped back to the caller when using a Test Call Service.

test_call_service_disconnect_timeout
(in themeconfig.json)

10

The number of seconds that a user can test their media before the disconnect message is played, when using a Test Call Service.

The following sequence describes the test call process and explains when each theme file and setting is used:

  1. When a test call is answered, the test_call_welcome splash screen is displayed and either the conf-test_call_48kHz_mono.wav or conf-test_call_audio_only_48kHz_mono.wav audio file is played, depending on whether the caller is connecting with video or just with audio-only.
  2. The test_call_in_progress splash screen is displayed (after the conf-test_call_48kHz_mono.wav audio file has finished).
  3. The caller's audio and video media is replayed back to them with a <test_call_service_media_delay> seconds delay (2 seconds by default).
  4. The media replay stops after <test_call_service_disconnect_timeout> seconds (10 seconds by default).
  5. The test_call_complete splash screen is displayed and the conf-test_call_disconnect_48kHz_mono.wav audio file is played.
  6. The call automatically disconnects after a further 5 seconds (not configurable).

Dialing out from the Test Call Service

Typically, users will dial in to the Test Call Service to check their video and audio, but as an administrator you can dial out to a user (alias) to initiate a test call from within Pexip Infinity. When the user answers the call they are taken through the test in the same way as if they had dialed the Test Call Service themself.

To dial a user into a test call:

  1. Select the Test Call Service to dial the participant from (go to Services > Test call service and select a service).
  2. At the bottom left of the screen, select Dial out to participant.
  3. Enter the Participant alias you want to dial, and the Protocol to use to make the call.
  4. Select Dial out to participant.