Config File Configuration (Standalone)
The following are the fields that are understood by the config file used on the standalone version of Assist.
These must be saved to a text file called AcquireAssist.ini and saved NEXT TO the AcquireAssist.exe application. Any graphics specified here must be windows BMP files.
Anything with a recommended default value does not need to be present in the file for the plugin to work.
|
Name |
Description |
Recommended/ Default Value |
Limits |
|
ip |
The IP address of the server |
|
IP Address |
|
port |
The TCP port to communicate with the server on |
5000 |
0..65535 |
|
ServerPortUDP |
The UDP port to communicate with the server on |
7000 |
1024..65535 |
|
KioskPortUDP |
The start of the UDP port range that the kiosk can use |
7005 |
1024..65535 |
|
KioskMaxPortUDP |
The number of UDP ports to search for when finding an available port |
10000 |
65535-KioskPortUDP |
|
KioskName |
Name of the unit (optional if using the Windows communication) |
Kiosk |
Text |
|
Username |
The username to connect to the server with (optional if using the Windows communication) |
|
Text |
|
Password |
The password to connect to the server with (optional if using the Windows communication) |
|
Text |
|
VideoX |
The X position where to display the camera from the operator in pixels |
0 |
Screen Width |
|
VideoY |
The Y position where to display the camera from the operator in pixels |
0 |
Screen Height |
|
VideoW |
The Width of the window to display the camera from the operator in pixels, if 0 then the actual video size is used |
0 |
Screen Width |
|
VideoH |
The Height of the window to display the camera from the operator in pixels, if 0 then the actual video size is used |
0 |
Screen Height |
|
EnableDragging |
If the camera image from the operator can be dragged around the screen |
true |
false/true |
|
MuteX |
The X position where to display the mute icon in pixels |
Screen Width-MuteW |
Screen Width |
|
MuteY |
The Y position where to display the icon in pixels |
0 |
Screen Height |
|
MuteW |
The Width of the window to display the mute icon in pixels, if 0 then the actual icon image size is used |
0 |
Screen Width |
|
MuteH |
The Height of the window to display the mute icon in pixels, if 0 then the actual icon size is used |
0 |
Screen Height |
|
EnableDraggingMute |
If the mute icon can be dragged around the screen |
true |
false/true |
|
ScreenSampleDivisorWidth |
When streaming the desktop, we shrink the screen width by this number to reduce bandwidth |
2 |
1+ |
|
ScreenSampleDivisorHeight |
When streaming the desktop, we shrink the screen height by this number to reduce bandwidth |
2 |
1+ |
|
ScreenKeyFrameInterval |
Maximum number of frames to be transmitted before a keyframe is sent. The higher the value the better the bitrate is maintained, but on average the longer time before the picture will appear on first connect |
20 |
1+ |
|
ScreenBitRate |
Average bitrate used to encode the screen image in kbps |
128 |
10+ |
|
ScreenDropThreshold |
To maintain bandwidth this is the % of buffer available/second before frames get skipped |
75 |
1..100 |
|
ScreenTargetFPS |
Screen capture Frames Per Second |
10 |
1-60 |
|
CameraKeyFrameInterval |
Maximum number of frames to be transmitted before a keyframe is sent. The higher the value the better the bitrate is maintained, but on average the longer time before the picture will appear on first connect |
20 |
1+ |
|
CameraRotate |
Rotates the image from the camera. Can be only 0, -90, 90 or 180 degrees |
0 |
0, -90, 90, 180 |
|
CameraFlipH |
Flip the camera image horizontally |
false |
false/true |
|
CameraFlipV |
Flip the camera image vertically |
false |
false/true |
|
CameraBitRate |
Average bitrate used to encode the camera image in kbps |
45 |
10+ |
|
CameraDropThreshold |
To maintain bandwidth this is the % of buffer available/second before frames get skipped |
75 |
1..100 |
|
CameraIndex |
The camera number to use |
0 |
0+ |
|
CameraTargetFPS |
Maximum Frames Per Second from the camera |
10 |
1-60 |
|
CameraIdealWidth |
Ideal camera capture resolution width (before rotation) |
320 |
40-4096 |
|
CameraIdealHeight |
Ideal camera capture resolution height (before rotation) |
240 |
40-4096 |
|
CameraX |
The X position where to display the local camera in pixels |
0 |
Screen Width |
|
CameraY |
The Y position where to display the local camera in pixels |
0 |
Screen Height |
|
CameraW |
The Width of the window to display the local camera in pixels, if 0 then the actual video size is used |
0 |
Screen Width |
|
CameraH |
The Height of the window to display the local camera in pixels, if 0 then the actual video size is used |
0 |
Screen Height |
|
CameraShow |
If the local camera is being streamed to the operator, this will cause it to also be displayed to the user at the position and size shown above |
false |
false/true |
|
CameraDragging |
If the window used to show the local camera can be dragged around the screen |
true |
false/true |
|
AudioSampleFrequency |
Sampling frequency for audio to be captured at |
22050 |
11025, 22050, 44100 |
|
AudioBitrate |
Average bitrate used to encode the audio stream in kbps |
13 |
1-400 |
|
AudioUseEchoCancellation |
Use the Microsoft echo cancellation service |
false |
false/true |
|
AudioPeriodMS |
How much audio data to capture before encoding it. The smaller the value the lower the latency but may introduce gaps in playback. Value is in milliseconds |
150 |
50-1000 |
|
RecordCalls |
If calls should be recorded to disk. Recorded calls are written to <ProgramData>\Acquire\Assist\Recordings |
false |
false/true |
|
ShowCursor |
Enables the mouse cursor visibility |
true |
false/true |
|
The following are optional If they are not present they will not appear |
|||
|
Ready |
Full path to the media folder to the graphic/video to display while idle (no active call). If blank this will not be shown |
|
Filename |
|
Dialing |
Full path to the media folder to the graphic/video to display while dialing. If blank this will not be shown |
|
Filename |
|
Unavailable |
Full path to the media folder to the graphic/video to display when a connection to the server could not be made. If blank this will not be shown |
|
Filename |
|
TempUnavailable |
Full path to the media folder to the graphic/video to display if no operators are available. If blank this will not be shown |
|
Filename |
|
Connecting |
Full path to the media folder to the graphic/video to display while the connection to the operator is established. If blank this will not be shown |
|
Filename |
|
InCall |
Full path to the media folder to the graphic/video to display while in a call. If blank this will not be shown |
|
Filename |
|
Answer |
Full path to a graphic to show if an incoming call occurs on the kiosk. Will only be shown if both this and Reject are valid, else the call will auto-answer. |
|
Filename |
|
Reject |
Full path to a graphic to show if an incoming call occurs on the kiosk to reject the call. Will only be shown if both this and Answer are valid, else the call will auto-answer. |
|
Filename |
|
RejectX |
X position to place the reject button |
0 |
ScreenWidth |
|
RejectY |
Y position to place the reject button |
0 |
ScreenHeight |
|
RejectW |
Width of the button or 0 for automatic |
0 |
ScreenWidth |
|
RejectH |
Height of the button or 0 for automatic |
0 |
ScreenHeight |
|
RejectDrag |
True if the reject button can be moved |
false |
false/true |
|
ButtonX |
Where to place any/all of the above graphics |
0 |
Screen Width |
|
ButtonY |
Where to place any/all of the above graphics |
0 |
Screen Height |
|
ButtonW |
The size to use for the graphics. If left blank then the size is taken from the graphic |
0 |
Screen Width |
|
ButtonH |
The size to use for the graphics. If left blank then the size is taken from the graphic |
0 |
Screen Height |
|
ButtonDrag |
If enabled, the user can drag the button around the screen |
false |
false/true |