Documentation

In order to reference a recorder embedding, you'll need to look it up as follows:

<ziggeorecorder id="id-of-my-embedding" ...></ziggeorecorder>
<script>
    var embedding = ZiggeoApi.V2.Recorder.findByElement( document.getElementById('id-of-my-embedding') );
</script>

In order to reference a player embedding, you'll need to look it up as follows:

<ziggeoplayer id="id-of-my-embedding" ...></ziggeoplayer>
<script>
    var embedding = ZiggeoApi.V2.Player.findByElement( document.getElementById('id-of-my-embedding') );
</script>
  1. Presentational methods / functions 2/2

    Methods you can call to change some presentational aspect.

    The embedding can do many things. Usually you would set this up using your parameters, however what if you want to change or set something in a different way?

    Our presentational methods allow you to do this in a dynamic way, some even after the embedding has been created.

  2. toggleFaceOutline

    Toggles the face outline

    embedding.toggleFaceOutline();
  3. toggle_settings

    Toggles if settings are shown or not

    embedding.toggle_settings();
  1. Informational methods / functions 22/22

    The list of methods to get some values.

    Sometimes you want to make a call to get some info. Well with the following list of methods you can do just that.

  2. aspectRatio

    Returns float value of current aspect ratio.

    embedding.aspectRatio();
  3. audioError

    Returns audio error if any happened

    embedding.audioError();
  4. averageFrameRate

    Returns average frame rate.

    embedding.averageFrameRate();
  5. destroyed

    Tells you if the embedding is destroyed (true) or not (false)

    embedding.destroyed();
  6. get

    Returns property value (if specified) or entire object

    • object_property Optional argument to get specific info from within video data.
    embedding.get(object_property);
  7. getCurrentPosition

    Returns time the playback is in at this very moment (in seconds).

    embedding.getCurrentPosition();
  8. getPlaybackCount

    Get integer of how many times this player played this video

    embedding.getPlaybackCount();
  9. hasKey

    Confirms if key exists

    embedding.hasKey();
  10. imageError

    Returns image error if any happened

    embedding.imageError();
  11. imageHeight

    Returns height of image itself

    embedding.imageHeight();
  12. imageWidth

    Returns width of image itself

    embedding.imageWidth();
  13. isFlash

    This tells if embedding is using flash

    embedding.isFlash();
  14. isHD

    Is this video of HD resolution?

    embedding.isHD();
  15. isMobile

    Tells you if the embedding is used on a mobile device

    embedding.isMobile();
  16. isRecording

    Method to check if recording is in progress

    embedding.isRecording();
  17. isSD

    Tells you if you are playing SD quality video

    embedding.isSD();
  18. isWebrtcStreaming

    This tells if embedding is using WebRTC Streaming

    embedding.isWebrtcStreaming();
  19. lightLevel

    Returns value indicating quality of lighting during recording

    embedding.lightLevel();
  20. videoError

    Returns video error if any happened

    embedding.videoError();
  21. videoHeight

    Returns height of video itself

    embedding.videoHeight();
  22. videoLoaded

    Returns true if video is loaded, false if not

    embedding.videoLoaded();
  23. videoWidth

    Returns width of video itself

    embedding.videoWidth();
  1. Operational methods / functions 30/30

    The list of methods that change how embeddings operate

    Changing how something happens is a very nice way to fine tune the experience. Especially so if you combine this with other things such as events.

  2. activate

    Activates embedding

    embedding.activate();
  3. activated

    Returns true if embedding is activated or false if it is not.

    embedding.activated();
  4. cancel

    Cancel media upload

    embedding.cancel();
  5. destroy

    Destroys and removes embedding from DOM and memory

    embedding.destroy();
  6. execute

    A way to execute a command

    • method The name of the method to run
    • argument Argument that would be passed to the method (optional)
    embedding.execute(method, argument);
  7. pause

    Pause playback of video or pause recording

    embedding.pause();
  8. pause_recorder

    Pause recording

    embedding.pause_recorder();
  9. play

    Start playback of recorded video.

    embedding.play();
  10. reattachImage

    Reloads the image (poster) using same details

    embedding.reattachImage();
  11. reattachVideo

    Reloads the video using same details

    embedding.reattachVideo();
  12. record

    Start recording process

    embedding.record();
  13. record_audio

    Starts microphone recording

    embedding.record_audio();
  14. record_screen

    Starts screen recording

    embedding.record_screen();
  15. record_video

    Starts camera recording

    embedding.record_video();
  16. rerecord

    Trigger re-recording process

    embedding.rerecord();
  17. resume

    Resume recording (if it was paused)

    embedding.resume();
  18. seek

    Seeks to certain time in seconds (counts from 0 regardless of current position or initial seek)

    • position time in seconds of the video to which to go to
    embedding.seek(position);
  19. set

    Allows you to set some properties during the use of embedding.

    • key parameter to set
    • value value to set the key to
    embedding.set(key, value);
  20. set_speed

    Sets the speed of playback

    • speed The speed you would like to set
    embedding.set_speed(speed);
  21. set_volume

    Sets the volume for plaback sound (0-1)

    • amount amount to set the valume to
    embedding.set_volume(amount);
  22. soundLevel

    Returns value indicating quality of sound during recording

    embedding.soundLevel();
  23. stop

    Stop active playback and active recording

    embedding.stop();
  24. toggleFullscreen

    Toggle embedding to go into or out of fullscreen

    embedding.toggleFullscreen();
  25. toggleSubtitles

    Show or hide subtitles

    embedding.toggleSubtitles();
  26. toggle_face_mode

    Toggles the face mode on or off

    embedding.toggle_face_mode();
  27. toggle_player

    Toggles the player mode

    embedding.toggle_player();
  28. upload_audio

    Starts the upload of an audio file

    • file The File Object to start the file upload
    embedding.upload_audio(file);
  29. upload_covershot

    Starts the upload of an image file

    • file The File Object to start the file upload
    embedding.upload_covershot(file);
  30. upload_text_tracks

    Upload the transcription data

    embedding.upload_text_tracks();
  31. upload_video

    Starts the upload of a video file

    • file The File Object to start the file upload
    embedding.upload_video(file);
  1. DOM methods / functions 6/6

    The list of methods that are connected to the DOM tree

    Most of the events that our embeddings fire are about the embedding. Sometimes they might however be connected to DOM a tiny bit more.

    Since they allow you to make different types of calls, you can see them here.

  2. activeElement

    Returns HTML reference to the embedding in DOM.

    embedding.activeElement();
  3. parentAspectRatio

    Returns aspect ratio of the element holding the embedding

    embedding.parentAspectRatio();
  4. parentHeight

    Returns height of the element holding the embedding

    embedding.parentHeight();
  5. parentWidth

    Returns width of the element holding the embedding

    embedding.parentWidth();
  6. reset

    Reset embedding to initial state

    embedding.reset();
  7. videoAttached

    Tells you if video is attached to the embedding or not

    embedding.videoAttached();