Documentation

Welcome to our documentation pages. We want to let you know in this way that we are reorganizing our documentation to make it much easier to follow. As such if you are not first time here, it might seem that there is no longer what you saw here before - don't worry it has been moved and updated and we will show you in the overview section where it is, so please scroll down.

We also want to apologize for the documentation that is still on this page (not yet moved) and might seem out of place. We are in process of moving this over to new places as well.

We also want to say thank you to everyone that participated in any way with their feedback and suggestions and ask that if you have any new ones, feel free to share them with us as usually

Idea

The documentation is separated in several mayor sections with the relevant sections moved to its children. When moving content we made sure that the following was respected:

  • Each SDK has its own pages
  • Parameters, methods and events to be shown for both v1 and v2 and make it easy to see for which one it is
  • Add revisions into play with parameters, events and methods so you know exactly what and how works
  • All SDKs are in one place
  • Short pages
  • Simple way to see only things of interest
Next to that we also made sure that there was joy, love and happiness and we hope that you will have some as well while going through these pages.

Links

JavaScript SDK is now moved to the following page: SDKs > JavaScript SDK

Under it you will find several usable sections:
JavaScript SDK revisions
It will show you short details on each JavaScript revision
You will find it under SDKs > JavaScript SDK > Version History
All you need to add your embeddings to your website
This segment holds sections with parameters, events and similar.
You will find it under SDKs > JavaScript SDK > Browser Integration
Step 1: Calling resources that make it all happen
This holds the tool that will help you see the resources that you need to add to your pages
You will find it under SDKs > JavaScript SDK > Browser Integration > Header
Step 2: Choosing the way to add the embedding
See how to add the embedding to your pages in any way that works best for you.
You will find it under SDKs > JavaScript SDK > Browser Integration > Embedding Methods
Step 3: Fine tune your embeddings using parameters
Make the embedding behave and look how you want it by using one of the listed parameters
You will find it under SDKs > JavaScript SDK > Browser Integration > Embedding Parameters
Everything on interacting with embeddings can be found here
This segment holds sections with events and methods that will help you interact from your code to your embeddings with ease
You will find it under SDKs > JavaScript SDK > Browser Interaction
Step 4: Wait for the event to fire
All embeddings will fire events for you, all you need to listen for the one (or several) of interest and do what you need. This page will show you which events there are and how you can use them.
You will find it under SDKs > JavaScript SDK > Browser Interaction > Embedding Events
Step 5: Do action yourself when you want it and what you want to
Callable methods are a great way to change something by yourself at any given time, allowing you to react to actions on your website if and when you want.
You will find it under SDKs > JavaScript SDK > Browser Interaction > Callable Methods
Like JavaScript SDK, we have moved the documentation for server side SDKs and have now made it easier for you to see more details about each of our SDKs. They can be found under: SDKs > Server Side SDKs

Under it you will find each server side SDK within its own pages:
PHP SDK for all those scripts requiring video handling
You will find it under SDKs > Server Side SDKs >PHP SDK
Python SDK for all those apps looking for easy way to introduce video handling
You will find it under SDKs > Server Side SDKs >Python SDK
Node.js SDK for all projects missing the video module
You will find it under SDKs > Server Side SDKs >Node.js SDK
Ruby SDK for all projects looking for that one video gem
You will find it under SDKs > Server Side SDKs >Ruby SDK
Java SDK for all big projects looking to do video in an easy way
You will find it under SDKs > Server Side SDKs >Java SDK
C# SDK for all projects where productivity is important
You will find it under SDKs > Server Side SDKs >C# SDK
You have probably already noticed that we had added the documentation for our mobile SDKs under SDKs section. They can be found under: SDKs > Mobile SDKs

Currently we support mobile devices with following:
iOS SDK allows you to build native iOS applications with ease
You will find it under SDKs > Mobile SDKs > iOS SDK
Android SDK is perfect for any Android project
You will find it under SDKs > Mobile SDKs > Android SDK
Don't forget we are also supporting Cordova / PhoneGap
You will find it under SDKs > Mobile SDKs > Cordova / PhoneGap
If you are looking for Authorization tokens, then we suggest checking out our new Authorization token pages.
We go over the arguments that you can use when creating authorization tokens
You can read more about it under Api Reference > Authorization Tokens Arguments
Then we go over creation and usage of the same
You can read more about it under Api Reference > Authorization Tokens See how to create and use Authorization tokens
.
Finally we show you samples on how to achieve few most commonly used setups.
You can see them under API Reference > Authorization Tokens Authorization token examples
.
Looking for WebHooks (server events)? Look no further, this is the right place to find them all.
We have quite a few, however we suggest starting from the start so you get a bit familiar with them
You can see more about the WebHooks and what they mean for you here.
Already familiar with webhooks and want to see them?
If so, skip to the list of our webhooks.

Add a recorder to a page as follows:

  <ziggeo ziggeo-width=320
          ziggeo-height=240>
  </ziggeo>

The recorder can also serve as an uploader. For some applications you want end-users to be able to upload existing video files.

Add a player to a page as follows.

To get a player all you need to do is supply the ziggeo-video option with a video token inside the Ziggeo tag as follows.

  <ziggeo ziggeo-video="_sample_video" 
          ziggeo-width=320
          ziggeo-height=240>
  </ziggeo>

Once a new video has been created, a so-called token is uniquely assigned to it, which you can use to fire up the player.

There are different ways of obtaining the video token of a recorded video, see e.g. the next section on events.

You can also provide a name for the video yourself, called the video key by adding a ziggeo-key="nameofthevideo" argument to your recorder embedding. To embed a video player by using the key instead of the video, you can use the normal ziggeo-video argument, but you need to prefix it with underscore, e.g. ziggeo-video="_nameofthevideo".

You can call our JavaScript API to accept videos and many more.

See the following examples:

ZiggeoApi.Streams.accept(video_token, stream_token, {
	success: function (args, result) {
		// Success
	},
	failure: function (args, error) {
		// Failure
	}
});

Here is a complete outline of all supported methods.

Videos

The videos resource allows you to access all single videos. Each video may contain more than one stream.

Query an array of videos (will return at most 50 videos by default). Newest videos come first.

ZiggeoApi.Videos.index(data, [callbacks])

Delete a single video by token or key.

ZiggeoApi.Videos.destroy(token_or_key, [callbacks])

Create a new video.

ZiggeoApi.Videos.create(data, [callbacks])

Update an existing video.

ZiggeoApi.Videos.update(token_or_key, data, [callbacks])

Read an existing video.

ZiggeoApi.Videos.get(token_or_key, [callbacks])

Get URL of the thumbnail.

ZiggeoApi.Videos.image(token_or_key)

Get URL of the video file.

ZiggeoApi.Videos.source(token_or_key)

Streams

The streams resource allows you to directly access all streams associated with a single video.

Delete the stream

ZiggeoApi.Streams.destroy(video_token_or_key, token_or_key, [callbacks])

Create a new stream

ZiggeoApi.Streams.create(video_token_or_key, data, [callbacks])

Accept stream

ZiggeoApi.Streams.accept(video_token_or_key, token_or_key, [callbacks])

Both our player and our recorder can be styled using CSS to align with the look and feel if your brand or website.

There is no need to recompile any files. Simply overwrite the respective CSS classes.

All the control elements of the recorder are created in HTML and can be styled using CSS.

For instance, here is an example of a different color scheme.

.video-recorder-initial .btn-primary {
	background-color: transparent;
	border: 1px solid black;
}

To see all involved css classes, you can browse our default css file here. In order to overwrite our classes, simply include your css overwrites after including our css file in your website's header.

The play button of the player can be styled using JS and CSS.

You can position the play button horizontally and vertically by setting the respective parameters as follows in your website's header.

Furthermore, you can style the button by defining a custom css class and applying it as follows:

<script>
	ZiggeoApi.Styles.play_button_vertical_align = "center"; // "top" or "bottom"
	ZiggeoApi.Styles.play_button_horizontal_align = "center"; // "left" or "right"
	ZiggeoApi.Styles.play_button_class = "ziggeo-play-button"; // "your-custom-css-class"
</script>