Javascript Events

There are a number of PostMessages that are fired throughout the non-panel video process (https://developer.mozilla.org/en-US/docs/Web/API/Window.postMessage) These will work in all modern browsers.

Each event will include the following data:

Event Data

var returnData = {event:"EVENT_NAME"};
parent.postMessage(returnData, '*');

Events can be listened to using the following code:

Event listening

<script>
        //this code is used to listen for events from the iframe
        var eventMethod = window.addEventListener ? "addEventListener" : "attachEvent";
        var eventer = window[eventMethod];
        var messageEvent = eventMethod == "attachEvent" ? "onmessage" : "message";

        // Listen to message from child window (iframe)

        var onlyStrings = false;
        try {
            window.postMessage({toString: function () {
                onlyStrings = true;
            }}, "*");
        } catch (e) {
        }

        eventer(messageEvent, function (e) {
            if (e.data) {
                var eventData = {};
                if (typeof e.data === 'string' && onlyStrings) {
                    eventData = JSON.parse(e.data);
                }
                else {
                    eventData = e.data
                }
                if ("EVENT_NAME" == eventData.event) {
                    //add your code for the specified event
                }
            }
        }, false);
</script>

Default

The following PostMessages will be sent:

Event	Description
`initialized`	Widget has been initialized and is ready for use.
`serverDisconnected`	Connection to our streaming server was lost.
`detectingCamera`	Detecting active web camera.
`hasCamera`	Web camera has been found.
`noCamera`	Error state when no camera is found.
`hasMic`	Microphone has been found.
`noMic`	Unable to find a microphone.
`cameraDenied`	Camera access has been denied by user.
`readyToRecord`	Camera and microphone have been found and are configured correctly.
`recordingStarted`	User has started recording.
`recordingStopped`	User has stopped recording.
`recordingCancelled`	User has cancelled the recording.
`playbackStarted`	User has started the playback of their recording.
`playbackPaused`	User has paused the playback of their recording.
`publishing`	The recording is being uploaded to Voxpopme servers.
`published`	The recording has been successfully uploaded and submitted.
`publishFailed`	Video uploading has failed.
`processed`	The video has finished processing and uploading.
`response_complete`	Recording has been uploaded and saved successfully to the Voxpopme platform.
`continue_clicked`	User has clicked the continue button.
`quota_full`	No more responses can be recorded on this project because the target total responses count has been reached, or the project has expired.
`inactive`	Project is not currently active, i.e in draft, pending, scheduled.

Articles in this section

Default

Comments

Articles in this section

Default

Related articles