Documentation

These events apply no matter where recording or playback occurs.

  • 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')
  1. attached

    Fires when the embedding is attached to the DOM element

    Example:
    application.embed_event.on("attached", function () {
    	//Your code goes here
    });
  2. loaded

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

    Example:
    application.embed_event.on("loaded", function () {
    	//Your code goes here
    });
  3. playing

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

    Example:
    application.embed_event.on("playing", function () {
    	//Your code goes here
    });
  4. paused

    Fires when the pause button is clicked

    Example:
    application.embed_event.on("paused", function () {
    	//Your code goes here
    });
  5. ended

    Fires when a video has ended

    Example:
    application.embed_event.on("ended", function () {
    	//Your code goes here
    });
  6. error

    Triggered when an embedding encounters an error

    Example:
    application.embed_event.on("error", function ( error ) {
    	//Your code goes here
    });
  7. manually_submitted

    Triggered when a video has been manually submitted

    Example:
    application.embed_event.on("manually_submitted", function () {
    	//Your code goes here
    });
  8. uploaded

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

    Example:
    application.embed_event.on("uploaded", function () {
    	//Your code goes here
    });
  9. upload_selected

    Triggered when a file has been selected for upload

    Example:
    application.embed_event.on("upload_selected", function ( file ) {
    	//Your code goes here
    });
  10. recording

    Triggered when a recording process has started

    Example:
    application.embed_event.on("recording", function () {
    	//Your code goes here
    });
  11. uploading

    Triggered when a video is uploading

    Example:
    application.embed_event.on("uploading", function () {
    	//Your code goes here
    });
  12. seek

    Triggered when the user moves the progress indicator to continue video playback from a different position

    Example:
    application.embed_event.on("seek", function ( position ) {
    	//Your code goes here
    });
  13. rerecord

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

    Example:
    application.embed_event.on("rerecord", function () {
    	//Your code goes here
    });
  14. countdown

    Triggered while a video recorder counts down

    Example:
    application.embed_event.on("countdown", function ( time ) {
    	//Your code goes here
    });
  15. recording_progress

    Recording Progress

    Example:
    application.embed_event.on("recording_progress", function ( time ) {
    	//Your code goes here
    });
  16. upload_progress

    Upload Progress

    Example:
    application.embed_event.on("upload_progress", function ( uploaded, total ) {
    	//Your code goes here
    });
  17. processing

    Processing Progress

    Example:
    application.embed_event.on("processing", function ( percentage ) {
    	//Your code goes here
    });
  18. processed

    Processing completed

    Example:
    application.embed_event.on("processed", function () {
    	//Your code goes here
    });
  19. ready_to_record

    Triggered when a video recorder is ready to record a video

    Example:
    application.embed_event.on("ready_to_record", function () {
    	//Your code goes here
    });
  20. ready_to_play

    Triggered when a video player is ready to play a video

    Example:
    application.embed_event.on("ready_to_play", function () {
    	//Your code goes here
    });
  21. access_forbidden

    Triggered when access to camera is not granted

    Example:
    application.embed_event.on("access_forbidden", function ( error ) {
    	//Your code goes here
    });
  22. access_granted

    Triggered when access to camera is granted

    Example:
    application.embed_event.on("access_granted", function () {
    	//Your code goes here
    });
  23. camera_unresponsive

    Triggered when camera has become unresponsive.

    Example:
    application.embed_event.on("camera_unresponsive", function () {
    	//Your code goes here
    });
  24. verified

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

    Example:
    application.embed_event.on("verified", function () {
    	//Your code goes here
    });
  25. no_camera

    Triggered when camera has no signal.

    Example:
    application.embed_event.on("no_camera", function () {
    	//Your code goes here
    });
  26. no_microphone

    Triggered when microphone has no signal.

    Example:
    application.embed_event.on("no_microphone", function () {
    	//Your code goes here
    });