Skip to main content

PopupConfig

PopupConfig lets you take actions on the frontend elements present in the SX RecorderSDK UI. Its main purpose is to allow customization of the User Experience while the user is interacting with the UI of SX RecorderSDK, prior to starting a recording.

Some use cases include -

  • Hiding user data/email ID on the page as the user clicks on the recording button
  • Showing the user a recording blip somewhere on an icon on the page
  • Linking your video library from the Popup header
const PopupConfig = {
   profilePictureLink: "Your profile picture Link",
   setInitialCamSize: "1",
    header: {
        logo: {
            onClick: (event) => window.open("https://yourdomain.com")
        },
        account: {
            onClick: (event) => window.open("https://yourdomain.com/user-profile")
        }
    },
    recorder: {
        recordingType: {
            onChange: (mode) => {},
         useRecordingTypes: [1, 2, 4]
        },
        toggles: {
            faceOnly: { 
                onToggle: (value) => {}
            },
            audio: {
                onToggle: (value) => {}
            },
            advancedOptions: {
                onToggle: (value) => {}
            }
        },
        dropdowns: {
            audioSource: {
                onChange: (source) => {}
            },
            webcamSource: {
                onChange: (source) => {}
            }
        },
        recordButton: {
            onClick: (event) => {}
        }
    }
};

Properties​

profilePictureLink

Replace your webcam feed with an image in the recording.

Type: string

setInitialCamSize

Set inital cam size. ("1", "2","3").

Type: string

Event Listeners​

mode

Recording mode that the user selects. It can return the following number values:

#Mode
1Screen + Camera
2Screen
3Camera Only

Type: number

value

Current state of the toggle switch

Type: bool

source

Source represents the user's selected audio/video sources.

Type: object

url

Link to the logo you want on the header. Preferred 125 px X 22 px dimension image for best UX experience.

Larger/smaller dimension images might appear squeezed/stretched.

Type: string