Documentation

In order to reference an embedding (being at a recorder or a player), you'll need to look it up as follows:

<ziggeo ziggeo-id="name-of-my-embedding" ...></ziggeo>
<script>
    var embedding = ZiggeoApi.Embed.get("name-of-my-embedding");
</script>

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. play

    Start playback of recorded video.

    Example:
    embedding.play();
  2. record

    Start recording of embedded recorder.

    Example:
    embedding.record();
  3. upload

    Start uploading of selected file

    *This method requires your embedding to have the following parameter(s) set: manual_upload

    Example:
    embedding.upload();
  4. rerecord

    Trigger re-recording of embedded (re-)recorder

    Example:
    embedding.rerecord();
  5. stop

    Stop playback (v1+v2) and recording (v1)

    Example:
    embedding.stop();
  6. stopRecord

    Stops recording of embedded recorder

    Example:
    embedding.stopRecord();
  7. hidePopup

    Hide the popup of embeddings displayed in a popup

    Example:
    embedding.hidePopup();
  8. reset

    Reset embedding to initial state

    Example:
    embedding.reset();
  9. toggleUploader

    Toggle recorder to show uploader view instead

    Example:
    embedding.toggleUploader();
  10. toggleRecorder

    Toggle uploader to show recorder view instead

    Example:
    embedding.toggleRecorder();
  11. activate

    Activates embedding

    Example:
    embedding.activate();
  12. lightLevel

    Returns value indicating quality of lighting during recording

    Example:
    embedding.lightLevel();
  13. soundLevel

    Returns value indicating quality of sound during recording

    Example:
    embedding.soundLevel();
  14. averageFrameRate

    Returns average frame rate.

    Example:
    embedding.averageFrameRate();
  15. isRecording

    Method to check if recording is in progress

    Example:
    embedding.isRecording();
  16. hide

    Hides embedding

    Example:
    embedding.hide();
  17. show

    Shows embedding

    Example:
    embedding.show();
  18. width

    Returns current width of embedding

    Example:
    embedding.width();
  19. height

    Returns current height of embedding

    Example:
    embedding.height();
  20. isFlash

    This tells if embedding is using flash

    Example:
    embedding.isFlash();
  21. videoWidth

    Returns width of video itself

    Example:
    embedding.videoWidth();
  22. videoHeight

    Returns height of video itself

    Example:
    embedding.videoHeight();
  23. destroy

    Destroys and removes embedding from DOM and memory

    Example:
    embedding.destroy();