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

    Returns current height of embedding

    Example:
    embedding.height();
  2. hide

    Hides embedding

    Example:
    embedding.hide();
  3. hidePopup

    Hide the popup of embeddings displayed in a popup

    Example:
    embedding.hidePopup();
  4. show

    Shows embedding

    Example:
    embedding.show();
  5. stopRecord

    Stops recording of embedded recorder

    Example:
    embedding.stopRecord();
  6. toggleRecorder

    Toggle uploader to show recorder view instead

    Example:
    embedding.toggleRecorder();
  7. toggleUploader

    Toggle recorder to show uploader view instead

    Example:
    embedding.toggleUploader();
  8. upload

    Start uploading of selected file

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

    Example:
    embedding.upload();
  9. width

    Returns current width of embedding

    Example:
    embedding.width();
  10. activate

    Activates embedding

    Example:
    embedding.activate();
  11. activated

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

    Example:
    embedding.activated();
  12. activeElement

    Returns HTML reference to the embedding in DOM.

    Example:
    embedding.activeElement();
  13. aspectRatio

    Returns float value of current aspect ratio (width/height). See .width() and .height()

    Example:
    embedding.aspectRatio();
  14. averageFrameRate

    Returns average frame rate.

    Example:
    embedding.averageFrameRate();
  15. destroy

    Destroys and removes embedding from DOM and memory

    Example:
    embedding.destroy();
  16. destroyed

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

    Example:
    embedding.destroyed();
  17. execute

    all events here can be run through this, add comma to pass parameter. Make sure however to use try catch as it will raise error on bad command.

    Example:
    embedding.execute();
  18. get

    Returns property value (if specified) or entire object

    Example:
    embedding.get();
  19. getCurrentPosition

    Returns time the playback is in at this very moment (in seconds). Will return NaN if playback did not start.

    Example:
    embedding.getCurrentPosition();
  20. getPlaybackCount

    Get integer of how many times this player played this video (resets on refresh and destroy(); ).

    Example:
    embedding.getPlaybackCount();
  21. hasKey

    Confirms if key exists and will give you data if you call embedding.get(key);

    Example:
    embedding.hasKey();
  22. isFlash

    This tells if embedding is using flash

    Example:
    embedding.isFlash();
  23. isHD

    Is this video of HD resolution?

    Example:
    embedding.isHD();
  24. isMobile

    Tells you if the player is used on a mobile device

    Example:
    embedding.isMobile();
  25. isSD

    Tells you if you are playing SD quality video

    Example:
    embedding.isSD();
  26. isRecording

    Method to check if recording is in progress

    Example:
    embedding.isRecording();
  27. lightLevel

    Returns value indicating quality of lighting during recording

    Example:
    embedding.lightLevel();
  28. parentAspectRatio

    Returns aspect ratio of the element holding the embedding

    Example:
    embedding.parentAspectRatio();
  29. parentHeight

    Returns height of the element holding the embedding

    Example:
    embedding.parentHeight();
  30. parentWidth

    Returns width of the element holding the embedding

    Example:
    embedding.parentWidth();
  31. pause

    Pause playback of video or pause recording (r34).

    Example:
    embedding.pause();
  32. play

    Start playback of recorded video.

    Example:
    embedding.play();
  33. popupAttrs

    Returns attributes such as width, height, stretch, autoplay of popup.

    Example:
    embedding.popupAttrs();
  34. reattachVideo

    Reloads the video using same details

    Example:
    embedding.reattachVideo();
  35. reattachImage

    Reloads the image (poster) using same details

    Example:
    embedding.reattachImage();
  36. record

    Start recording of embedded recorder.

    Example:
    embedding.record();
  37. rerecord

    Trigger re-recording of embedded (re-)recorder

    Example:
    embedding.rerecord();
  38. reset

    Reset embedding to initial state

    Example:
    embedding.reset();
  39. seek

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

    Example:
    embedding.seek();
  40. set

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

    Example:
    embedding.set();
  41. set_volume

    Sets the volume for plaback sound (0-1)

    Example:
    embedding.set_volume();
  42. soundLevel

    Returns value indicating quality of sound during recording

    Example:
    embedding.soundLevel();
  43. stop

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

    Example:
    embedding.stop();
  44. toggleFullscreen

    Toggle embedding to go into fullscreen

    Example:
    embedding.toggleFullscreen();
  45. toggleSubtitles

    Show or hide subtitles

    Example:
    embedding.toggleSubtitles();
  46. videoAttached

    Tells you if video is attached to the embedding or not

    Example:
    embedding.videoAttached();
  47. videoError

    Returns video error if any happened

    Example:
    embedding.videoError();
  48. videoHeight

    Returns height of video itself

    Example:
    embedding.videoHeight();
  49. videoLoaded

    Returns true if video is loaded, false if not

    Example:
    embedding.videoLoaded();
  50. videoWidth

    Returns width of video itself

    Example:
    embedding.videoWidth();