English Español Français
1-888-257-2278 Go to YuJa
  1. YuJa Help Center
  2. Enterprise Video Platform
  3. Recording and Live Streaming
  4. Software Capture for Windows Application
  5. Manage Your Capture Application

Auto-Registering and Configuring the Software Capture Application for PC

Avatar
YuJa Product Support
  • Updated

System admins can set and override configurations and settings without manually editing the Software Capture application. By deploying a configuration file to auto-register devices, admins can easily set standard customized settings for all applications. 

Auto-Registering and Configuring the Software Capture Application

Before following the steps below, please ensure you have installed the latest version of the Software Capture application for PC. 

  1. Log in to the Video Platform as an admin and access the Admin Panel from the Main Menu icon drop-down list.
  2. Select the Devices tab from the left-hand navigation menu.
    The Video Platform Devices page. The main menu drop-down list is shown with Admin Panel highlighted. The left-hand navigation menu within the admin panel has the Devices tab highlighted.
  3. Click the Auto Registration button.
    The devices page within the admin panel with the Auto Registeration button highlighted.
  4. Within the pop-up window, download the configuration template and generate the Institution Code.
    The software capture auto-registration Config File window featuring three steps. Download the config file, access the organization code, and insert the config file to the config installation folder.
  5. Open the configuration file with your preferred text editor, such as Notepad. Ensure the configuration file is named "yss-reg.config" and the content of this file should be as shown below.

    {
      "canAutoRegistration": true,
      "institutionCode": "Get Code from Admin Panel's Device Tab",
      "Configuration": {
            "NeverLogOut": false,
            "MinutesInactiveBeforeLogout": 300,
            "ShowRecordingToolbar": "Enter one of these values: 'Always', 'Hide', 'WhileRecording'",
            "ShowAudioInRecordingToolbar": true,
            "MinimizeOnRecord": true,
            "ShowHotkeyReminderOnMinimize": false,
            "ShowCountdown321": true,
            "ShowPauseNotification": true,
            "AutomaticallyShowUploadProgress": true,
            "DefaultMediaCaptureEngine": "Enter one of these values: 'MF', 'DShow', 'Legacy'",
            "UseLanguageOverride": false,
            "LanguageOverride": "If 'UseLanguageOverride' is set to true then enter one of these values:
            'en', 'fr', 'es'"
         },
    "Webcam": {
            "Quality": "Enter one of these values: 'Maximum', 'ExtraHigh', 'High', 'Medium', 'Low',         
            'ExtraLow'"
         },
    "ScreenCapture": {
            "FrameRate": 5,
            "Quality": "Enter one of these values: 'ExtraHigh', 'High', 'Medium', 'Low', 'ExtraLow'",
            "OutputFileSize": "Enter one of these values: 'VeryLarge', 'Large', 'Medium', 'Small', 'VerySmall'",
            "LeftDisplayResolution": "1280x720",
            "RightDisplayResolution": "1280x720",
            "DefaultScreenLiveMaxBitrate": 1000
         },
    "SystemSettings": {
            "DefaultCacheDirectory": "C:\\Program Files\\YuJa\\YuJa Software Capture\\cache\\",
            "DefaultUploadDirectory": "C:\\Program Files\\YuJa\\YuJa Software Capture\\videos\\",
            "DaysToKeepUploadedVideo": 7,
            "ShowAutomaticUpdateNotification": true,
            "UseAlternateRenderingMode": false,
            "ShowLowDiskSpaceWarning": true,
            "DiskSpaceWarningThreshold": 2048
         }
    }

    Note: Any other file name or content format will not work.

  6. Copy the institution code from the same pop-up box in step 4 and replace the Get Code from Admin Panel's Device Tab with the institution code. See the example below.

    "canAutoRegistration": true,
    "institutionCode": "ed67287b739271e8a",

  7. Next, adjust the desired settings. See the example below. To learn what each setting does, please view the next section of this guide.

    {
      "canAutoRegistration": true,
      "institutionCode": "ed67287b739271e8a",
      "Configuration": {
            "NeverLogOut": false,
            "MinutesInactiveBeforeLogout": 240,
            "ShowRecordingToolbar": "WhileRecording",
            "ShowAudioInRecordingToolbar": true,
            "MinimizeOnRecord": true,
            "ShowHotkeyReminderOnMinimize": true,
            "ShowCountdown321": true,
            "ShowPauseNotification": true,
            "AutomaticallyShowUploadProgress": true,
            "DefaultMediaCaptureEngine": "MF",
            "UseLanguageOverride": true,
            "LanguageOverride": "en"
         },
    "Webcam": {
            "Quality": "Maximum"
         },
    "ScreenCapture": {
            "FrameRate": 20,
            "Quality": "ExtraHigh",
            "OutputFileSize": "Large",
            "LeftDisplayResolution": "1280x720",
            "RightDisplayResolution": "1280x720",
            "DefaultScreenLiveMaxBitrate": 1000
         },
    "SystemSettings": {
            "DefaultCacheDirectory": "C:\\Program Files\\YuJa\\YuJa Software Capture\\cache\\",
            "DefaultUploadDirectory": "C:\\Program Files\\YuJa\\YuJa Software Capture\\videos\\",
            "DaysToKeepUploadedVideo": 7,
            "ShowAutomaticUpdateNotification": true,
            "UseAlternateRenderingMode": false,
            "ShowLowDiskSpaceWarning": true,
            "DiskSpaceWarningThreshold": 2048
         }
    }

  8. Once you have made your adjustments, save the configuration file and copy it to <Software Installation Folder>/config folder.

    Default Location: C:\Program Files\YuJa\YuJa Software Capture\config.

  9. Run the Software Capture application (Ensure yuja-software-capture-service is running. This can be checked within the Background Processes of Task Manager. Restart the Software Capture application if the service is not running).
  10. Once the auto-configuration file is finished, the name will update to yss-reg.finished, and a new file called ysc-override-settings.config will be added automatically. If you would like to make any changes in the future, open the ysc-override-settings.config file with your preferred text editor. 
  11. Go back to the Devices menu, and you will see the auto-generated device with the same name as the user's computer.

Configuration Settings for the Software Capture Application

The table below lists all the adjustable settings for the configuration file.

Setting Values
canAutoRegistration

true: The Software Capture application will register to the Video Platform if the insitutionCode is provided.

false: The Software Capture application will not be registered to the Video Platform.
institutionCode A code provided by the Video Platform allowing the application to be registered. See step 4 in the above section of this guide.  
NeverLogOut

true: The user will remain logged on unless manually logged out.  

false: Will log the user out of the Software Capture application after a specified number of minutes of no activity. 
MinutesInactiveBeforeLogout Specify the number of minutes you'd like the Software Capture application to log a user out after no activity. The number specified will only be used if NeverLogOut is set to false.   
ShowRecordingToolbar

Always: The toolbar will be visible even when a recording is not in progress.

Hide: The toolbar will be hidden from the user at all times.

WhileRecording: The Toolbar will only be visible while recording.
ShowAudioInRecordingToolbar

true: Audio will be available to view in the Recording Toolbar.

false: Audio will not be available to view in the Recording Toolbar
MinimizeOnRecord

true: The Software Capture application will automatically minimize once the recording begins.

false: The Software Capture application will remain open once a recording begins. 
ShowHotKeyReminderOnMinimize

true: A notification will appear once a recording has been minimized, reminding the user how to start, pause, and finish the recording with their hotkeys.

false: A Hotkey reminder notification will not appear when the recording is minimized.
ShowCountdown321

true: When the user clicks the Start Recording button, a 3-2-1 timer will appear before the recording begins.

false: Disables the 3-2-1 timer.
ShowPauseNotification 

true: A pause notification will appear if the recording has been paused.

false: If the recording has been paused, no notification will appear indicating the recording is paused.
AutomaticallyShowUploadProgress

true: A progress bar will automatically appear when a recording is uploading to the Video Platform.

false: A progress bar will not appear when a recording is uploading to the Video Platform.
DefaultMediaCaptureEngine

MF: The Media Foundation engine is recommended for all new devices.

DShow: The Direct Show engine is recommended for devices incompatible with the Media Foundation engine.

Legacy: The Legacy Engine will automatically be used for live streams and IP cameras. 

 
UseLanguageOverride 

true: Change the default Software Capture language to match LanguageOverride.

false: Keeps the default language for the Software Capture application.
LanguageOverride 

This setting will only apply if UseLanguageOverride is set to true.

en: Change the default language to English.

fr: Change the default language to French.

es: Change the default language to Spanish.
Webcam -> Quality

Set whether the webcam quality should be Maximum, ExtraHigh, High, Medium, Low, or ExtraLow. Selecting a higher quality will result in a larger file size. 
FrameRate

Enter a number from 1 to the maximum frame rate of your device to determine the frame rate of the screen capture recording. 
ScreenCapture -> Quality 

Set whether the screen capture quality should to ExtraHigh, High, Medium, Low, or ExtraLow. Selecting a higher quality will result in a larger upload size. 
OutputFileSize

Set whether the output file size should be VeryLarge, Large, Medium, Small, or VerySmall. Selecting a smaller file size will reduce the overall quality of the recording. 
LeftDisplayResolution 

Enter any resolution value (e.g., 1920x1080) for the left monitor.
RightDisplayResolution

Enter any resolution value (e.g., 1920x1080) for the right monitor.
DefaultScreenLiveMaxBitrate

This setting only applies to live stream sessions. Select a bitrate value from 500 to 3000kbps. A higher bitrate produces higher-quality videos but requires an internet connection with high upload bandwidth. A bitrate higher than the bandwidth can cause the video not to streamed properly. A bitrate between 1000 to 2000kbps is recommended.
DefaultCacheDirectory

The default location of the cache directory.
DefaultUploadDirectory 

The default location of all uploaded recordings.
DaysToKeepUploadedVideo

Enter the number of days to keep a recording in the default upload directory before it's deleted.
ShowAutomaticUpdateNotification

true: A notification will appear whenever there is an update available.

false: There will be no notification displayed for any updates.
UseAlternateRenerdingMode

true: If the video feed and screen capture appear blank in the Confidence Monitor, alternate rendering mode can help view the preview.

false: The alternate rendering mode will be disabled. 
ShowLowDiskSpaceWarning 

true: A low-disk-space warning will appear if the system is running out of space.

false: Disable warning messages for insufficient disk space.
DiskSpaceWarningThreshold

This setting will only be applied if ShowLowDiskSpaceWarning is set to true. Select a threshold number from 200 to 2048 MB to determine when a low-disk-space warning will appear. 
Was this article helpful?
0 out of 0 found this helpful
Return to top

Related articles