Documentation

  • Ziggeo's SDK raises events in real time
  • Simply prepare code to run at requested times
  • No need to monitor or institute checks for particular occurrences
  • Data parameter provided for all events
    • Includes all parameters set in embeddings
    • Videos themselves
    • Option to stream as sub-objects
  • Parameters of events depending on the particular event
  • If you need to obtain additional data from the embedding, you can use the embedding.get function, i.e.: embedding.get('video')

Access recorder embedding

var element = document.getElementById('elementID');
var embedding = ZiggeoApi.V2.Recorder.findByElement(element);

Access player embedding

var element = document.getElementById('elementID');
var embedding = ZiggeoApi.V2.Player.findByElement(element);
  1. Events that can happen on both player and recorder embedding
  2. attached

    Fires when the embedding is attached to the element, however it has not yet loaded

    ZiggeoApi.Events.on("attached", function (  ) {
    	//Your code goes here
    });
    embedding.on("attached", function () {
    	//Your code goes here
    });
  3. loaded

    Triggered when the player / recorder is loaded for the first time

    ZiggeoApi.Events.on("loaded", function (  ) {
    	//Your code goes here
    });
    embedding.on("loaded", function () {
    	//Your code goes here
    });
  4. play

    Triggered when a video is playing

    ZiggeoApi.Events.on("play", function ( data ) {
    	//Your code goes here
    });
    embedding.on("play", function () {
    	//Your code goes here
    });
  5. playing

    Fires after each play action is triggered (even if it was paused then played again, or if a seek operation is done)

    ZiggeoApi.Events.on("playing", function (  ) {
    	//Your code goes here
    });
    embedding.on("playing", function () {
    	//Your code goes here
    });
  6. pause

    Triggered when a playing video is paused

    ZiggeoApi.Events.on("pause", function ( data ) {
    	//Your code goes here
    });
    embedding.on("pause", function () {
    	//Your code goes here
    });
  7. paused

    Fires when the pause button is clicked and when the video reaches the end

    ZiggeoApi.Events.on("paused", function (  ) {
    	//Your code goes here
    });
    embedding.on("paused", function () {
    	//Your code goes here
    });
  8. ended

    Fires when the video has reached the end (right after the 'paused' event)

    ZiggeoApi.Events.on("ended", function (  ) {
    	//Your code goes here
    });
    embedding.on("ended", function () {
    	//Your code goes here
    });
  9. stop

    Triggered when a playing video is stopped

    ZiggeoApi.Events.on("stop", function ( data ) {
    	//Your code goes here
    });
    embedding.on("stop", function () {
    	//Your code goes here
    });
  10. error

    Triggered when an embedding encounters an error

    ZiggeoApi.Events.on("error", function ( error ) {
    	//Your code goes here
    });
    embedding.on("error", function ( error ) {
    	//Your code goes here
    });
  11. error_player

    Triggered when the video player encounters an error

    ZiggeoApi.Events.on("error_player", function ( data, error ) {
    	//Your code goes here
    });
    embedding.on("error_player", function ( error ) {
    	//Your code goes here
    });
  12. submitted

    Triggered when a video has been uploaded / recorded and processed

    ZiggeoApi.Events.on("submitted", function ( data ) {
    	//Your code goes here
    });
    embedding.on("submitted", function () {
    	//Your code goes here
    });
  13. manually_submitted

    Triggered when a video has been manually submitted by a user

    ZiggeoApi.Events.on("manually_submitted", function ( data ) {
    	//Your code goes here
    });
    embedding.on("manually_submitted", function () {
    	//Your code goes here
    });
  14. uploaded

    Triggered when a video has been uploaded / recorded (but not processed)

    ZiggeoApi.Events.on("uploaded", function ( data ) {
    	//Your code goes here
    });
    embedding.on("uploaded", function () {
    	//Your code goes here
    });
  15. upload_selected

    Triggered when a file has been selected for upload

    ZiggeoApi.Events.on("upload_selected", function ( file, data ) {
    	//Your code goes here
    });
    embedding.on("upload_selected", function ( file ) {
    	//Your code goes here
    });
  16. recording

    Triggered when the recording process has been started

    ZiggeoApi.Events.on("recording", function ( data ) {
    	//Your code goes here
    });
    embedding.on("recording", function () {
    	//Your code goes here
    });
  17. uploading

    Triggered when the video is uploading

    ZiggeoApi.Events.on("uploading", function ( data ) {
    	//Your code goes here
    });
    embedding.on("uploading", function () {
    	//Your code goes here
    });
  18. finished

    Triggered when the recording process has finished

    ZiggeoApi.Events.on("finished", function ( data ) {
    	//Your code goes here
    });
    embedding.on("finished", function () {
    	//Your code goes here
    });
  19. seek

    Triggered when someone goes to the time position in video playback that is different than the currently played time position

    ZiggeoApi.Events.on("seek", function ( position ) {
    	//Your code goes here
    });
    embedding.on("seek", function ( position ) {
    	//Your code goes here
    });
  20. rerecord

    Triggered when a recorded video has been discarded and is being re-recorded

    ZiggeoApi.Events.on("rerecord", function (  ) {
    	//Your code goes here
    });
    embedding.on("rerecord", function () {
    	//Your code goes here
    });
  21. discarded

    Triggered when a recorded video has been discarded and is being re-recorded

    ZiggeoApi.Events.on("discarded", function ( data ) {
    	//Your code goes here
    });
    embedding.on("discarded", function () {
    	//Your code goes here
    });
  22. error_recorder

    Triggered when the video recorder encounters an error

    ZiggeoApi.Events.on("error_recorder", function ( data, error ) {
    	//Your code goes here
    });
    embedding.on("error_recorder", function ( error ) {
    	//Your code goes here
    });
  23. countdown

    Triggered while the video recorder counts down

    ZiggeoApi.Events.on("countdown", function ( time, data ) {
    	//Your code goes here
    });
    embedding.on("countdown", function ( time ) {
    	//Your code goes here
    });
  24. elapsed

    Triggered while the video recorder records the video

    ZiggeoApi.Events.on("elapsed", function ( time, data ) {
    	//Your code goes here
    });
    embedding.on("elapsed", function ( time ) {
    	//Your code goes here
    });
  25. recording_progress

    Triggered while the video recorder records the video

    ZiggeoApi.Events.on("recording_progress", function ( time ) {
    	//Your code goes here
    });
    embedding.on("recording_progress", function ( time ) {
    	//Your code goes here
    });
  26. upload_progress

    Upload progress events

    ZiggeoApi.Events.on("upload_progress", function ( uploaded, total, data ) {
    	//Your code goes here
    });
    embedding.on("upload_progress", function ( uploaded, total ) {
    	//Your code goes here
    });
  27. processing_progress

    Processing progress events

    ZiggeoApi.Events.on("processing_progress", function ( percentage, data ) {
    	//Your code goes here
    });
    embedding.on("processing_progress", function ( percentage ) {
    	//Your code goes here
    });
  28. processing

    Processing progress events

    ZiggeoApi.Events.on("processing", function ( percentage ) {
    	//Your code goes here
    });
    embedding.on("processing", function ( percentage ) {
    	//Your code goes here
    });
  29. processed

    Finished processing event

    ZiggeoApi.Events.on("processed", function (  ) {
    	//Your code goes here
    });
    embedding.on("processed", function () {
    	//Your code goes here
    });
  30. ready_to_record

    Triggered when a video recorder is ready to record a video

    ZiggeoApi.Events.on("ready_to_record", function ( data ) {
    	//Your code goes here
    });
    embedding.on("ready_to_record", function () {
    	//Your code goes here
    });
  31. ready_to_play

    Triggered when a video play is ready to play a video

    ZiggeoApi.Events.on("ready_to_play", function ( data ) {
    	//Your code goes here
    });
    embedding.on("ready_to_play", function () {
    	//Your code goes here
    });
  32. access_forbidden

    Triggered when the user does not grant access to the camera

    ZiggeoApi.Events.on("access_forbidden", function ( data, error ) {
    	//Your code goes here
    });
    embedding.on("access_forbidden", function ( error ) {
    	//Your code goes here
    });
  33. access_granted

    Triggered when the user grants access to the camera

    ZiggeoApi.Events.on("access_granted", function ( data ) {
    	//Your code goes here
    });
    embedding.on("access_granted", function () {
    	//Your code goes here
    });
  34. access_revoked

    Triggered when the user revokes access to the camera while recording

    ZiggeoApi.Events.on("access_revoked", function ( data ) {
    	//Your code goes here
    });
    embedding.on("access_revoked", function () {
    	//Your code goes here
    });
  35. flash_hibernate

    Triggered when the browser puts Flash into hibernation mode

    ZiggeoApi.Events.on("flash_hibernate", function ( data ) {
    	//Your code goes here
    });
    embedding.on("flash_hibernate", function () {
    	//Your code goes here
    });
  36. camera_unresponsive

    Triggered when the camera has become unresponsive.

    ZiggeoApi.Events.on("camera_unresponsive", function ( data ) {
    	//Your code goes here
    });
    embedding.on("camera_unresponsive", function () {
    	//Your code goes here
    });
  37. camera_nosignal

    Triggered when the camera has no signal.

    ZiggeoApi.Events.on("camera_nosignal", function ( data ) {
    	//Your code goes here
    });
    embedding.on("camera_nosignal", function () {
    	//Your code goes here
    });
  38. verified

    Triggered after video was uploaded and verified that it can be processed.

    ZiggeoApi.Events.on("verified", function ( data ) {
    	//Your code goes here
    });
    embedding.on("verified", function () {
    	//Your code goes here
    });
  39. no_camera

    Triggered when the camera has no signal.

    ZiggeoApi.Events.on("no_camera", function ( data ) {
    	//Your code goes here
    });
    embedding.on("no_camera", function () {
    	//Your code goes here
    });
  40. no_microphone

    Triggered when the microphone has no signal.

    ZiggeoApi.Events.on("no_microphone", function ( data ) {
    	//Your code goes here
    });
    embedding.on("no_microphone", function () {
    	//Your code goes here
    });