ziggeo
Advanced tools
Readme
latest version: 0.1.30
Ziggeo is a powerfull, whitelabel video SAAS with a goal to help people with their video revolution. And what better way to do it than with an award winning multimedia API.
This server side SDK is designed to help you ease the communication with Ziggeo API. In that it allows you to privately communicate between your server and our server through requests of what you want to happen.
It offers you pre-built functionality to call and manipulate and there are demos in /demos/ directory for you to check out and use as starting point.
If any of the above is "Yes" then you are in the right place as this SDK is for you!
You will want to either download the SDK zip file or to pull it in as git repository into your own project.
To clone it you would go into your project folder and then
node git clone https://github.com/Ziggeo/ZiggeoNodeSdk
To start using the Node.js SDK you would need to initialize the Ziggeo class with application token, private token and possibly encryption token. The token and keys can be found within the Ziggeo application once you log into your account, under Overview page.
npm install ziggeo
For the client-side integration, you need to add these assets to your html file:
<link rel="stylesheet" href="//assets-cdn.ziggeo.com/v2-stable/ziggeo.css" />
<script src="//assets-cdn.ziggeo.com/v2-stable/ziggeo.js"></script>
Then, you need to specify your api token:
<script>
var ziggeoApplication = new ZiggeoApi.V2.Application({
token: "APPLICATION_TOKEN",
webrtc_streaming_if_necessary: true,
webrtc_on_mobile: true
});
</script>
You can specify other global options, see here.
To fire up a recorder on your page, add:
<ziggeorecorder></ziggeorecorder>
To embed a player for an existing video, add:
<ziggeoplayer ziggeo-video='video-token'></ziggeoplayer>
For the full documentation, please visit ziggeo.com.
You can integrate the Server SDK as follows:
Ziggeo = require('ziggeo');
var ZiggeoSdk = new Ziggeo('*token*', '*private_key*', '*encryption_key*');
Config is optional and if not specified (recommended), the Config file will be used instead.
Currently available methods are branched off within different categories:
Each of this sections has their own actions and they are explained bellow
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.
ZiggeoSdk.Videos.index(arguments, [callbacks])
Arguments
Get the video count for the application.
ZiggeoSdk.Videos.count(arguments, [callbacks])
Arguments
Get a single video by token or key.
ZiggeoSdk.Videos.get(token_or_key, [callbacks])
Get multiple videos by tokens or keys.
ZiggeoSdk.Videos.get_bulk(arguments, [callbacks])
Arguments
Get stats for multiple videos by tokens or keys.
ZiggeoSdk.Videos.stats_bulk(arguments, [callbacks])
Arguments
Download the video data file
ZiggeoSdk.Videos.download_video(token_or_key, [callbacks])
Download the image data file
ZiggeoSdk.Videos.download_image(token_or_key, [callbacks])
Get the video's stats
ZiggeoSdk.Videos.get_stats(token_or_key, [callbacks])
Push a video to a provided push service.
ZiggeoSdk.Videos.push_to_service(token_or_key, arguments, [callbacks])
Arguments
Apply an effect profile to a video.
ZiggeoSdk.Videos.apply_effect(token_or_key, arguments, [callbacks])
Arguments
Apply a meta profile to a video.
ZiggeoSdk.Videos.apply_meta(token_or_key, arguments, [callbacks])
Arguments
Update single video by token or key.
ZiggeoSdk.Videos.update(token_or_key, arguments, [callbacks])
Arguments
Update multiple videos by token or key.
ZiggeoSdk.Videos.update_bulk(arguments, [callbacks])
Arguments
Delete a single video by token or key.
ZiggeoSdk.Videos.destroy(token_or_key, [callbacks])
Create a new video.
ZiggeoSdk.Videos.create(arguments, [callbacks])
Arguments
Get analytics for a specific videos with the given params
ZiggeoSdk.Videos.analytics(token_or_key, arguments, [callbacks])
Arguments
The streams resource allows you to directly access all streams associated with a single video.
Return all streams associated with a video
ZiggeoSdk.Streams.index(video_token_or_key, arguments, [callbacks])
Arguments
Get a single stream
ZiggeoSdk.Streams.get(video_token_or_key, token_or_key, [callbacks])
Download the video data associated with the stream
ZiggeoSdk.Streams.download_video(video_token_or_key, token_or_key, [callbacks])
Download the image data associated with the stream
ZiggeoSdk.Streams.download_image(video_token_or_key, token_or_key, [callbacks])
Push a stream to a provided push service.
ZiggeoSdk.Streams.push_to_service(video_token_or_key, token_or_key, arguments, [callbacks])
Arguments
Delete the stream
ZiggeoSdk.Streams.destroy(video_token_or_key, token_or_key, [callbacks])
Create a new stream
ZiggeoSdk.Streams.create(video_token_or_key, arguments, [callbacks])
Arguments
Attaches an image to a new stream. Must be attached before video, since video upload triggers the transcoding job and binds the stream
ZiggeoSdk.Streams.attach_image(video_token_or_key, token_or_key, arguments, [callbacks])
Arguments
Attaches a video to a new stream
ZiggeoSdk.Streams.attach_video(video_token_or_key, token_or_key, arguments, [callbacks])
Arguments
Attaches a subtitle to the stream.
ZiggeoSdk.Streams.attach_subtitle(video_token_or_key, token_or_key, arguments, [callbacks])
Arguments
The audios resource allows you to access all single audios. Each video may contain more than one stream.
Query an array of audios (will return at most 50 audios by default). Newest audios come first.
ZiggeoSdk.Audios.index(arguments, [callbacks])
Arguments
Get the audio count for the application.
ZiggeoSdk.Audios.count(arguments, [callbacks])
Arguments
Get a single audio by token or key.
ZiggeoSdk.Audios.get(token_or_key, [callbacks])
Get multiple audios by tokens or keys.
ZiggeoSdk.Audios.get_bulk(arguments, [callbacks])
Arguments
Download the audio data file
ZiggeoSdk.Audios.download_audio(token_or_key, [callbacks])
Update single audio by token or key.
ZiggeoSdk.Audios.update(token_or_key, arguments, [callbacks])
Arguments
Update multiple audios by token or key.
ZiggeoSdk.Audios.update_bulk(arguments, [callbacks])
Arguments
Delete a single audio by token or key.
ZiggeoSdk.Audios.destroy(token_or_key, [callbacks])
Create a new audio.
ZiggeoSdk.Audios.create(arguments, [callbacks])
Arguments
The streams resource allows you to directly access all streams associated with a single audio.
Return all streams associated with a audio
ZiggeoSdk.AudioStreams.index(audio_token_or_key, arguments, [callbacks])
Arguments
Get a single stream
ZiggeoSdk.AudioStreams.get(audio_token_or_key, token_or_key, [callbacks])
Download the audio data associated with the stream
ZiggeoSdk.AudioStreams.download_audio(audio_token_or_key, token_or_key, [callbacks])
Delete the stream
ZiggeoSdk.AudioStreams.destroy(audio_token_or_key, token_or_key, [callbacks])
Create a new stream
ZiggeoSdk.AudioStreams.create(audio_token_or_key, arguments, [callbacks])
Arguments
The auth token resource allows you to manage authorization settings for video objects.
Get a single auth token by token.
ZiggeoSdk.Authtokens.get(token, [callbacks])
Update single auth token by token.
ZiggeoSdk.Authtokens.update(token_or_key, arguments, [callbacks])
Arguments
Delete a single auth token by token.
ZiggeoSdk.Authtokens.destroy(token_or_key, [callbacks])
Create a new auth token.
ZiggeoSdk.Authtokens.create(arguments, [callbacks])
Arguments
The application token resource allows you to manage your application.
Read application.
ZiggeoSdk.Application.get([callbacks])
Update application.
ZiggeoSdk.Application.update(arguments, [callbacks])
Arguments
Read application stats
ZiggeoSdk.Application.get_stats(arguments, [callbacks])
Arguments
The effect profiles resource allows you to access and create effect profiles for your app. Each effect profile may contain one process or more.
Create a new effect profile.
ZiggeoSdk.EffectProfiles.create(arguments, [callbacks])
Arguments
Get list of effect profiles.
ZiggeoSdk.EffectProfiles.index(arguments, [callbacks])
Arguments
Get a single effect profile
ZiggeoSdk.EffectProfiles.get(token_or_key, [callbacks])
Delete the effect profile
ZiggeoSdk.EffectProfiles.destroy(token_or_key, [callbacks])
Updates an effect profile.
ZiggeoSdk.EffectProfiles.update(token_or_key, arguments, [callbacks])
Arguments
The process resource allows you to directly access all process associated with a single effect profile.
Return all processes associated with a effect profile
ZiggeoSdk.EffectProfileProcess.index(effect_token_or_key, arguments, [callbacks])
Arguments
Get a single process
ZiggeoSdk.EffectProfileProcess.get(effect_token_or_key, token_or_key, [callbacks])
Delete the process
ZiggeoSdk.EffectProfileProcess.destroy(effect_token_or_key, token_or_key, [callbacks])
Create a new filter effect process
ZiggeoSdk.EffectProfileProcess.create_filter_process(effect_token_or_key, arguments, [callbacks])
Arguments
Attaches an image to a new stream
ZiggeoSdk.EffectProfileProcess.create_watermark_process(effect_token_or_key, arguments, [callbacks])
Arguments
Edits an existing watermark process.
ZiggeoSdk.EffectProfileProcess.edit_watermark_process(effect_token_or_key, token_or_key, arguments, [callbacks])
Arguments
The meta profiles resource allows you to access and create meta profiles for your app. Each meta profile may contain one process or more.
Create a new meta profile.
ZiggeoSdk.MetaProfiles.create(arguments, [callbacks])
Arguments
Get list of meta profiles.
ZiggeoSdk.MetaProfiles.index(arguments, [callbacks])
Arguments
Get a single meta profile
ZiggeoSdk.MetaProfiles.get(token_or_key, [callbacks])
Delete the meta profile
ZiggeoSdk.MetaProfiles.destroy(token_or_key, [callbacks])
The process resource allows you to directly access all process associated with a single meta profile.
Return all processes associated with a meta profile
ZiggeoSdk.MetaProfileProcess.index(meta_token_or_key, [callbacks])
Get a single process
ZiggeoSdk.MetaProfileProcess.get(meta_token_or_key, token_or_key, [callbacks])
Delete the process
ZiggeoSdk.MetaProfileProcess.destroy(meta_token_or_key, token_or_key, [callbacks])
Create a new video analysis meta process
ZiggeoSdk.MetaProfileProcess.create_video_analysis_process(meta_token_or_key, [callbacks])
Create a new audio transcription meta process
ZiggeoSdk.MetaProfileProcess.create_audio_transcription_process(meta_token_or_key, [callbacks])
Create a new nsfw filter meta process
ZiggeoSdk.MetaProfileProcess.create_nsfw_process(meta_token_or_key, arguments, [callbacks])
Arguments
Create a new profanity filter meta process
ZiggeoSdk.MetaProfileProcess.create_profanity_process(meta_token_or_key, arguments, [callbacks])
Arguments
The webhooks resource allows you to create or delete webhooks related to a given application.
Create a new webhook for the given url to catch the given events.
ZiggeoSdk.Webhooks.create(arguments, [callbacks])
Arguments
Confirm a webhook using its ID and the corresponding validation code.
ZiggeoSdk.Webhooks.confirm(arguments, [callbacks])
Arguments
Delete a webhook using its URL.
ZiggeoSdk.Webhooks.destroy(arguments, [callbacks])
Arguments
The analytics resource allows you to access the analytics for the given application
Get analytics for the given params
ZiggeoSdk.Analytics.get(arguments, [callbacks])
Arguments
Copyright (c) 2013-2022 Ziggeo
Apache 2.0 License
FAQs
Ziggeo API (https://ziggeo.com) allows you to integrate video recording and playback with only two lines of code in your site, service or app. This is the NodeJS Server SDK.
The npm package ziggeo receives a total of 351 weekly downloads. As such, ziggeo popularity was classified as not popular.
We found that ziggeo demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
At Node Congress, Socket CEO Feross Aboukhadijeh uncovers the darker aspects of open source, where applications that rely heavily on third-party dependencies can be exploited in supply chain attacks.
Research
Security News
The Socket Research team found this npm package includes code for collecting sensitive developer information, including your operating system username, Git username, and Git email.
Security News
OpenJS is warning of social engineering takeovers targeting open source projects after receiving a credible attempt on the foundation.