Documentation

  • Filter
  • JavaScript Version
  • JavaScript Revision

To use methods you will first need to grab the reference to the embedding.

<ziggeo ziggeo-id="name-of-my-embedding" ...></ziggeo>
<script>
    var embedding = ZiggeoApi.Embed.get("name-of-my-embedding");
</script>
  • The same steps are taken for both recorder and player

To use methods you will first need to grab the reference to the embedding.

<ziggeorecorder id="id-of-my-embedding" ...></ziggeorecorder>
<script>
    var embedding = ZiggeoApi.V2.Recorder.findByElement( document.getElementById('id-of-my-embedding') );
</script>
  • This is to get the v2 recorder embedding
<ziggeoplayer id="id-of-my-embedding" ...></ziggeoplayer>
<script>
    var embedding = ZiggeoApi.V2.Player.findByElement( document.getElementById('id-of-my-embedding') );
</script>
  • This is to get the v2 player embedding
  1. play

    Start the playback of the recorded video.

    Example:
    embedding.play();
  2. record

    Start the recording of an embedded recorder.

    Example:
    embedding.record();
  3. upload

    Start the uploading of a selected file

    *This method requires that your embedding has the following parameter(s) set: manual_upload

    Example:
    embedding.upload();
  4. rerecord

    Trigger the re-recording of an embedded (re-)recorder

    Example:
    embedding.rerecord();
  5. stop

    Stop only the playback of a recorded video (in v1), while if you are using v2 this method can be used to stop playback and recording

    Example:
    embedding.stop();
  6. stopRecord

    Stops the recording of an embedded recorder

    Example:
    embedding.stopRecord();
  7. hidePopup

    Hide the popup of popup embedding

    Example:
    embedding.hidePopup();
  8. reset

    Reset the embedding to its initial state

    Example:
    embedding.reset();
  9. toggleUploader

    Toggle the recorder to show the uploader view instead

    Example:
    embedding.toggleUploader();
  10. toggleRecorder

    Toggle the uploader to show the recorder view instead

    Example:
    embedding.toggleRecorder();
  11. activate

    Activates the embedding

    Example:
    embedding.activate();
  12. lightLevel

    Returns the value indicating how good the lighting is during recording

    Example:
    embedding.lightLevel();
  13. soundLevel

    Returns the value indicating how good the sound is during recording

    Example:
    embedding.soundLevel();
  14. averageFrameRate

    Returns the average frame rate.

    Example:
    embedding.averageFrameRate();
  15. isRecording

    Method to check if the recording is in progress

    Example:
    embedding.isRecording();
  16. hide

    Hides the embedding

    Example:
    embedding.hide();
  17. show

    Shows the embedding

    Example:
    embedding.show();
  18. width

    Returns the current width of the embedding

    Example:
    embedding.width();
  19. height

    Returns the current height of the embedding

    Example:
    embedding.height();
  20. isFlash

    This tells if the embedding is using flash

    Example:
    embedding.isFlash();
  21. videoWidth

    Returns the width of the video itself

    Example:
    embedding.videoWidth();
  22. videoHeight

    Returns the height of the video itself

    Example:
    embedding.videoHeight();
  23. destroy

    Destroys the embedding in a clean way (this will not remove the main v2 element, however it will remove everything within the same and the attached events)

    Example:
    embedding.destroy();