Proview provides a real-time stream of events captured from the embedded JavaScript application using the events API. You can listen to the event in the browser environment in our global object ProctorClient3. The event listener can be used to listen to events on ProctorClient3 object in the following way:
ProctorClient3.on('log:event:all', function(e){
console.log(e); //your event handling logic can be defined here.
});
Each event from the event stream is available on different channels. A common stream is triggered for all events in the channel log:event: all. There are additional channels for all the event levels ('info','error','warning','debug') in the channels log:event:info , log:event:error , log:event:warning , log:event:debug respectively can be used like this.
ProctorClient3.on('log:event:info', function(e){
});
...
ProctorClient3.on('log:event:error', function(e){
});
ProctorClient3.on('log:event:debug', function(e){
});
...
ProctorClient3.on('log:event:warning', function(e){
});
For every event type available, there are independent channels available separately as log:event:type: <event_type_id> where <event_type_id> is the type of the event. The full list of event types supported is as follows:
id | is_debug | is_deleted | is_public | is_warning | name |
1 | false | false | true | false | Unknown |
2 | false | false | true | false | Session Created |
3 | false | false | true | false | Session Joined |
4 | false | false | true | true | Window Focus-In |
5 | false | false | true | true | Window Focus-Out |
6 | false | false | true | true | User Idle |
7 | false | false | true | false | User Active |
8 | false | false | true | false | Session Closed |
9 | true | false | false | false | Socket connection success |
10 | true | false | false | false | Socket disconnected |
11 | false | false | true | false | Screen-capture Started |
12 | false | false | true | false | Screen-capture Stopped |
13 | false | false | true | false | Recording Started |
14 | false | false | true | false | Recording Stopped |
15 | false | false | true | false | Face Detected |
16 | false | false | true | false | Face Not Detected |
17 | true | false | true | false | Notification Permission Granted |
18 | false | false | true | false | Notification Permission Denied |
19 | false | false | true | false | Screen-capture Installed |
20 | false | false | true | true | Screen-capture Install Failed |
21 | false | false | true | true | Screen-capture Screenshot |
22 | false | false | true | false | Camera Screenshot |
23 | false | false | true | false | Screen-capture Video |
24 | false | false | true | false | Camera Video |
25 | false | false | false | false | Face Detected Location |
26 | false | false | true | false | Camera Test Passed |
27 | false | false | true | false | Camera Test Failed |
28 | false | false | true | false | Microphone Test Passed |
29 | false | false | true | false | Microphone Test Failed |
30 | false | false | true | false | Network Test Passed |
31 | false | false | true | false | Network Test Failed |
32 | false | false | true | false | Id Submitted |
33 | true | false | false | false | Id Photo |
34 | false | false | true | false | Audio Test Passed |
35 | false | false | true | false | Audio Test Failed |
36 | false | false | true | false | Network Change |
37 | false | false | true | false | OS Change |
38 | false | false | true | false | Browser Change |
39 | false | false | true | false | Camera Audio |
40 | false | false | true | false | Speaker Recognized |
41 | false | false | true | false | Speaker Not Recognized |
42 | false | false | true | false | Face Recognized |
43 | false | false | true | true | Face Not Recognized |
44 | false | false | true | false | Face: Id - Session Matched |
45 | false | false | true | true | Face: Id - Session Not Matched |
46 | false | false | true | false | Face: Database Session Matched |
47 | false | false | true | false | Face: Database Session Not Matched |
48 | false | false | true | false | Emotion Change Detected |
49 | false | false | true | false | Object Detected |
50 | false | false | true | false | Voice Activity Started |
51 | false | false | true | false | Voice Activity Stopped |
52 | false | false | true | false | Illumination Level |
53 | false | false | true | false | Location Permission Granted |
54 | false | false | true | true | Location Permission Denied |
55 | false | false | true | false | Screen-capture Required |
56 | false | false | true | false | Screen-capture Installed |
57 | false | false | true | false | Browser Not Supported |
58 | false | false | true | false | Browser Supported |
59 | false | false | true | true | Camera Not Detected |
60 | false | false | true | false | Camera Detected |
61 | false | false | true | false | Hardware Test Skipped |
62 | false | false | true | false | Forced |
63 | false | false | true | false | Detected |
64 | false | false | true | true | Not Detected |
65 | false | false | true | false | Network Connected |
66 | false | false | true | false | Camera Permission Granted |
67 | false | false | true | true | Camera Permission Denied |
68 | false | false | true | false | Microphone Permission Granted |
69 | false | false | true | true | Microphone Permission Denied |
70 | false | false | true | false | Hardware Test Passed |
71 | false | false | true | false | Face Detected |
72 | false | false | true | true | Face Not Detected |
73 | false | false | true | false | Face Detection Retried |
74 | false | false | true | false | Audio Test Passed |
75 | false | false | true | true | Audio Test Failed |
76 | false | false | true | true | Audio Test Retried |
77 | false | false | true | false | Recording Started |
78 | false | false | true | false | Recording Stopped |
79 | false | false | true | true | Network Lost |
80 | false | false | true | true | Network Reconnected |
81 | false | false | true | true | Multiple Face Detected |
82 | false | false | true | true | Text Copied |
83 | false | false | true | true | Contextmenu Clicked |
84 | false | false | true | true | Context Switched |
85 | false | false | true | true | Print Screen Clicked |
86 | false | true | true | false | Print Screen Clicked |
87 | false | false | false | true | Custom Event |
88 | true | false | false | false | Android: Screenshot |
89 | false | false | false | false | Android: Pause |
90 | true | false | true | false | Android: Resume |
91 | true | false | true | true | Android: Incoming Call |
92 | true | false | true | false | Android: Battery Low |
93 | true | false | false | false | Android: Battery Okay |
94 | true | false | true | false | Android: Proview Stop |
95 | true | false | true | false | Android: Proview Start |
96 | true | false | false | true | Android: Proview Start Fail |
97 | true | false | false | false | Android: Raw Video |
98 | true | false | true | false | Android: Network Disconnect |
99 | true | false | true | false | Android: Network Reconnect |
100 | false | false | false | false | iOS: Network Reconnect |
101 | false | false | false | false | iOS: Network Disconnect |
102 | true | false | false | false | iOS: Raw Video |
103 | false | false | false | false | iOS: Proview Start Fail |
104 | false | false | false | false | iOS: Proview Start |
105 | false | false | false | false | iOS: Proview Stop |
106 | false | false | false | false | iOS: Battery Okay |
107 | false | false | false | false | iOS: Battery Low |
108 | false | false | false | false | iOS: Incoming Call |
109 | false | false | false | false | iOS: Resume |
110 | false | false | false | false | iOS: Pause |
111 | false | false | false | false | iOS: Screenshot |
112 | true | false | false | false | WebRTC Video File |
113 | false | false | true | false | Session Completed |
114 | false | false | false | false | Photo Enrollment |
115 | false | false | false | false | Voice Enrollment 1 |
116 | false | false | false | false | Voice Enrollment 2 |
117 | false | false | false | false | Voice Enrollment 3 |
118 | false | false | false | false | Photo Id Enrollment |
119 | true | false | false | false | Photo Fingerprint Check Request |
120 | false | false | true | true | Photo Fingerprint Check Success |
121 | false | false | false | true | Photo Fingerprint Check Failed |
122 | true | false | false | false | Voice Fingerprint Check Request |
123 | false | false | true | true | Voice Fingerprint Check Success |
124 | false | false | false | true | Voice Fingerprint Check Failed |
125 | true | false | false | false | Face Verification Check Request |
126 | false | false | true | true | Face Verification Check Success |
127 | false | false | false | true | Face Verification Check Failed |
128 | false | false | true | true | Pasting text detected |
129 | false | false | true | true | Voice detected |
130 | false | false | true | true | Camera switched |
131 | false | false | true | true | Microphone switched |
132 | false | false | true | true | Microphone not detected |
133 | false | false | true | true | Test Environment Check |
134 | false | false | true | true | Test Environment Camera Video |
136 | false | false | true | true | Proctor Rating Override |
137 | false | false | true | true | Custom Event |
138 | false | false | true | true | Precheck Approved |
139 | false | false | true | true | Precheck Rejected |
140 | false | false | true | true | Precheck Submitted |
141 | false | false | true | true | Precheck Pending |
142 | false | false | true | true | Session Playback Url |
143 | false | false | true | true | Live Proctor Screenshot |
144 | false | false | true | true | Session Terminated |
145 | false | false | true | true | Photo ID capture |
146 | false | false | true | true | Face capture |
147 | false | false | true | true | Screen Capture |
148 | false | false | true | true | Screen Capture Disabled |
149 | false | false | true | true | Screen Capture Enabled |
150 | false | false | true | true | Screen Capture Denied |
151 | false | false | false | false | Cron Job Session Completed |
152 | false | false | true | true | Partial Screen Sharing Permitted |
153 | false | false | true | true | Full Screen Sharing Permitted |
154 | false | false | true | true | Face capture Success |
155 | false | false | true | true | Face capture Failure |
156 | false | false | true | true | ID card capture success |
157 | false | false | true | true | ID card capture failure |
158 | false | false | true | true | Socket connection failure |
159 | false | false | true | true | Audio device detected |
160 | false | false | true | true | Audio device not detected |
161 | false | false | true | true | Environment test capture success |
162 | false | false | true | true | Environment test capture failure |
163 | false | false | true | true | Photo ID card Not Available |
164 | false | false | true | true | Gazing away |
165 | false | false | true | true | Eye detected |
166 | false | false | true | true | Eye not detected |
167 | false | false | true | false | Src Photo Id Card Not Available |
168 | false | false | true | false | Src Face Not Available |
The payload of each event trigger will contain a single argument which is a plain JavaScript hash/object with the attributes name, level, event_type_id, session_id, and timestamp ( timestamps on browser events rely on the user system’s time and therefore may not be accurate. For an accurate time, use the REST API service).
The payload of each event trigger will contain a single argument which is a plain JavaScript hash/object with the attributes name, level, event_type_id, session_id, timestamp (timestamps on browser events rely on the user system’s time and therefore may not be accurate, for accurate time, use the REST API service).