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