README.md

Ziggeo's Ruby Server SDK

latest version: 2.30

Index

1. Why Ziggeo's Ruby Server Side SDK?
2. Prerequisites
   1. Download
   2. How to use
   3. Installation
3. Client-Side Integration
4. Server-Side Integration
   1. Init
   2. Available Methods
   3. Methods for Videos
      1. Videos Index
      2. Videos Count
      3. Videos Get
      4. Videos Get Bulk
      5. Videos Stats Bulk
      6. Videos Download Video
      7. Videos Download Image
      8. Videos Get Stats
      9. Videos Push To Service
      10. Videos Apply Effect
      11. Videos Apply Meta
      12. Videos Update
      13. Videos Update Bulk
      14. Videos Delete
      15. Videos Create
      16. Videos Analytics
   4. Methods for Streams
      1. Streams Index
      2. Streams Get
      3. Streams Download Video
      4. Streams Download Image
      5. Streams Push To Service
      6. Streams Delete
      7. Streams Create
      8. Streams Attach Image
      9. Streams Attach Video
      10. Streams Attach Subtitle
   5. Methods for Audios
      1. Audios Index
      2. Audios Count
      3. Audios Get
      4. Audios Get Bulk
      5. Audios Download Audio
      6. Audios Update
      7. Audios Update Bulk
      8. Audios Delete
      9. Audios Create
   6. Methods for Audio Streams
      1. Audio Streams Index
      2. Audio Streams Get
      3. Audio Streams Download Audio
      4. Audio Streams Delete
      5. Audio Streams Create
   7. Methods for Authtokens
      1. Authtokens Get
      2. Authtokens Update
      3. Authtokens Delete
      4. Authtokens Create
   8. Methods for Application
      1. Application Get
      2. Application Update
      3. Application Get Stats
   9. Methods for Effect Profiles
      1. Effect Profiles Create
      2. Effect Profiles Index
      3. Effect Profiles Get
      4. Effect Profiles Delete
      5. Effect Profiles Update
   10. Methods for Effect Profile Process
       1. Effect Profile Process Index
       2. Effect Profile Process Get
       3. Effect Profile Process Delete
       4. Effect Profile Process Create Filter Process
       5. Effect Profile Process Create Watermark Process
       6. Effect Profile Process Edit Watermark Process
   11. Methods for Meta Profiles
       1. Meta Profiles Create
       2. Meta Profiles Index
       3. Meta Profiles Get
       4. Meta Profiles Delete
   12. Methods for Meta Profile Process
       1. Meta Profile Process Index
       2. Meta Profile Process Get
       3. Meta Profile Process Delete
       4. Meta Profile Process Create Video Analysis Process
       5. Meta Profile Process Create Audio Transcription Process
       6. Meta Profile Process Create Nsfw Process
       7. Meta Profile Process Create Profanity Process
   13. Methods for Webhooks
       1. Webhooks Create
       2. Webhooks Confirm
       3. Webhooks Delete
   14. Methods for Analytics
       1. Analytics Get
5. License

Why Ziggeo's Ruby Server Side SDK?

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.

Who it is for?

1. Do you have a system that requires calls to be made which should not be seen on client side?
2. Want to have an easier time handling the media as it comes to your server?
3. Want something that is simple and easy to use?
4. You need some powerful features high end video services provide?

If any of the above is "Yes" then you are in the right place as this SDK is for you!

Prerequisites

Download

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 ruby git clone https://github.com/Ziggeo/ZiggeoRubySdk

How to use

To start using the Ruby 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.

Installation

For Rails applications, you can simply install this repository as a gem.

gem "Ziggeo"

Client-Side Integration

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.

Server-Side Integration

Initialize Ziggeo class in your code

You can integrate the Server SDK as follows:

@ziggeo = Ziggeo.new("*token*", "*private_key*", "*encryption_key*") 

Config is optional and if not specified (recommended), the Config file will be used instead.

Available Methods

Currently available methods are branched off within different categories:

1. Videos
2. Streams
3. Audios
4. Audio Streams
5. Authtokens
6. Application
7. Effect Profiles
8. Effect Profile Process
9. Meta Profiles
10. Meta Profile Process
11. Webhooks
12. Analytics

Each of this sections has their own actions and they are explained bellow

Videos

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

Index

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

ziggeo.videos().index(arguments = nil)

Arguments

• limit: Limit the number of returned videos. Can be set up to 100.
• skip: Skip the first [n] entries.
• reverse: Reverse the order in which videos are returned.
• states: Filter videos by state
• tags: Filter the search result to certain tags, encoded as a comma-separated string

Count

Get the video count for the application.

ziggeo.videos().count(arguments = nil)

Arguments

• states: Filter videos by state
• tags: Filter the search result to certain tags, encoded as a comma-separated string

Get

Get a single video by token or key.

ziggeo.videos().get(token_or_key)

Get Bulk

Get multiple videos by tokens or keys.

ziggeo.videos().get_bulk(arguments = nil)

Arguments

• tokens_or_keys: Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).

Stats Bulk

Get stats for multiple videos by tokens or keys.

ziggeo.videos().stats_bulk(arguments = nil)

Arguments

• tokens_or_keys: Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).
• summarize: Boolean. Set it to TRUE to get the stats summarized. Set it to FALSE to get the stats for each video in a separate array. Default: TRUE.

Download Video

Download the video data file

ziggeo.videos().download_video(token_or_key)

Download Image

Download the image data file

ziggeo.videos().download_image(token_or_key)

Get Stats

Get the video's stats

ziggeo.videos().get_stats(token_or_key)

Push To Service

Push a video to a provided push service.

ziggeo.videos().push_to_service(token_or_key, arguments = nil)

Arguments

• pushservicetoken: Push Services's token (from the Push Services configured for the app)

Apply Effect

Apply an effect profile to a video.

ziggeo.videos().apply_effect(token_or_key, arguments = nil)

Arguments

• effectprofiletoken: Effect Profile token (from the Effect Profiles configured for the app)

Apply Meta

Apply a meta profile to a video.

ziggeo.videos().apply_meta(token_or_key, arguments = nil)

Arguments

• metaprofiletoken: Meta Profile token (from the Meta Profiles configured for the app)

Update

Update single video by token or key.

ziggeo.videos().update(token_or_key, arguments = nil)

Arguments

• min_duration: Minimal duration of video
• max_duration: Maximal duration of video
• tags: Video Tags
• key: Unique (optional) name of video
• volatile: Automatically removed this video if it remains empty
• expiration_days: After how many days will this video be deleted
• expire_on: On which date will this video be deleted. String in ISO 8601 format: YYYY-MM-DD

Update Bulk

Update multiple videos by token or key.

ziggeo.videos().update_bulk(arguments = nil)

Arguments

• tokens_or_keys: Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).
• min_duration: Minimal duration of video
• max_duration: Maximal duration of video
• tags: Video Tags
• volatile: Automatically removed this video if it remains empty
• expiration_days: After how many days will this video be deleted
• expire_on: On which date will this video be deleted. String in ISO 8601 format: YYYY-MM-DD

Delete

Delete a single video by token or key.

ziggeo.videos().delete(token_or_key)

Create

Create a new video.

ziggeo.videos().create(arguments = nil, file = nil)

Arguments

• file: Video file to be uploaded
• min_duration: Minimal duration of video
• max_duration: Maximal duration of video
• tags: Video Tags
• key: Unique (optional) name of video
• volatile: Automatically removed this video if it remains empty
• effect_profile: Set the effect profile that you want to have applied to your video.
• meta_profile: Set the meta profile that you want to have applied to your video once created.
• video_profile: Set the video profile that you want to have applied to your video as you create it.

Analytics

Get analytics for a specific videos with the given params

ziggeo.videos().analytics(token_or_key, arguments = nil)

Arguments

• from: A UNIX timestamp in microseconds used as the start date of the query
• to: A UNIX timestamp in microseconds used as the end date of the query
• date: A UNIX timestamp in microseconds to retrieve data from a single date. If set, it overwrites the from and to params.
• query: The query you want to run. It can be one of the following: device_views_by_os, device_views_by_date, total_plays_by_country, full_plays_by_country, total_plays_by_hour, full_plays_by_hour, total_plays_by_browser, full_plays_by_browser

Streams

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

Index

Return all streams associated with a video

ziggeo.streams().index(video_token_or_key, arguments = nil)

Arguments

• states: Filter streams by state

Get

Get a single stream

ziggeo.streams().get(video_token_or_key, token_or_key)

Download Video

Download the video data associated with the stream

ziggeo.streams().download_video(video_token_or_key, token_or_key)

Download Image

Download the image data associated with the stream

ziggeo.streams().download_image(video_token_or_key, token_or_key)

Push To Service

Push a stream to a provided push service.

ziggeo.streams().push_to_service(video_token_or_key, token_or_key, arguments = nil)

Arguments

• pushservicetoken: Push Services's token (from the Push Services configured for the app)

Delete

Delete the stream

ziggeo.streams().delete(video_token_or_key, token_or_key)

Create

Create a new stream

ziggeo.streams().create(video_token_or_key, arguments = nil, file = nil)

Arguments

• file: Video file to be uploaded

Attach Image

Attaches an image to a new stream. Must be attached before video, since video upload triggers the transcoding job and binds the stream

ziggeo.streams().attach_image(video_token_or_key, token_or_key, arguments = nil, file = nil)

Arguments

• file: Image file to be attached

Attach Video

Attaches a video to a new stream

ziggeo.streams().attach_video(video_token_or_key, token_or_key, arguments = nil, file = nil)

Arguments

• file: Video file to be attached

Attach Subtitle

Attaches a subtitle to the stream.

ziggeo.streams().attach_subtitle(video_token_or_key, token_or_key, arguments = nil)

Arguments

• lang: Subtitle language
• label: Subtitle reference
• data: Actual subtitle

Audios

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

Index

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

ziggeo.audios().index(arguments = nil)

Arguments

• limit: Limit the number of returned audios. Can be set up to 100.
• skip: Skip the first [n] entries.
• reverse: Reverse the order in which audios are returned.
• states: Filter audios by state
• tags: Filter the search result to certain tags, encoded as a comma-separated string

Count

Get the audio count for the application.

ziggeo.audios().count(arguments = nil)

Arguments

• states: Filter audios by state
• tags: Filter the search result to certain tags, encoded as a comma-separated string

Get

Get a single audio by token or key.

ziggeo.audios().get(token_or_key)

Get Bulk

Get multiple audios by tokens or keys.

ziggeo.audios().get_bulk(arguments = nil)

Arguments

• tokens_or_keys: Comma-separated list with the desired audios tokens or keys (Limit: 100 tokens or keys).

Download Audio

Download the audio data file

ziggeo.audios().download_audio(token_or_key)

Update

Update single audio by token or key.

ziggeo.audios().update(token_or_key, arguments = nil)

Arguments

• min_duration: Minimal duration of audio
• max_duration: Maximal duration of audio
• tags: Audio Tags
• key: Unique (optional) name of audio
• volatile: Automatically removed this audio if it remains empty
• expiration_days: After how many days will this audio be deleted
• expire_on: On which date will this audio be deleted. String in ISO 8601 format: YYYY-MM-DD

Update Bulk

Update multiple audios by token or key.

ziggeo.audios().update_bulk(arguments = nil)

Arguments

• tokens_or_keys: Comma-separated list with the desired audios tokens or keys (Limit: 100 tokens or keys).
• min_duration: Minimal duration of audio
• max_duration: Maximal duration of audio
• tags: Audio Tags
• volatile: Automatically removed this audio if it remains empty
• expiration_days: After how many days will this audio be deleted
• expire_on: On which date will this audio be deleted. String in ISO 8601 format: YYYY-MM-DD

Delete

Delete a single audio by token or key.

ziggeo.audios().delete(token_or_key)

Create

Create a new audio.

ziggeo.audios().create(arguments = nil, file = nil)

Arguments

• file: Audio file to be uploaded
• min_duration: Minimal duration of audio
• max_duration: Maximal duration of audio
• tags: Audio Tags
• key: Unique (optional) name of audio
• volatile: Automatically removed this video if it remains empty

Audio Streams

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

Index

Return all streams associated with a audio

ziggeo.audioStreams().index(audio_token_or_key, arguments = nil)

Arguments

• states: Filter streams by state

Get

Get a single stream

ziggeo.audioStreams().get(audio_token_or_key, token_or_key)

Download Audio

Download the audio data associated with the stream

ziggeo.audioStreams().download_audio(audio_token_or_key, token_or_key)

Delete

Delete the stream

ziggeo.audioStreams().delete(audio_token_or_key, token_or_key)

Create

Create a new stream

ziggeo.audioStreams().create(audio_token_or_key, arguments = nil, file = nil)

Arguments

• file: Audio file to be uploaded

Authtokens

The auth token resource allows you to manage authorization settings for video objects.

Get

Get a single auth token by token.

ziggeo.authtokens().get(token)

Update

Update single auth token by token.

ziggeo.authtokens().update(token_or_key, arguments = nil)

Arguments

• volatile: Will this object automatically be deleted if it remains empty?
• hidden: If hidden, the token cannot be used directly.
• expiration_date: Expiration date for the auth token (Unix epoch time format)
• usage_expiration_time: Expiration time per session (seconds)
• session_limit: Maximal number of sessions
• grants: Permissions this tokens grants

Delete

Delete a single auth token by token.

ziggeo.authtokens().delete(token_or_key)

Create

Create a new auth token.

ziggeo.authtokens().create(arguments = nil)

Arguments

• volatile: Will this object automatically be deleted if it remains empty?
• hidden: If hidden, the token cannot be used directly.
• expiration_date: Expiration date for the auth token (Unix epoch time format)
• usage_expiration_time: Expiration time per session (seconds)
• session_limit: Maximal number of sessions
• grants: Permissions this tokens grants

Application

The application token resource allows you to manage your application.

Get

Read application.

ziggeo.application().get()

Update

Update application.

ziggeo.application().update(arguments = nil)

Arguments

• volatile: Will this object automatically be deleted if it remains empty?
• name: Name of the application
• auth_token_required_for_create: Require auth token for creating videos
• auth_token_required_for_update: Require auth token for updating videos
• auth_token_required_for_read: Require auth token for reading videos
• auth_token_required_for_destroy: Require auth token for deleting videos
• client_can_index_videos: Client is allowed to perform the index operation
• client_cannot_access_unaccepted_videos: Client cannot view unaccepted videos
• enable_video_subpages: Enable hosted video pages

Get Stats

Read application stats

ziggeo.application().get_stats(arguments = nil)

Arguments

• period: Optional. Can be 'year' or 'month'.

Effect Profiles

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

Create a new effect profile.

ziggeo.effectProfiles().create(arguments = nil)

Arguments

• key: Effect profile key.
• title: Effect profile title.
• default_effect: Boolean. If TRUE, sets an effect profile as default. If FALSE, removes the default status for the given effect

Index

Get list of effect profiles.

ziggeo.effectProfiles().index(arguments = nil)

Arguments

• limit: Limit the number of returned effect profiles. Can be set up to 100.
• skip: Skip the first [n] entries.
• reverse: Reverse the order in which effect profiles are returned.

Get

Get a single effect profile

ziggeo.effectProfiles().get(token_or_key)

Delete

Delete the effect profile

ziggeo.effectProfiles().delete(token_or_key)

Update

Updates an effect profile.

ziggeo.effectProfiles().update(token_or_key, arguments = nil)

Arguments

• default_effect: Boolean. If TRUE, sets an effect profile as default. If FALSE, removes the default status for the given effect

Effect Profile Process

The process resource allows you to directly access all process associated with a single effect profile.

Index

Return all processes associated with a effect profile

ziggeo.effectProfileProcess().index(effect_token_or_key, arguments = nil)

Arguments

• states: Filter streams by state

Get

Get a single process

ziggeo.effectProfileProcess().get(effect_token_or_key, token_or_key)

Delete

Delete the process

ziggeo.effectProfileProcess().delete(effect_token_or_key, token_or_key)

Create Filter Process

Create a new filter effect process

ziggeo.effectProfileProcess().create_filter_process(effect_token_or_key, arguments = nil)

Arguments

• effect: Effect to be applied in the process

Create Watermark Process

Attaches an image to a new stream

ziggeo.effectProfileProcess().create_watermark_process(effect_token_or_key, arguments = nil, file = nil)

Arguments

• file: Image file to be attached
• vertical_position: Specify the vertical position of your watermark (a value between 0.0 and 1.0)
• horizontal_position: Specify the horizontal position of your watermark (a value between 0.0 and 1.0)
• video_scale: Specify the image scale of your watermark (a value between 0.0 and 1.0)

Edit Watermark Process

Edits an existing watermark process.

ziggeo.effectProfileProcess().edit_watermark_process(effect_token_or_key, token_or_key, arguments = nil, file = nil)

Arguments

• file: Image file to be attached
• vertical_position: Specify the vertical position of your watermark (a value between 0.0 and 1.0)
• horizontal_position: Specify the horizontal position of your watermark (a value between 0.0 and 1.0)
• video_scale: Specify the image scale of your watermark (a value between 0.0 and 1.0)

Meta Profiles

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

Create a new meta profile.

ziggeo.metaProfiles().create(arguments = nil)

Arguments

• key: Meta Profile profile key.
• title: Meta Profile profile title.

Index

Get list of meta profiles.

ziggeo.metaProfiles().index(arguments = nil)

Arguments

• limit: Limit the number of returned meta profiles. Can be set up to 100.
• skip: Skip the first [n] entries.
• reverse: Reverse the order in which meta profiles are returned.

Get

Get a single meta profile

ziggeo.metaProfiles().get(token_or_key)

Delete

Delete the meta profile

ziggeo.metaProfiles().delete(token_or_key)

Meta Profile Process

The process resource allows you to directly access all process associated with a single meta profile.

Index

Return all processes associated with a meta profile

ziggeo.metaProfileProcess().index(meta_token_or_key)

Get

Get a single process

ziggeo.metaProfileProcess().get(meta_token_or_key, token_or_key)

Delete

Delete the process

ziggeo.metaProfileProcess().delete(meta_token_or_key, token_or_key)

Create Video Analysis Process

Create a new video analysis meta process

ziggeo.metaProfileProcess().create_video_analysis_process(meta_token_or_key)

Create Audio Transcription Process

Create a new audio transcription meta process

ziggeo.metaProfileProcess().create_audio_transcription_process(meta_token_or_key)

Create Nsfw Process

Create a new nsfw filter meta process

ziggeo.metaProfileProcess().create_nsfw_process(meta_token_or_key, arguments = nil)

Arguments

• nsfw_action: One of the following three: approve, reject, nothing.

Create Profanity Process

Create a new profanity filter meta process

ziggeo.metaProfileProcess().create_profanity_process(meta_token_or_key, arguments = nil)

Arguments

• profanity_action: One of the following three: approve, reject, nothing.

Webhooks

The webhooks resource allows you to create or delete webhooks related to a given application.

Create

Create a new webhook for the given url to catch the given events.

ziggeo.webhooks().create(arguments = nil)

Arguments

• target_url: The url that will catch the events
• encoding: Data encoding to be used by the webhook to send the events.
• events: Comma-separated list of the events the webhook will catch. They must be valid webhook type events.

Confirm

Confirm a webhook using its ID and the corresponding validation code.

ziggeo.webhooks().confirm(arguments = nil)

Arguments

• webhook_id: Webhook ID that's returned in the creation call.
• validation_code: Validation code that is sent to the webhook when created.

Delete

Delete a webhook using its URL.

ziggeo.webhooks().delete(arguments = nil)

Arguments

• target_url: The url that will catch the events

Analytics

The analytics resource allows you to access the analytics for the given application

Get

Get analytics for the given params

ziggeo.analytics().get(arguments = nil)

Arguments

• from: A UNIX timestamp in microseconds used as the start date of the query
• to: A UNIX timestamp in microseconds used as the end date of the query
• date: A UNIX timestamp in microseconds to retrieve data from a single date. If set, it overwrites the from and to params.
• query: The query you want to run. It can be one of the following: device_views_by_os, device_views_by_date, total_plays_by_country, full_plays_by_country, total_plays_by_hour, full_plays_by_hour, total_plays_by_browser, full_plays_by_browser

License

Copyright (c) 2013-2022 Ziggeo

Apache 2.0 License