Ziggeo 2.19 → 2.21
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +645 -596
- data/lib/Ziggeo.rb +31 -46
- data/lib/classes/ZiggeoConfig.rb +5 -1
- data/lib/classes/ZiggeoConnect.rb +42 -21
- data/lib/classes/ZiggeoEffectProfileProcess.rb +14 -2
- data/lib/classes/ZiggeoStreams.rb +21 -3
- data/lib/classes/ZiggeoVideos.rb +7 -1
- metadata +4 -18
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 2ea85cd0131051bb2cd2423bfc941463b8802084cb8c04121033f10ec57d95c6
|
4
|
+
data.tar.gz: 024b0fb3c5c2e42b0267a1de79a16a47c03ec68505cb202c60aeece5140b8a14
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 54e5514fbed543598e0c07dad155ad2972b04c5ed7998ea6e99bb0046306d8ab86e3ae4789f7b7066aa432f2d8f3a89cffb9e8d9cdb075c4857149c0eeffd6c0
|
7
|
+
data.tar.gz: bc1b79c007b1f22667e100e284c000cb936d1481218ebc92fe64cdef3669402c6abe19cb02456f178aa285f57efd122b29066b0420d9532fd0ae6465afa6d6cd
|
data/README.md
CHANGED
@@ -1,19 +1,128 @@
|
|
1
|
-
# Ziggeo Ruby Server SDK
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
1
|
+
# Ziggeo's Ruby Server SDK
|
2
|
+
|
3
|
+
latest version: **2.21**
|
4
|
+
|
5
|
+
## Index
|
6
|
+
|
7
|
+
1. [Why Ziggeo's Ruby Server Side SDK?](#why-us)
|
8
|
+
2. [Prerequisites](#prerequisites)
|
9
|
+
1. [Download](#download)
|
10
|
+
2. [How to use](#how-to-use)
|
11
|
+
3. [Installation](#install)
|
12
|
+
3. [Client-Side Integration](#codes-client-side)
|
13
|
+
4. [Server-Side Integration](#codes-server-side)
|
14
|
+
1. [Init](#codes-init)
|
15
|
+
2. [Available Methods](#codes-methods)
|
16
|
+
3. [Methods for Videos](#method-videos)
|
17
|
+
1. [Videos Index](#method-videos-index)
|
18
|
+
2. [Videos Count](#method-videos-count)
|
19
|
+
3. [Videos Get](#method-videos-get)
|
20
|
+
4. [Videos Get Bulk](#method-videos-get-bulk)
|
21
|
+
5. [Videos Stats Bulk](#method-videos-stats-bulk)
|
22
|
+
6. [Videos Download Video](#method-videos-download-video)
|
23
|
+
7. [Videos Download Image](#method-videos-download-image)
|
24
|
+
8. [Videos Get Stats](#method-videos-get-stats)
|
25
|
+
9. [Videos Push To Service](#method-videos-push-to-service)
|
26
|
+
10. [Videos Apply Effect](#method-videos-apply-effect)
|
27
|
+
11. [Videos Apply Meta](#method-videos-apply-meta)
|
28
|
+
12. [Videos Update](#method-videos-update)
|
29
|
+
13. [Videos Update Bulk](#method-videos-update-bulk)
|
30
|
+
14. [Videos Delete](#method-videos-delete)
|
31
|
+
15. [Videos Create](#method-videos-create)
|
32
|
+
16. [Videos Analytics](#method-videos-analytics)
|
33
|
+
4. [Methods for Streams](#method-streams)
|
34
|
+
1. [Streams Index](#method-streams-index)
|
35
|
+
2. [Streams Get](#method-streams-get)
|
36
|
+
3. [Streams Download Video](#method-streams-download-video)
|
37
|
+
4. [Streams Download Image](#method-streams-download-image)
|
38
|
+
5. [Streams Push To Service](#method-streams-push-to-service)
|
39
|
+
6. [Streams Delete](#method-streams-delete)
|
40
|
+
7. [Streams Create](#method-streams-create)
|
41
|
+
8. [Streams Attach Image](#method-streams-attach-image)
|
42
|
+
9. [Streams Attach Video](#method-streams-attach-video)
|
43
|
+
10. [Streams Attach Subtitle](#method-streams-attach-subtitle)
|
44
|
+
11. [Streams Bind](#method-streams-bind)
|
45
|
+
5. [Methods for Authtokens](#method-authtokens)
|
46
|
+
1. [Authtokens Get](#method-authtokens-get)
|
47
|
+
2. [Authtokens Update](#method-authtokens-update)
|
48
|
+
3. [Authtokens Delete](#method-authtokens-delete)
|
49
|
+
4. [Authtokens Create](#method-authtokens-create)
|
50
|
+
6. [Methods for Application](#method-application)
|
51
|
+
1. [Application Get](#method-application-get)
|
52
|
+
2. [Application Update](#method-application-update)
|
53
|
+
3. [Application Get Stats](#method-application-get-stats)
|
54
|
+
7. [Methods for Effect Profiles](#method-effect-profiles)
|
55
|
+
1. [Effect Profiles Create](#method-effect-profiles-create)
|
56
|
+
2. [Effect Profiles Index](#method-effect-profiles-index)
|
57
|
+
3. [Effect Profiles Get](#method-effect-profiles-get)
|
58
|
+
4. [Effect Profiles Delete](#method-effect-profiles-delete)
|
59
|
+
5. [Effect Profiles Update](#method-effect-profiles-update)
|
60
|
+
8. [Methods for Effect Profile Process](#method-effect-profile-process)
|
61
|
+
1. [Effect Profile Process Index](#method-effect-profile-process-index)
|
62
|
+
2. [Effect Profile Process Get](#method-effect-profile-process-get)
|
63
|
+
3. [Effect Profile Process Delete](#method-effect-profile-process-delete)
|
64
|
+
4. [Effect Profile Process Create Filter Process](#method-effect-profile-process-create-filter-process)
|
65
|
+
5. [Effect Profile Process Create Watermark Process](#method-effect-profile-process-create-watermark-process)
|
66
|
+
6. [Effect Profile Process Edit Watermark Process](#method-effect-profile-process-edit-watermark-process)
|
67
|
+
9. [Methods for Meta Profiles](#method-meta-profiles)
|
68
|
+
1. [Meta Profiles Create](#method-meta-profiles-create)
|
69
|
+
2. [Meta Profiles Index](#method-meta-profiles-index)
|
70
|
+
3. [Meta Profiles Get](#method-meta-profiles-get)
|
71
|
+
4. [Meta Profiles Delete](#method-meta-profiles-delete)
|
72
|
+
10. [Methods for Meta Profile Process](#method-meta-profile-process)
|
73
|
+
1. [Meta Profile Process Index](#method-meta-profile-process-index)
|
74
|
+
2. [Meta Profile Process Get](#method-meta-profile-process-get)
|
75
|
+
3. [Meta Profile Process Delete](#method-meta-profile-process-delete)
|
76
|
+
4. [Meta Profile Process Create Video Analysis Process](#method-meta-profile-process-create-video-analysis-process)
|
77
|
+
5. [Meta Profile Process Create Audio Transcription Process](#method-meta-profile-process-create-audio-transcription-process)
|
78
|
+
6. [Meta Profile Process Create Nsfw Process](#method-meta-profile-process-create-nsfw-process)
|
79
|
+
11. [Methods for Webhooks](#method-webhooks)
|
80
|
+
1. [Webhooks Create](#method-webhooks-create)
|
81
|
+
2. [Webhooks Confirm](#method-webhooks-confirm)
|
82
|
+
3. [Webhooks Delete](#method-webhooks-delete)
|
83
|
+
12. [Methods for Analytics](#method-analytics)
|
84
|
+
1. [Analytics Get](#method-analytics-get)
|
85
|
+
5. [License](#license)
|
86
|
+
|
87
|
+
|
88
|
+
## Why Ziggeo's Ruby Server Side SDK? <a name="why-us"></a>
|
89
|
+
|
90
|
+
[Ziggeo](https://ziggeo.com) 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.
|
91
|
+
|
92
|
+
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.
|
93
|
+
|
94
|
+
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.
|
95
|
+
|
96
|
+
### Who it is for?
|
97
|
+
|
98
|
+
1. Do you have a system that requires calls to be made which should not be seen on client side?
|
99
|
+
2. Want to have an easier time handling the media as it comes to your server?
|
100
|
+
3. Want something that is simple and easy to use?
|
101
|
+
4. You need some powerful features high end video services provide?
|
102
|
+
|
103
|
+
If any of the above is "Yes" then you are in the right place as this SDK is for you!
|
104
|
+
|
105
|
+
## Prerequisites <a name="prerequisites"></a>
|
106
|
+
|
107
|
+
### Download <a name="download"></a>
|
108
|
+
|
109
|
+
You will want to either download the SDK zip file or to pull it in as git repository into your own project.
|
110
|
+
|
111
|
+
To clone it you would go into your project folder and then
|
112
|
+
```ruby git clone https://github.com/Ziggeo/ZiggeoRubySdk```
|
113
|
+
|
114
|
+
### How to use <a name="how-to-use"></a>
|
115
|
+
|
116
|
+
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.
|
117
|
+
|
118
|
+
|
119
|
+
### Installation<a name="install"></a>
|
10
120
|
|
11
121
|
For Rails applications, you can simply install this repository as a gem.
|
12
122
|
|
13
123
|
gem "Ziggeo"
|
14
124
|
|
15
|
-
|
16
|
-
## Client-Side Integration
|
125
|
+
## Client-Side Integration<a name="codes-client-side"></a>
|
17
126
|
|
18
127
|
For the client-side integration, you need to add these assets to your html file:
|
19
128
|
|
@@ -26,7 +135,9 @@ Then, you need to specify your api token:
|
|
26
135
|
```html
|
27
136
|
<script>
|
28
137
|
var ziggeoApplication = new ZiggeoApi.V2.Application({
|
29
|
-
token: "APPLICATION_TOKEN"
|
138
|
+
token: "APPLICATION_TOKEN",
|
139
|
+
webrtc_streaming_if_necessary: true,
|
140
|
+
webrtc_on_mobile: true
|
30
141
|
});
|
31
142
|
</script>
|
32
143
|
```
|
@@ -45,9 +156,9 @@ To embed a player for an existing video, add:
|
|
45
156
|
|
46
157
|
For the full documentation, please visit [ziggeo.com](https://ziggeo.com/docs).
|
47
158
|
|
159
|
+
## Server-Side Integration<a name="codes-server-side"></a>
|
48
160
|
|
49
|
-
|
50
|
-
## Server-Side Integration
|
161
|
+
### Initialize Ziggeo class in your code<a name="codes-init"></a>
|
51
162
|
|
52
163
|
You can integrate the Server SDK as follows:
|
53
164
|
|
@@ -55,788 +166,726 @@ You can integrate the Server SDK as follows:
|
|
55
166
|
@ziggeo = Ziggeo.new("*token*", "*private_key*", "*encryption_key*")
|
56
167
|
```
|
57
168
|
|
169
|
+
Config is optional and if not specified (recommended), the Config file will be used instead.
|
58
170
|
|
59
|
-
|
171
|
+
### Available Methods<a name="codes-methods"></a>
|
60
172
|
|
61
|
-
|
173
|
+
Currently available methods are branched off within different categories:
|
62
174
|
|
63
|
-
|
64
|
-
|
175
|
+
1.Videos
|
176
|
+
1.Streams
|
177
|
+
1.Authtokens
|
178
|
+
1.Application
|
179
|
+
1.Effect Profiles
|
180
|
+
1.Effect Profile Process
|
181
|
+
1.Meta Profiles
|
182
|
+
1.Meta Profile Process
|
183
|
+
1.Webhooks
|
184
|
+
1.Analytics
|
65
185
|
|
66
|
-
|
67
|
-
|
68
|
-
Query an array of videos (will return at most 50 videos by default). Newest videos come first.
|
186
|
+
Each of this sections has their own actions and they are explained bellow
|
69
187
|
|
70
|
-
```ruby
|
71
|
-
ziggeo.videos().index(arguments = nil)
|
72
|
-
```
|
73
|
-
|
74
|
-
Arguments
|
75
|
-
- limit: *Limit the number of returned videos. Can be set up to 100.*
|
76
|
-
- skip: *Skip the first [n] entries.*
|
77
|
-
- reverse: *Reverse the order in which videos are returned.*
|
78
|
-
- states: *Filter videos by state*
|
79
|
-
- tags: *Filter the search result to certain tags, encoded as a comma-separated string*
|
80
188
|
|
81
189
|
|
82
|
-
|
83
|
-
|
84
|
-
Get the video count for the application.
|
190
|
+
### Videos<a name="method-videos"></a>
|
85
191
|
|
86
|
-
```ruby
|
87
|
-
ziggeo.videos().count(arguments = nil)
|
88
|
-
```
|
89
|
-
|
90
|
-
Arguments
|
91
|
-
- states: *Filter videos by state*
|
92
|
-
- tags: *Filter the search result to certain tags, encoded as a comma-separated string*
|
93
192
|
|
193
|
+
The videos resource allows you to access all single videos. Each video may contain more than one stream.
|
94
194
|
|
95
|
-
####
|
96
|
-
|
97
|
-
Get a single video by token or key.
|
195
|
+
#### Index<a name="method-meta-profile-process-index"></a>
|
98
196
|
|
99
|
-
|
100
|
-
ziggeo.videos().get(token_or_key)
|
101
|
-
```
|
102
|
-
|
197
|
+
Query an array of videos (will return at most 50 videos by default). Newest videos come first.
|
103
198
|
|
199
|
+
```ruby
|
200
|
+
ziggeo.videos().index(arguments = nil)
|
201
|
+
```
|
104
202
|
|
105
|
-
|
106
|
-
|
107
|
-
|
203
|
+
Arguments
|
204
|
+
- limit: *Limit the number of returned videos. Can be set up to 100.*
|
205
|
+
- skip: *Skip the first [n] entries.*
|
206
|
+
- reverse: *Reverse the order in which videos are returned.*
|
207
|
+
- states: *Filter videos by state*
|
208
|
+
- tags: *Filter the search result to certain tags, encoded as a comma-separated string*
|
108
209
|
|
109
|
-
|
110
|
-
ziggeo.videos().get_bulk(arguments = nil)
|
111
|
-
```
|
112
|
-
|
113
|
-
Arguments
|
114
|
-
- tokens_or_keys: *Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).*
|
210
|
+
#### Count<a name="method-videos-count"></a>
|
115
211
|
|
212
|
+
Get the video count for the application.
|
116
213
|
|
117
|
-
|
118
|
-
|
119
|
-
|
214
|
+
```ruby
|
215
|
+
ziggeo.videos().count(arguments = nil)
|
216
|
+
```
|
120
217
|
|
121
|
-
|
122
|
-
|
123
|
-
|
124
|
-
|
125
|
-
Arguments
|
126
|
-
- tokens_or_keys: *Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).*
|
127
|
-
- 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.*
|
218
|
+
Arguments
|
219
|
+
- states: *Filter videos by state*
|
220
|
+
- tags: *Filter the search result to certain tags, encoded as a comma-separated string*
|
128
221
|
|
222
|
+
#### Get<a name="method-analytics-get"></a>
|
129
223
|
|
130
|
-
|
131
|
-
|
132
|
-
Download the video data file
|
224
|
+
Get a single video by token or key.
|
133
225
|
|
134
|
-
```ruby
|
135
|
-
ziggeo.videos().
|
136
|
-
```
|
137
|
-
|
226
|
+
```ruby
|
227
|
+
ziggeo.videos().get(token_or_key)
|
228
|
+
```
|
138
229
|
|
230
|
+
#### Get Bulk<a name="method-videos-get-bulk"></a>
|
139
231
|
|
140
|
-
|
141
|
-
|
142
|
-
Download the image data file
|
232
|
+
Get multiple videos by tokens or keys.
|
143
233
|
|
144
|
-
```ruby
|
145
|
-
ziggeo.videos().
|
146
|
-
```
|
147
|
-
|
234
|
+
```ruby
|
235
|
+
ziggeo.videos().get_bulk(arguments = nil)
|
236
|
+
```
|
148
237
|
|
238
|
+
Arguments
|
239
|
+
- tokens_or_keys: *Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).*
|
149
240
|
|
150
|
-
####
|
151
|
-
|
152
|
-
Get the video's stats
|
241
|
+
#### Stats Bulk<a name="method-videos-stats-bulk"></a>
|
153
242
|
|
154
|
-
|
155
|
-
ziggeo.videos().get_stats(token_or_key)
|
156
|
-
```
|
157
|
-
|
243
|
+
Get stats for multiple videos by tokens or keys.
|
158
244
|
|
245
|
+
```ruby
|
246
|
+
ziggeo.videos().stats_bulk(arguments = nil)
|
247
|
+
```
|
159
248
|
|
160
|
-
|
161
|
-
|
162
|
-
|
249
|
+
Arguments
|
250
|
+
- tokens_or_keys: *Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).*
|
251
|
+
- 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.*
|
163
252
|
|
164
|
-
|
165
|
-
ziggeo.videos().push_to_service(token_or_key, arguments = nil)
|
166
|
-
```
|
167
|
-
|
168
|
-
Arguments
|
169
|
-
- pushservicetoken: *Push Services's token (from the Push Services configured for the app)*
|
253
|
+
#### Download Video<a name="method-streams-download-video"></a>
|
170
254
|
|
255
|
+
Download the video data file
|
171
256
|
|
172
|
-
|
173
|
-
|
174
|
-
|
257
|
+
```ruby
|
258
|
+
ziggeo.videos().download_video(token_or_key)
|
259
|
+
```
|
175
260
|
|
176
|
-
|
177
|
-
ziggeo.videos().apply_effect(token_or_key, arguments = nil)
|
178
|
-
```
|
179
|
-
|
180
|
-
Arguments
|
181
|
-
- effectprofiletoken: *Effect Profile token (from the Effect Profiles configured for the app)*
|
261
|
+
#### Download Image<a name="method-streams-download-image"></a>
|
182
262
|
|
263
|
+
Download the image data file
|
183
264
|
|
184
|
-
|
185
|
-
|
186
|
-
|
265
|
+
```ruby
|
266
|
+
ziggeo.videos().download_image(token_or_key)
|
267
|
+
```
|
187
268
|
|
188
|
-
|
189
|
-
ziggeo.videos().apply_meta(token_or_key, arguments = nil)
|
190
|
-
```
|
191
|
-
|
192
|
-
Arguments
|
193
|
-
- metaprofiletoken: *Meta Profile token (from the Meta Profiles configured for the app)*
|
269
|
+
#### Get Stats<a name="method-application-get-stats"></a>
|
194
270
|
|
271
|
+
Get the video's stats
|
195
272
|
|
196
|
-
|
197
|
-
|
198
|
-
|
273
|
+
```ruby
|
274
|
+
ziggeo.videos().get_stats(token_or_key)
|
275
|
+
```
|
199
276
|
|
200
|
-
|
201
|
-
ziggeo.videos().update(token_or_key, arguments = nil)
|
202
|
-
```
|
203
|
-
|
204
|
-
Arguments
|
205
|
-
- min_duration: *Minimal duration of video*
|
206
|
-
- max_duration: *Maximal duration of video*
|
207
|
-
- tags: *Video Tags*
|
208
|
-
- key: *Unique (optional) name of video*
|
209
|
-
- volatile: *Automatically removed this video if it remains empty*
|
210
|
-
- expiration_days: *After how many days will this video be deleted*
|
211
|
-
- expire_on: *On which date will this video be deleted. String in ISO 8601 format: YYYY-MM-DD*
|
277
|
+
#### Push To Service<a name="method-streams-push-to-service"></a>
|
212
278
|
|
279
|
+
Push a video to a provided push service.
|
213
280
|
|
214
|
-
|
215
|
-
|
216
|
-
|
281
|
+
```ruby
|
282
|
+
ziggeo.videos().push_to_service(token_or_key, arguments = nil)
|
283
|
+
```
|
217
284
|
|
218
|
-
|
219
|
-
|
220
|
-
```
|
221
|
-
|
222
|
-
Arguments
|
223
|
-
- tokens_or_keys: *Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).*
|
224
|
-
- min_duration: *Minimal duration of video*
|
225
|
-
- max_duration: *Maximal duration of video*
|
226
|
-
- tags: *Video Tags*
|
227
|
-
- volatile: *Automatically removed this video if it remains empty*
|
228
|
-
- expiration_days: *After how many days will this video be deleted*
|
229
|
-
- expire_on: *On which date will this video be deleted. String in ISO 8601 format: YYYY-MM-DD*
|
285
|
+
Arguments
|
286
|
+
- pushservicetoken: *Push Services's token (from the Push Services configured for the app)*
|
230
287
|
|
288
|
+
#### Apply Effect<a name="method-videos-apply-effect"></a>
|
231
289
|
|
232
|
-
|
233
|
-
|
234
|
-
Delete a single video by token or key.
|
290
|
+
Apply an effect profile to a video.
|
235
291
|
|
236
|
-
```ruby
|
237
|
-
ziggeo.videos().
|
238
|
-
```
|
239
|
-
|
292
|
+
```ruby
|
293
|
+
ziggeo.videos().apply_effect(token_or_key, arguments = nil)
|
294
|
+
```
|
240
295
|
|
296
|
+
Arguments
|
297
|
+
- effectprofiletoken: *Effect Profile token (from the Effect Profiles configured for the app)*
|
241
298
|
|
242
|
-
####
|
243
|
-
|
244
|
-
Create a new video.
|
299
|
+
#### Apply Meta<a name="method-videos-apply-meta"></a>
|
245
300
|
|
246
|
-
|
247
|
-
ziggeo.videos().create(arguments = nil, file = nil)
|
248
|
-
```
|
249
|
-
|
250
|
-
Arguments
|
251
|
-
- file: *Video file to be uploaded*
|
252
|
-
- min_duration: *Minimal duration of video*
|
253
|
-
- max_duration: *Maximal duration of video*
|
254
|
-
- tags: *Video Tags*
|
255
|
-
- key: *Unique (optional) name of video*
|
256
|
-
- volatile: *Automatically removed this video if it remains empty*
|
301
|
+
Apply a meta profile to a video.
|
257
302
|
|
303
|
+
```ruby
|
304
|
+
ziggeo.videos().apply_meta(token_or_key, arguments = nil)
|
305
|
+
```
|
258
306
|
|
259
|
-
|
260
|
-
|
261
|
-
Get analytics for a specific videos with the given params
|
307
|
+
Arguments
|
308
|
+
- metaprofiletoken: *Meta Profile token (from the Meta Profiles configured for the app)*
|
262
309
|
|
263
|
-
|
264
|
-
ziggeo.videos().analytics(token_or_key, arguments = nil)
|
265
|
-
```
|
266
|
-
|
267
|
-
Arguments
|
268
|
-
- from: *A UNIX timestamp in microseconds used as the start date of the query*
|
269
|
-
- to: *A UNIX timestamp in microseconds used as the end date of the query*
|
270
|
-
- date: *A UNIX timestamp in microseconds to retrieve data from a single date. If set, it overwrites the from and to params.*
|
271
|
-
- 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*
|
310
|
+
#### Update<a name="method-effect-profiles-update"></a>
|
272
311
|
|
312
|
+
Update single video by token or key.
|
273
313
|
|
274
|
-
|
314
|
+
```ruby
|
315
|
+
ziggeo.videos().update(token_or_key, arguments = nil)
|
316
|
+
```
|
275
317
|
|
276
|
-
|
277
|
-
|
318
|
+
Arguments
|
319
|
+
- min_duration: *Minimal duration of video*
|
320
|
+
- max_duration: *Maximal duration of video*
|
321
|
+
- tags: *Video Tags*
|
322
|
+
- key: *Unique (optional) name of video*
|
323
|
+
- volatile: *Automatically removed this video if it remains empty*
|
324
|
+
- expiration_days: *After how many days will this video be deleted*
|
325
|
+
- expire_on: *On which date will this video be deleted. String in ISO 8601 format: YYYY-MM-DD*
|
278
326
|
|
279
|
-
####
|
280
|
-
|
281
|
-
Return all streams associated with a video
|
327
|
+
#### Update Bulk<a name="method-videos-update-bulk"></a>
|
282
328
|
|
283
|
-
|
284
|
-
ziggeo.streams().index(video_token_or_key, arguments = nil)
|
285
|
-
```
|
286
|
-
|
287
|
-
Arguments
|
288
|
-
- states: *Filter streams by state*
|
329
|
+
Update multiple videos by token or key.
|
289
330
|
|
331
|
+
```ruby
|
332
|
+
ziggeo.videos().update_bulk(arguments = nil)
|
333
|
+
```
|
290
334
|
|
291
|
-
|
292
|
-
|
293
|
-
|
335
|
+
Arguments
|
336
|
+
- tokens_or_keys: *Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).*
|
337
|
+
- min_duration: *Minimal duration of video*
|
338
|
+
- max_duration: *Maximal duration of video*
|
339
|
+
- tags: *Video Tags*
|
340
|
+
- volatile: *Automatically removed this video if it remains empty*
|
341
|
+
- expiration_days: *After how many days will this video be deleted*
|
342
|
+
- expire_on: *On which date will this video be deleted. String in ISO 8601 format: YYYY-MM-DD*
|
294
343
|
|
295
|
-
|
296
|
-
ziggeo.streams().get(video_token_or_key, token_or_key)
|
297
|
-
```
|
298
|
-
|
344
|
+
#### Delete<a name="method-webhooks-delete"></a>
|
299
345
|
|
346
|
+
Delete a single video by token or key.
|
300
347
|
|
301
|
-
|
302
|
-
|
303
|
-
|
348
|
+
```ruby
|
349
|
+
ziggeo.videos().delete(token_or_key)
|
350
|
+
```
|
304
351
|
|
305
|
-
|
306
|
-
ziggeo.streams().download_video(video_token_or_key, token_or_key)
|
307
|
-
```
|
308
|
-
|
352
|
+
#### Create<a name="method-webhooks-create"></a>
|
309
353
|
|
354
|
+
Create a new video.
|
310
355
|
|
311
|
-
|
312
|
-
|
313
|
-
|
356
|
+
```ruby
|
357
|
+
ziggeo.videos().create(arguments = nil, file = nil)
|
358
|
+
```
|
314
359
|
|
315
|
-
|
316
|
-
|
317
|
-
|
318
|
-
|
360
|
+
Arguments
|
361
|
+
- file: *Video file to be uploaded*
|
362
|
+
- min_duration: *Minimal duration of video*
|
363
|
+
- max_duration: *Maximal duration of video*
|
364
|
+
- tags: *Video Tags*
|
365
|
+
- key: *Unique (optional) name of video*
|
366
|
+
- volatile: *Automatically removed this video if it remains empty*
|
319
367
|
|
368
|
+
#### Analytics<a name="method-videos-analytics"></a>
|
320
369
|
|
321
|
-
|
322
|
-
|
323
|
-
Push a stream to a provided push service.
|
370
|
+
Get analytics for a specific videos with the given params
|
324
371
|
|
325
|
-
```ruby
|
326
|
-
ziggeo.
|
327
|
-
```
|
328
|
-
|
329
|
-
Arguments
|
330
|
-
- pushservicetoken: *Push Services's token (from the Push Services configured for the app)*
|
372
|
+
```ruby
|
373
|
+
ziggeo.videos().analytics(token_or_key, arguments = nil)
|
374
|
+
```
|
331
375
|
|
376
|
+
Arguments
|
377
|
+
- from: *A UNIX timestamp in microseconds used as the start date of the query*
|
378
|
+
- to: *A UNIX timestamp in microseconds used as the end date of the query*
|
379
|
+
- date: *A UNIX timestamp in microseconds to retrieve data from a single date. If set, it overwrites the from and to params.*
|
380
|
+
- 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*
|
332
381
|
|
333
|
-
|
334
|
-
|
335
|
-
Delete the stream
|
382
|
+
### Streams<a name="method-streams"></a>
|
336
383
|
|
337
|
-
```ruby
|
338
|
-
ziggeo.streams().delete(video_token_or_key, token_or_key)
|
339
|
-
```
|
340
|
-
|
341
384
|
|
385
|
+
The streams resource allows you to directly access all streams associated with a single video.
|
342
386
|
|
343
|
-
####
|
344
|
-
|
345
|
-
Create a new stream
|
387
|
+
#### Index<a name="method-meta-profile-process-index"></a>
|
346
388
|
|
347
|
-
|
348
|
-
ziggeo.streams().create(video_token_or_key, arguments = nil, file = nil)
|
349
|
-
```
|
350
|
-
|
351
|
-
Arguments
|
352
|
-
- file: *Video file to be uploaded*
|
389
|
+
Return all streams associated with a video
|
353
390
|
|
391
|
+
```ruby
|
392
|
+
ziggeo.streams().index(video_token_or_key, arguments = nil)
|
393
|
+
```
|
354
394
|
|
355
|
-
|
356
|
-
|
357
|
-
Attaches an image to a new stream
|
395
|
+
Arguments
|
396
|
+
- states: *Filter streams by state*
|
358
397
|
|
359
|
-
|
360
|
-
ziggeo.streams().attach_image(video_token_or_key, token_or_key, arguments = nil, file = nil)
|
361
|
-
```
|
362
|
-
|
363
|
-
Arguments
|
364
|
-
- file: *Image file to be attached*
|
398
|
+
#### Get<a name="method-analytics-get"></a>
|
365
399
|
|
400
|
+
Get a single stream
|
366
401
|
|
367
|
-
|
368
|
-
|
369
|
-
|
402
|
+
```ruby
|
403
|
+
ziggeo.streams().get(video_token_or_key, token_or_key)
|
404
|
+
```
|
370
405
|
|
371
|
-
|
372
|
-
ziggeo.streams().attach_video(video_token_or_key, token_or_key, arguments = nil, file = nil)
|
373
|
-
```
|
374
|
-
|
375
|
-
Arguments
|
376
|
-
- file: *Video file to be attached*
|
406
|
+
#### Download Video<a name="method-streams-download-video"></a>
|
377
407
|
|
408
|
+
Download the video data associated with the stream
|
378
409
|
|
379
|
-
|
380
|
-
|
381
|
-
|
410
|
+
```ruby
|
411
|
+
ziggeo.streams().download_video(video_token_or_key, token_or_key)
|
412
|
+
```
|
382
413
|
|
383
|
-
|
384
|
-
ziggeo.streams().attach_subtitle(video_token_or_key, token_or_key, arguments = nil)
|
385
|
-
```
|
386
|
-
|
387
|
-
Arguments
|
388
|
-
- lang: *Subtitle language*
|
389
|
-
- label: *Subtitle reference*
|
390
|
-
- data: *Actual subtitle*
|
414
|
+
#### Download Image<a name="method-streams-download-image"></a>
|
391
415
|
|
416
|
+
Download the image data associated with the stream
|
392
417
|
|
393
|
-
|
394
|
-
|
395
|
-
|
418
|
+
```ruby
|
419
|
+
ziggeo.streams().download_image(video_token_or_key, token_or_key)
|
420
|
+
```
|
396
421
|
|
397
|
-
|
398
|
-
ziggeo.streams().bind(video_token_or_key, token_or_key, arguments = nil)
|
399
|
-
```
|
400
|
-
|
422
|
+
#### Push To Service<a name="method-streams-push-to-service"></a>
|
401
423
|
|
424
|
+
Push a stream to a provided push service.
|
402
425
|
|
403
|
-
|
426
|
+
```ruby
|
427
|
+
ziggeo.streams().push_to_service(video_token_or_key, token_or_key, arguments = nil)
|
428
|
+
```
|
404
429
|
|
405
|
-
|
406
|
-
|
430
|
+
Arguments
|
431
|
+
- pushservicetoken: *Push Services's token (from the Push Services configured for the app)*
|
407
432
|
|
408
|
-
####
|
409
|
-
|
410
|
-
Get a single auth token by token.
|
433
|
+
#### Delete<a name="method-webhooks-delete"></a>
|
411
434
|
|
412
|
-
|
413
|
-
ziggeo.authtokens().get(token)
|
414
|
-
```
|
415
|
-
|
435
|
+
Delete the stream
|
416
436
|
|
437
|
+
```ruby
|
438
|
+
ziggeo.streams().delete(video_token_or_key, token_or_key)
|
439
|
+
```
|
417
440
|
|
418
|
-
####
|
419
|
-
|
420
|
-
Update single auth token by token.
|
441
|
+
#### Create<a name="method-webhooks-create"></a>
|
421
442
|
|
422
|
-
|
423
|
-
ziggeo.authtokens().update(token_or_key, arguments = nil)
|
424
|
-
```
|
425
|
-
|
426
|
-
Arguments
|
427
|
-
- volatile: *Will this object automatically be deleted if it remains empty?*
|
428
|
-
- hidden: *If hidden, the token cannot be used directly.*
|
429
|
-
- expiration_date: *Expiration date for the auth token*
|
430
|
-
- usage_experitation_time: *Expiration time per session*
|
431
|
-
- session_limit: *Maximal number of sessions*
|
432
|
-
- grants: *Permissions this tokens grants*
|
443
|
+
Create a new stream
|
433
444
|
|
445
|
+
```ruby
|
446
|
+
ziggeo.streams().create(video_token_or_key, arguments = nil, file = nil)
|
447
|
+
```
|
434
448
|
|
435
|
-
|
436
|
-
|
437
|
-
Delete a single auth token by token.
|
449
|
+
Arguments
|
450
|
+
- file: *Video file to be uploaded*
|
438
451
|
|
439
|
-
|
440
|
-
ziggeo.authtokens().delete(token_or_key)
|
441
|
-
```
|
442
|
-
|
452
|
+
#### Attach Image<a name="method-streams-attach-image"></a>
|
443
453
|
|
454
|
+
Attaches an image to a new stream
|
444
455
|
|
445
|
-
|
446
|
-
|
447
|
-
|
456
|
+
```ruby
|
457
|
+
ziggeo.streams().attach_image(video_token_or_key, token_or_key, arguments = nil, file = nil)
|
458
|
+
```
|
448
459
|
|
449
|
-
|
450
|
-
|
451
|
-
```
|
452
|
-
|
453
|
-
Arguments
|
454
|
-
- volatile: *Will this object automatically be deleted if it remains empty?*
|
455
|
-
- hidden: *If hidden, the token cannot be used directly.*
|
456
|
-
- expiration_date: *Expiration date for the auth token*
|
457
|
-
- usage_experitation_time: *Expiration time per session*
|
458
|
-
- session_limit: *Maximal number of sessions*
|
459
|
-
- grants: *Permissions this tokens grants*
|
460
|
+
Arguments
|
461
|
+
- file: *Image file to be attached*
|
460
462
|
|
463
|
+
#### Attach Video<a name="method-streams-attach-video"></a>
|
461
464
|
|
462
|
-
|
465
|
+
Attaches a video to a new stream
|
463
466
|
|
464
|
-
|
465
|
-
|
467
|
+
```ruby
|
468
|
+
ziggeo.streams().attach_video(video_token_or_key, token_or_key, arguments = nil, file = nil)
|
469
|
+
```
|
466
470
|
|
467
|
-
|
468
|
-
|
469
|
-
Read application.
|
471
|
+
Arguments
|
472
|
+
- file: *Video file to be attached*
|
470
473
|
|
471
|
-
|
472
|
-
ziggeo.application().get()
|
473
|
-
```
|
474
|
-
|
474
|
+
#### Attach Subtitle<a name="method-streams-attach-subtitle"></a>
|
475
475
|
|
476
|
+
Attaches a subtitle to the stream.
|
476
477
|
|
477
|
-
|
478
|
-
|
479
|
-
|
478
|
+
```ruby
|
479
|
+
ziggeo.streams().attach_subtitle(video_token_or_key, token_or_key, arguments = nil)
|
480
|
+
```
|
480
481
|
|
481
|
-
|
482
|
-
|
483
|
-
|
484
|
-
|
485
|
-
Arguments
|
486
|
-
- volatile: *Will this object automatically be deleted if it remains empty?*
|
487
|
-
- name: *Name of the application*
|
488
|
-
- auth_token_required_for_create: *Require auth token for creating videos*
|
489
|
-
- auth_token_required_for_update: *Require auth token for updating videos*
|
490
|
-
- auth_token_required_for_read: *Require auth token for reading videos*
|
491
|
-
- auth_token_required_for_destroy: *Require auth token for deleting videos*
|
492
|
-
- client_can_index_videos: *Client is allowed to perform the index operation*
|
493
|
-
- client_cannot_access_unaccepted_videos: *Client cannot view unaccepted videos*
|
494
|
-
- enable_video_subpages: *Enable hosted video pages*
|
495
|
-
|
496
|
-
|
497
|
-
#### Get Stats
|
498
|
-
|
499
|
-
Read application stats
|
482
|
+
Arguments
|
483
|
+
- lang: *Subtitle language*
|
484
|
+
- label: *Subtitle reference*
|
485
|
+
- data: *Actual subtitle*
|
500
486
|
|
501
|
-
|
502
|
-
ziggeo.application().get_stats(arguments = nil)
|
503
|
-
```
|
504
|
-
|
505
|
-
Arguments
|
506
|
-
- period: *Optional. Can be 'year' or 'month'.*
|
487
|
+
#### Bind<a name="method-streams-bind"></a>
|
507
488
|
|
489
|
+
Closes and submits the stream
|
508
490
|
|
509
|
-
|
491
|
+
```ruby
|
492
|
+
ziggeo.streams().bind(video_token_or_key, token_or_key, arguments = nil)
|
493
|
+
```
|
510
494
|
|
511
|
-
|
512
|
-
|
495
|
+
Arguments
|
513
496
|
|
514
|
-
|
515
|
-
|
516
|
-
Create a new effect profile.
|
497
|
+
### Authtokens<a name="method-authtokens"></a>
|
517
498
|
|
518
|
-
```ruby
|
519
|
-
ziggeo.effectProfiles().create(arguments = nil)
|
520
|
-
```
|
521
|
-
|
522
|
-
Arguments
|
523
|
-
- key: *Effect profile key.*
|
524
|
-
- title: *Effect profile title.*
|
525
|
-
- default_effect: *Boolean. If TRUE, sets an effect profile as default. If FALSE, removes the default status for the given effect*
|
526
499
|
|
500
|
+
The auth token resource allows you to manage authorization settings for video objects.
|
527
501
|
|
528
|
-
####
|
529
|
-
|
530
|
-
Get list of effect profiles.
|
502
|
+
#### Get<a name="method-analytics-get"></a>
|
531
503
|
|
532
|
-
|
533
|
-
ziggeo.effectProfiles().index(arguments = nil)
|
534
|
-
```
|
535
|
-
|
536
|
-
Arguments
|
537
|
-
- limit: *Limit the number of returned effect profiles. Can be set up to 100.*
|
538
|
-
- skip: *Skip the first [n] entries.*
|
539
|
-
- reverse: *Reverse the order in which effect profiles are returned.*
|
504
|
+
Get a single auth token by token.
|
540
505
|
|
506
|
+
```ruby
|
507
|
+
ziggeo.authtokens().get(token)
|
508
|
+
```
|
541
509
|
|
542
|
-
####
|
543
|
-
|
544
|
-
Get a single effect profile
|
510
|
+
#### Update<a name="method-effect-profiles-update"></a>
|
545
511
|
|
546
|
-
|
547
|
-
ziggeo.effectProfiles().get(token_or_key)
|
548
|
-
```
|
549
|
-
|
512
|
+
Update single auth token by token.
|
550
513
|
|
514
|
+
```ruby
|
515
|
+
ziggeo.authtokens().update(token_or_key, arguments = nil)
|
516
|
+
```
|
551
517
|
|
552
|
-
|
553
|
-
|
554
|
-
|
518
|
+
Arguments
|
519
|
+
- volatile: *Will this object automatically be deleted if it remains empty?*
|
520
|
+
- hidden: *If hidden, the token cannot be used directly.*
|
521
|
+
- expiration_date: *Expiration date for the auth token (Unix epoch time format)*
|
522
|
+
- usage_expiration_time: *Expiration time per session (seconds)*
|
523
|
+
- session_limit: *Maximal number of sessions*
|
524
|
+
- grants: *Permissions this tokens grants*
|
555
525
|
|
556
|
-
|
557
|
-
ziggeo.effectProfiles().delete(token_or_key)
|
558
|
-
```
|
559
|
-
|
526
|
+
#### Delete<a name="method-webhooks-delete"></a>
|
560
527
|
|
528
|
+
Delete a single auth token by token.
|
561
529
|
|
562
|
-
|
563
|
-
|
564
|
-
|
530
|
+
```ruby
|
531
|
+
ziggeo.authtokens().delete(token_or_key)
|
532
|
+
```
|
565
533
|
|
566
|
-
|
567
|
-
ziggeo.effectProfiles().update(token_or_key, arguments = nil)
|
568
|
-
```
|
569
|
-
|
570
|
-
Arguments
|
571
|
-
- default_effect: *Boolean. If TRUE, sets an effect profile as default. If FALSE, removes the default status for the given effect*
|
534
|
+
#### Create<a name="method-webhooks-create"></a>
|
572
535
|
|
536
|
+
Create a new auth token.
|
573
537
|
|
574
|
-
|
538
|
+
```ruby
|
539
|
+
ziggeo.authtokens().create(arguments = nil)
|
540
|
+
```
|
575
541
|
|
576
|
-
|
577
|
-
|
542
|
+
Arguments
|
543
|
+
- volatile: *Will this object automatically be deleted if it remains empty?*
|
544
|
+
- hidden: *If hidden, the token cannot be used directly.*
|
545
|
+
- expiration_date: *Expiration date for the auth token (Unix epoch time format)*
|
546
|
+
- usage_expiration_time: *Expiration time per session (seconds)*
|
547
|
+
- session_limit: *Maximal number of sessions*
|
548
|
+
- grants: *Permissions this tokens grants*
|
578
549
|
|
579
|
-
|
580
|
-
|
581
|
-
Return all processes associated with a effect profile
|
550
|
+
### Application<a name="method-application"></a>
|
582
551
|
|
583
|
-
```ruby
|
584
|
-
ziggeo.effectProfileProcess().index(effect_token_or_key, arguments = nil)
|
585
|
-
```
|
586
|
-
|
587
|
-
Arguments
|
588
|
-
- states: *Filter streams by state*
|
589
552
|
|
553
|
+
The application token resource allows you to manage your application.
|
590
554
|
|
591
|
-
#### Get
|
592
|
-
|
593
|
-
Get a single process
|
555
|
+
#### Get<a name="method-analytics-get"></a>
|
594
556
|
|
595
|
-
|
596
|
-
ziggeo.effectProfileProcess().get(effect_token_or_key, token_or_key)
|
597
|
-
```
|
598
|
-
|
557
|
+
Read application.
|
599
558
|
|
559
|
+
```ruby
|
560
|
+
ziggeo.application().get()
|
561
|
+
```
|
600
562
|
|
601
|
-
####
|
602
|
-
|
603
|
-
Delete the process
|
563
|
+
#### Update<a name="method-effect-profiles-update"></a>
|
604
564
|
|
605
|
-
|
606
|
-
ziggeo.effectProfileProcess().delete(effect_token_or_key, token_or_key)
|
607
|
-
```
|
608
|
-
|
565
|
+
Update application.
|
609
566
|
|
567
|
+
```ruby
|
568
|
+
ziggeo.application().update(arguments = nil)
|
569
|
+
```
|
610
570
|
|
611
|
-
|
612
|
-
|
613
|
-
|
571
|
+
Arguments
|
572
|
+
- volatile: *Will this object automatically be deleted if it remains empty?*
|
573
|
+
- name: *Name of the application*
|
574
|
+
- auth_token_required_for_create: *Require auth token for creating videos*
|
575
|
+
- auth_token_required_for_update: *Require auth token for updating videos*
|
576
|
+
- auth_token_required_for_read: *Require auth token for reading videos*
|
577
|
+
- auth_token_required_for_destroy: *Require auth token for deleting videos*
|
578
|
+
- client_can_index_videos: *Client is allowed to perform the index operation*
|
579
|
+
- client_cannot_access_unaccepted_videos: *Client cannot view unaccepted videos*
|
580
|
+
- enable_video_subpages: *Enable hosted video pages*
|
614
581
|
|
615
|
-
|
616
|
-
ziggeo.effectProfileProcess().create_filter_process(effect_token_or_key, arguments = nil)
|
617
|
-
```
|
618
|
-
|
619
|
-
Arguments
|
620
|
-
- effect: *Effect to be applied in the process*
|
582
|
+
#### Get Stats<a name="method-application-get-stats"></a>
|
621
583
|
|
584
|
+
Read application stats
|
622
585
|
|
623
|
-
|
624
|
-
|
625
|
-
|
586
|
+
```ruby
|
587
|
+
ziggeo.application().get_stats(arguments = nil)
|
588
|
+
```
|
626
589
|
|
627
|
-
|
628
|
-
|
629
|
-
```
|
630
|
-
|
631
|
-
Arguments
|
632
|
-
- file: *Image file to be attached*
|
633
|
-
- vertical_position: *Specify the vertical position of your watermark (a value between 0.0 and 1.0)*
|
634
|
-
- horizontal_position: *Specify the horizontal position of your watermark (a value between 0.0 and 1.0)*
|
635
|
-
- video_scale: *Specify the image scale of your watermark (a value between 0.0 and 1.0)*
|
590
|
+
Arguments
|
591
|
+
- period: *Optional. Can be 'year' or 'month'.*
|
636
592
|
|
593
|
+
### Effect Profiles<a name="method-effect-profiles"></a>
|
637
594
|
|
638
|
-
#### Edit Watermark Process
|
639
|
-
|
640
|
-
Edits an existing watermark process.
|
641
595
|
|
642
|
-
|
643
|
-
ziggeo.effectProfileProcess().edit_watermark_process(effect_token_or_key, token_or_key, arguments = nil, file = nil)
|
644
|
-
```
|
645
|
-
|
646
|
-
Arguments
|
647
|
-
- file: *Image file to be attached*
|
648
|
-
- vertical_position: *Specify the vertical position of your watermark (a value between 0.0 and 1.0)*
|
649
|
-
- horizontal_position: *Specify the horizontal position of your watermark (a value between 0.0 and 1.0)*
|
650
|
-
- video_scale: *Specify the image scale of your watermark (a value between 0.0 and 1.0)*
|
596
|
+
The effect profiles resource allows you to access and create effect profiles for your app. Each effect profile may contain one process or more.
|
651
597
|
|
598
|
+
#### Create<a name="method-webhooks-create"></a>
|
652
599
|
|
653
|
-
|
600
|
+
Create a new effect profile.
|
654
601
|
|
655
|
-
|
656
|
-
|
602
|
+
```ruby
|
603
|
+
ziggeo.effectProfiles().create(arguments = nil)
|
604
|
+
```
|
657
605
|
|
658
|
-
|
659
|
-
|
660
|
-
|
606
|
+
Arguments
|
607
|
+
- key: *Effect profile key.*
|
608
|
+
- title: *Effect profile title.*
|
609
|
+
- default_effect: *Boolean. If TRUE, sets an effect profile as default. If FALSE, removes the default status for the given effect*
|
661
610
|
|
662
|
-
|
663
|
-
ziggeo.metaProfiles().create(arguments = nil)
|
664
|
-
```
|
665
|
-
|
666
|
-
Arguments
|
667
|
-
- key: *Meta Profile profile key.*
|
668
|
-
- title: *Meta Profile profile title.*
|
611
|
+
#### Index<a name="method-meta-profile-process-index"></a>
|
669
612
|
|
613
|
+
Get list of effect profiles.
|
670
614
|
|
671
|
-
|
672
|
-
|
673
|
-
|
615
|
+
```ruby
|
616
|
+
ziggeo.effectProfiles().index(arguments = nil)
|
617
|
+
```
|
674
618
|
|
675
|
-
|
676
|
-
|
677
|
-
|
678
|
-
|
679
|
-
Arguments
|
680
|
-
- limit: *Limit the number of returned meta profiles. Can be set up to 100.*
|
681
|
-
- skip: *Skip the first [n] entries.*
|
682
|
-
- reverse: *Reverse the order in which meta profiles are returned.*
|
619
|
+
Arguments
|
620
|
+
- limit: *Limit the number of returned effect profiles. Can be set up to 100.*
|
621
|
+
- skip: *Skip the first [n] entries.*
|
622
|
+
- reverse: *Reverse the order in which effect profiles are returned.*
|
683
623
|
|
624
|
+
#### Get<a name="method-analytics-get"></a>
|
684
625
|
|
685
|
-
|
686
|
-
|
687
|
-
Get a single meta profile
|
626
|
+
Get a single effect profile
|
688
627
|
|
689
|
-
```ruby
|
690
|
-
ziggeo.
|
691
|
-
```
|
692
|
-
|
628
|
+
```ruby
|
629
|
+
ziggeo.effectProfiles().get(token_or_key)
|
630
|
+
```
|
693
631
|
|
632
|
+
#### Delete<a name="method-webhooks-delete"></a>
|
694
633
|
|
695
|
-
|
696
|
-
|
697
|
-
Delete the meta profile
|
634
|
+
Delete the effect profile
|
698
635
|
|
699
|
-
```ruby
|
700
|
-
ziggeo.
|
701
|
-
```
|
702
|
-
|
636
|
+
```ruby
|
637
|
+
ziggeo.effectProfiles().delete(token_or_key)
|
638
|
+
```
|
703
639
|
|
640
|
+
#### Update<a name="method-effect-profiles-update"></a>
|
704
641
|
|
705
|
-
|
642
|
+
Updates an effect profile.
|
706
643
|
|
707
|
-
|
708
|
-
|
644
|
+
```ruby
|
645
|
+
ziggeo.effectProfiles().update(token_or_key, arguments = nil)
|
646
|
+
```
|
709
647
|
|
710
|
-
|
711
|
-
|
712
|
-
Return all processes associated with a meta profile
|
648
|
+
Arguments
|
649
|
+
- default_effect: *Boolean. If TRUE, sets an effect profile as default. If FALSE, removes the default status for the given effect*
|
713
650
|
|
714
|
-
|
715
|
-
ziggeo.metaProfileProcess().index(meta_token_or_key)
|
716
|
-
```
|
717
|
-
|
651
|
+
### Effect Profile Process<a name="method-effect-profile-process"></a>
|
718
652
|
|
719
653
|
|
720
|
-
|
721
|
-
|
722
|
-
Get a single process
|
654
|
+
The process resource allows you to directly access all process associated with a single effect profile.
|
723
655
|
|
724
|
-
|
725
|
-
ziggeo.metaProfileProcess().get(meta_token_or_key, token_or_key)
|
726
|
-
```
|
727
|
-
|
656
|
+
#### Index<a name="method-meta-profile-process-index"></a>
|
728
657
|
|
658
|
+
Return all processes associated with a effect profile
|
729
659
|
|
730
|
-
|
731
|
-
|
732
|
-
|
660
|
+
```ruby
|
661
|
+
ziggeo.effectProfileProcess().index(effect_token_or_key, arguments = nil)
|
662
|
+
```
|
733
663
|
|
734
|
-
|
735
|
-
|
736
|
-
```
|
737
|
-
|
664
|
+
Arguments
|
665
|
+
- states: *Filter streams by state*
|
738
666
|
|
667
|
+
#### Get<a name="method-analytics-get"></a>
|
739
668
|
|
740
|
-
|
741
|
-
|
742
|
-
Create a new video analysis meta process
|
669
|
+
Get a single process
|
743
670
|
|
744
|
-
```ruby
|
745
|
-
ziggeo.
|
746
|
-
```
|
747
|
-
|
671
|
+
```ruby
|
672
|
+
ziggeo.effectProfileProcess().get(effect_token_or_key, token_or_key)
|
673
|
+
```
|
748
674
|
|
675
|
+
#### Delete<a name="method-webhooks-delete"></a>
|
749
676
|
|
750
|
-
|
751
|
-
|
752
|
-
Create a new audio transcription meta process
|
677
|
+
Delete the process
|
753
678
|
|
754
|
-
```ruby
|
755
|
-
ziggeo.
|
756
|
-
```
|
757
|
-
|
679
|
+
```ruby
|
680
|
+
ziggeo.effectProfileProcess().delete(effect_token_or_key, token_or_key)
|
681
|
+
```
|
758
682
|
|
683
|
+
#### Create Filter Process<a name="method-effect-profile-process-create-filter-process"></a>
|
759
684
|
|
760
|
-
|
761
|
-
|
762
|
-
Create a new nsfw filter meta process
|
685
|
+
Create a new filter effect process
|
763
686
|
|
764
|
-
```ruby
|
765
|
-
ziggeo.
|
766
|
-
```
|
767
|
-
|
768
|
-
Arguments
|
769
|
-
- nsfw_action: *One of the following three: approve, reject, nothing.*
|
687
|
+
```ruby
|
688
|
+
ziggeo.effectProfileProcess().create_filter_process(effect_token_or_key, arguments = nil)
|
689
|
+
```
|
770
690
|
|
691
|
+
Arguments
|
692
|
+
- effect: *Effect to be applied in the process*
|
771
693
|
|
772
|
-
|
694
|
+
#### Create Watermark Process<a name="method-effect-profile-process-create-watermark-process"></a>
|
773
695
|
|
774
|
-
|
775
|
-
|
696
|
+
Attaches an image to a new stream
|
776
697
|
|
777
|
-
|
778
|
-
|
779
|
-
|
698
|
+
```ruby
|
699
|
+
ziggeo.effectProfileProcess().create_watermark_process(effect_token_or_key, arguments = nil, file = nil)
|
700
|
+
```
|
780
701
|
|
781
|
-
|
782
|
-
|
783
|
-
|
784
|
-
|
785
|
-
|
786
|
-
- target_url: *The url that will catch the events*
|
787
|
-
- encoding: *Data encoding to be used by the webhook to send the events.*
|
788
|
-
- events: *Comma-separated list of the events the webhook will catch. They must be valid webhook type events.*
|
702
|
+
Arguments
|
703
|
+
- file: *Image file to be attached*
|
704
|
+
- vertical_position: *Specify the vertical position of your watermark (a value between 0.0 and 1.0)*
|
705
|
+
- horizontal_position: *Specify the horizontal position of your watermark (a value between 0.0 and 1.0)*
|
706
|
+
- video_scale: *Specify the image scale of your watermark (a value between 0.0 and 1.0)*
|
789
707
|
|
708
|
+
#### Edit Watermark Process<a name="method-effect-profile-process-edit-watermark-process"></a>
|
790
709
|
|
791
|
-
|
792
|
-
|
793
|
-
Confirm a webhook using its ID and the corresponding validation code.
|
710
|
+
Edits an existing watermark process.
|
794
711
|
|
795
|
-
```ruby
|
796
|
-
ziggeo.
|
797
|
-
```
|
798
|
-
|
799
|
-
Arguments
|
800
|
-
- webhook_id: *Webhook ID that's returned in the creation call.*
|
801
|
-
- validation_code: *Validation code that is sent to the webhook when created.*
|
712
|
+
```ruby
|
713
|
+
ziggeo.effectProfileProcess().edit_watermark_process(effect_token_or_key, token_or_key, arguments = nil, file = nil)
|
714
|
+
```
|
802
715
|
|
716
|
+
Arguments
|
717
|
+
- file: *Image file to be attached*
|
718
|
+
- vertical_position: *Specify the vertical position of your watermark (a value between 0.0 and 1.0)*
|
719
|
+
- horizontal_position: *Specify the horizontal position of your watermark (a value between 0.0 and 1.0)*
|
720
|
+
- video_scale: *Specify the image scale of your watermark (a value between 0.0 and 1.0)*
|
803
721
|
|
804
|
-
|
805
|
-
|
806
|
-
Delete a webhook using its URL.
|
722
|
+
### Meta Profiles<a name="method-meta-profiles"></a>
|
807
723
|
|
808
|
-
```ruby
|
809
|
-
ziggeo.webhooks().delete(arguments = nil)
|
810
|
-
```
|
811
|
-
|
812
|
-
Arguments
|
813
|
-
- target_url: *The url that will catch the events*
|
814
724
|
|
725
|
+
The meta profiles resource allows you to access and create meta profiles for your app. Each meta profile may contain one process or more.
|
815
726
|
|
816
|
-
|
727
|
+
#### Create<a name="method-webhooks-create"></a>
|
817
728
|
|
818
|
-
|
819
|
-
|
729
|
+
Create a new meta profile.
|
820
730
|
|
821
|
-
|
822
|
-
|
823
|
-
|
731
|
+
```ruby
|
732
|
+
ziggeo.metaProfiles().create(arguments = nil)
|
733
|
+
```
|
824
734
|
|
825
|
-
|
826
|
-
|
827
|
-
|
828
|
-
|
829
|
-
|
830
|
-
|
831
|
-
|
832
|
-
|
833
|
-
|
735
|
+
Arguments
|
736
|
+
- key: *Meta Profile profile key.*
|
737
|
+
- title: *Meta Profile profile title.*
|
738
|
+
|
739
|
+
#### Index<a name="method-meta-profile-process-index"></a>
|
740
|
+
|
741
|
+
Get list of meta profiles.
|
742
|
+
|
743
|
+
```ruby
|
744
|
+
ziggeo.metaProfiles().index(arguments = nil)
|
745
|
+
```
|
746
|
+
|
747
|
+
Arguments
|
748
|
+
- limit: *Limit the number of returned meta profiles. Can be set up to 100.*
|
749
|
+
- skip: *Skip the first [n] entries.*
|
750
|
+
- reverse: *Reverse the order in which meta profiles are returned.*
|
751
|
+
|
752
|
+
#### Get<a name="method-analytics-get"></a>
|
753
|
+
|
754
|
+
Get a single meta profile
|
755
|
+
|
756
|
+
```ruby
|
757
|
+
ziggeo.metaProfiles().get(token_or_key)
|
758
|
+
```
|
759
|
+
|
760
|
+
#### Delete<a name="method-webhooks-delete"></a>
|
761
|
+
|
762
|
+
Delete the meta profile
|
763
|
+
|
764
|
+
```ruby
|
765
|
+
ziggeo.metaProfiles().delete(token_or_key)
|
766
|
+
```
|
767
|
+
|
768
|
+
### Meta Profile Process<a name="method-meta-profile-process"></a>
|
769
|
+
|
770
|
+
|
771
|
+
The process resource allows you to directly access all process associated with a single meta profile.
|
772
|
+
|
773
|
+
#### Index<a name="method-meta-profile-process-index"></a>
|
774
|
+
|
775
|
+
Return all processes associated with a meta profile
|
776
|
+
|
777
|
+
```ruby
|
778
|
+
ziggeo.metaProfileProcess().index(meta_token_or_key)
|
779
|
+
```
|
780
|
+
|
781
|
+
#### Get<a name="method-analytics-get"></a>
|
782
|
+
|
783
|
+
Get a single process
|
784
|
+
|
785
|
+
```ruby
|
786
|
+
ziggeo.metaProfileProcess().get(meta_token_or_key, token_or_key)
|
787
|
+
```
|
788
|
+
|
789
|
+
#### Delete<a name="method-webhooks-delete"></a>
|
790
|
+
|
791
|
+
Delete the process
|
792
|
+
|
793
|
+
```ruby
|
794
|
+
ziggeo.metaProfileProcess().delete(meta_token_or_key, token_or_key)
|
795
|
+
```
|
796
|
+
|
797
|
+
#### Create Video Analysis Process<a name="method-meta-profile-process-create-video-analysis-process"></a>
|
798
|
+
|
799
|
+
Create a new video analysis meta process
|
800
|
+
|
801
|
+
```ruby
|
802
|
+
ziggeo.metaProfileProcess().create_video_analysis_process(meta_token_or_key)
|
803
|
+
```
|
804
|
+
|
805
|
+
#### Create Audio Transcription Process<a name="method-meta-profile-process-create-audio-transcription-process"></a>
|
806
|
+
|
807
|
+
Create a new audio transcription meta process
|
808
|
+
|
809
|
+
```ruby
|
810
|
+
ziggeo.metaProfileProcess().create_audio_transcription_process(meta_token_or_key)
|
811
|
+
```
|
812
|
+
|
813
|
+
#### Create Nsfw Process<a name="method-meta-profile-process-create-nsfw-process"></a>
|
814
|
+
|
815
|
+
Create a new nsfw filter meta process
|
816
|
+
|
817
|
+
```ruby
|
818
|
+
ziggeo.metaProfileProcess().create_nsfw_process(meta_token_or_key, arguments = nil)
|
819
|
+
```
|
820
|
+
|
821
|
+
Arguments
|
822
|
+
- nsfw_action: *One of the following three: approve, reject, nothing.*
|
823
|
+
|
824
|
+
### Webhooks<a name="method-webhooks"></a>
|
825
|
+
|
826
|
+
|
827
|
+
The webhooks resource allows you to create or delete webhooks related to a given application.
|
828
|
+
|
829
|
+
#### Create<a name="method-webhooks-create"></a>
|
830
|
+
|
831
|
+
Create a new webhook for the given url to catch the given events.
|
832
|
+
|
833
|
+
```ruby
|
834
|
+
ziggeo.webhooks().create(arguments = nil)
|
835
|
+
```
|
836
|
+
|
837
|
+
Arguments
|
838
|
+
- target_url: *The url that will catch the events*
|
839
|
+
- encoding: *Data encoding to be used by the webhook to send the events.*
|
840
|
+
- events: *Comma-separated list of the events the webhook will catch. They must be valid webhook type events.*
|
841
|
+
|
842
|
+
#### Confirm<a name="method-webhooks-confirm"></a>
|
843
|
+
|
844
|
+
Confirm a webhook using its ID and the corresponding validation code.
|
845
|
+
|
846
|
+
```ruby
|
847
|
+
ziggeo.webhooks().confirm(arguments = nil)
|
848
|
+
```
|
849
|
+
|
850
|
+
Arguments
|
851
|
+
- webhook_id: *Webhook ID that's returned in the creation call.*
|
852
|
+
- validation_code: *Validation code that is sent to the webhook when created.*
|
853
|
+
|
854
|
+
#### Delete<a name="method-webhooks-delete"></a>
|
855
|
+
|
856
|
+
Delete a webhook using its URL.
|
857
|
+
|
858
|
+
```ruby
|
859
|
+
ziggeo.webhooks().delete(arguments = nil)
|
860
|
+
```
|
861
|
+
|
862
|
+
Arguments
|
863
|
+
- target_url: *The url that will catch the events*
|
864
|
+
|
865
|
+
### Analytics<a name="method-analytics"></a>
|
866
|
+
|
867
|
+
|
868
|
+
The analytics resource allows you to access the analytics for the given application
|
869
|
+
|
870
|
+
#### Get<a name="method-analytics-get"></a>
|
871
|
+
|
872
|
+
Get analytics for the given params
|
873
|
+
|
874
|
+
```ruby
|
875
|
+
ziggeo.analytics().get(arguments = nil)
|
876
|
+
```
|
877
|
+
|
878
|
+
Arguments
|
879
|
+
- from: *A UNIX timestamp in microseconds used as the start date of the query*
|
880
|
+
- to: *A UNIX timestamp in microseconds used as the end date of the query*
|
881
|
+
- date: *A UNIX timestamp in microseconds to retrieve data from a single date. If set, it overwrites the from and to params.*
|
882
|
+
- 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*
|
834
883
|
|
835
884
|
|
836
885
|
|
837
886
|
|
838
887
|
|
839
|
-
## License
|
888
|
+
## License <a name="license"></a>
|
840
889
|
|
841
890
|
Copyright (c) 2013-2020 Ziggeo
|
842
891
|
|