Ziggeo
Sign Up Log In

Embedding Events

Events concerning particular embeddings such as recorder and player.

Benefits

These events are specific to individual recorders or players.

  • 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

Preface

  • 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') within as well as outside of events.

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);

List of events

Media events

The list of all events that are connected to your media

Media can be recorded, played and re-recorded. This section will help you get the details about your media as it happens, telling you exactly what happens and where.

endeddefault: —

Fires when a video has ended

  • healthy — true if healthy

audio player, audio recorder, video player, video recorder

invoke-skipdefault: —

Someone skipped choosing the poster image

After recording a gallery of snapshots is shown and a skip button. If that button is pressed, this event is fired and image is selected automatically.

video recorder

loadeddefault: —

Triggered when the media is loaded

There are different aspects to media playback being ready. This tells you when the browser has loaded the media and is ready to play it

audio player, audio recorder, image capture, video player, video recorder

pauseddefault: —

Fires when the pause button is clicked

audio player, audio recorder, video player, video recorder

playingdefault: —

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

audio player, audio recorder, video player, video recorder

recordingdefault: —

Triggered when a recording process has started

audio recorder, image capture, video recorder

rerecorddefault: —

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

audio player, image viewer, video player

seekdefault: —

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

  • position — position in video

audio player, video player

select-imagedefault: —

Fires once the cover image has been selected

  • image — the image object representing the selected image

video recorder

uploadingdefault: —

Triggered when a video is uploading

audio recorder, image capture, video recorder

DOM related events

The list of events that are connected to DOM in some way

These events would usually fire as some change happens in the HTML (DOM tree). The DOM event can be specific to our embedding, or more global in its nature.

attacheddefault: —

Fires when the embedding is attached to the DOM element

audio player, audio recorder, image capture, video player, video recorder

Progress events

The list of events that inform you of different progress states

If you want to create something special, provide additional ways of keeping your visitors informed or attentive as things happen, you often need to know different states of progress. One good example is if you plan to build your own flashy upload progress bar.

That and all other events are shown here.

countdowndefault: —

Triggered while a video recorder counts down

  • time — Timer time

audio recorder, image capture, video recorder

processeddefault: —

Processing completed

audio recorder, image capture, video recorder

processingdefault: —

Processing Progress

  • percentage — Percentage processed

audio recorder, image capture, video recorder

recording_progressdefault: —

Recording Progress

  • time — Elapsed time while recording
  • paused — Only with WebRTC recorder, accept true value if recorder was paused, default is false

audio recorder, image capture, video recorder

upload_progressdefault: —

Upload Progress

  • uploaded — Bytes uploaded
  • total — Bytes total

audio recorder, image capture, video recorder

uploadeddefault: —

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

audio recorder, image capture, video recorder

Errors related events

The list of events that inform you when some forms of errors happen

Errors are common thing for any web and non web based systems. Some errors are actually notifications that we need to do something like plugging in our camera. Others can be more serious. These events help you know when these happen and react as you wish.

access_forbiddendefault: —

Triggered when access to camera or microphone is not granted

  • error — Error data

audio recorder, image capture, video recorder

access_granteddefault: —

Triggered when access to camera and microphone is granted

audio recorder, image capture, video recorder

camera_nosignaldefault: —

Triggered when camera has no signal.

  • data — The object data

image capture, video recorder

camera_unresponsivedefault: —

Triggered when camera has become unresponsive.

  • error — Error data

image capture, video recorder

errordefault: —

Triggered when an embedding encounters an error

This is an event to hook your code in to get notified when any error is raised

  • error_type — type of the error
  • error_code — code giving more details about the error

audio player, audio recorder, image capture, video player, video recorder

no_cameradefault: —

Triggered when no camera has been detected.

video recorder

no_microphonedefault: —

Triggered when no microphone has been detected.

video recorder

Informational events

The list of events that inform you of different things that happen on your form

All events are informational in their nature. While the events are not specific as the ones above, they still offer you insight into different things that happen on your pages and around your embeddings.

bounddefault: —

Happens when hardware has been bound and is about to be ready to use

audio recorder, image capture, video recorder

camera_signaldefault: —

Triggered when camera has signal.

image capture, video recorder

camerahealthdefault: —

Triggered when camera health changes.

  • healthy — true if healthy

image capture, video recorder

change-google-cast-volumedefault: —

Fires when volume is changed on playback on Google Cast

video player

has_cameradefault: —

Triggered when a camera has been detected.

video recorder

has_microphonedefault: —

Triggered when a microphone has been detected.

audio recorder, image capture, video recorder

mainvideostreamendeddefault: —

Fires once multistream capture is stopped.

Once Stop Sharing button is clicked this event alerts you about the same.

audio recorder, video recorder

manually_submitteddefault: —

Triggered when a video has been manually submitted

audio recorder, image capture, video recorder

microphonehealthdefault: —

Triggered when microphone health changes.

  • healthy — true if healthy

audio recorder, video recorder

pause-google-castdefault: —

Fires when Google Cast is used to play the video and the video is paused

video player

play-google-castdefault: —

Fires when Google Cast is used to play the video

video player

ready-to-trimdefault: —

Triggered when a video is waiting to be trimmed.

This will only be triggered if allowtrim is set to true.

video recorder

ready_to_playdefault: —

Triggered when a video player is ready to play a video

audio player, audio recorder, image capture, video recorder

ready_to_recorddefault: —

Triggered when a video recorder is ready to record a video

audio recorder, image capture, video recorder

recording_stoppeddefault: —

Recording Stopped

Listed to this event if you want to know when recording has been stopped

audio recorder, video recorder

stoppeddefault: —

Fires when playback is manually stopped

audio player, video player

upload_selecteddefault: —

Triggered when a file has been selected for upload

  • file — File object

audio recorder, image capture, video recorder

verifieddefault: —

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

audio recorder, image capture, video recorder

video-trimmeddefault: —

Triggered after a video is trimmed manually or using the trimming overlay.

  • start — Time in seconds where trimmed video should start
  • end — Time in seconds where trimmed video should end
  • originalDuration — Duration of the video before trimming

video recorder