Ziggeo 2.16 → 2.24
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +5 -5
- data/README.md +667 -572
- data/lib/Ziggeo.rb +42 -46
- data/lib/classes/ZiggeoConfig.rb +7 -3
- data/lib/classes/ZiggeoConnect.rb +50 -20
- data/lib/classes/ZiggeoEffectProfileProcess.rb +17 -1
- data/lib/classes/ZiggeoMetaProfileProcess.rb +4 -0
- data/lib/classes/ZiggeoStreams.rb +25 -3
- data/lib/classes/ZiggeoVideos.rb +7 -1
- metadata +5 -20
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 6c62727eb19a64dc7890312fc3d406e009763979518b96e3849d4c557b9f4086
|
4
|
+
data.tar.gz: d6883d1fae3b1bafdb7e04641d6768a8ee805d134a6765b04a7973fd67590f36
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ecb7148b82720bffd59e8c434062c5e7dbde22c3360ca2d771254df1b2ebe2df1fb10531f92e8836ff33ce299d13b93a9a662e12222b6a971bfe2fdccdc9ad89
|
7
|
+
data.tar.gz: 58acdd9d5335efd7a0d0ff19b4eca4d7de9a3db92712f5377a1f369482a10590cf09f169c7cc4af3d17ad23fc29e62def596e2f0a0bf926e29adc1bcd38a0100
|
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.24**
|
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,758 +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*
|
278
|
+
#### Push To Service<a name="method-videos-push-to-service"></a>
|
211
279
|
|
280
|
+
Push a video to a provided push service.
|
212
281
|
|
213
|
-
|
214
|
-
|
215
|
-
|
282
|
+
```ruby
|
283
|
+
ziggeo.videos().push_to_service(token_or_key, arguments = nil)
|
284
|
+
```
|
216
285
|
|
217
|
-
|
218
|
-
|
219
|
-
```
|
220
|
-
|
221
|
-
Arguments
|
222
|
-
- tokens_or_keys: *Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).*
|
223
|
-
- min_duration: *Minimal duration of video*
|
224
|
-
- max_duration: *Maximal duration of video*
|
225
|
-
- tags: *Video Tags*
|
226
|
-
- volatile: *Automatically removed this video if it remains empty*
|
227
|
-
- expiration_days: *After how many days will this video be deleted*
|
286
|
+
Arguments
|
287
|
+
- pushservicetoken: *Push Services's token (from the Push Services configured for the app)*
|
228
288
|
|
289
|
+
#### Apply Effect<a name="method-videos-apply-effect"></a>
|
229
290
|
|
230
|
-
|
231
|
-
|
232
|
-
Delete a single video by token or key.
|
291
|
+
Apply an effect profile to a video.
|
233
292
|
|
234
|
-
```ruby
|
235
|
-
ziggeo.videos().
|
236
|
-
```
|
237
|
-
|
293
|
+
```ruby
|
294
|
+
ziggeo.videos().apply_effect(token_or_key, arguments = nil)
|
295
|
+
```
|
238
296
|
|
297
|
+
Arguments
|
298
|
+
- effectprofiletoken: *Effect Profile token (from the Effect Profiles configured for the app)*
|
239
299
|
|
240
|
-
####
|
241
|
-
|
242
|
-
Create a new video.
|
300
|
+
#### Apply Meta<a name="method-videos-apply-meta"></a>
|
243
301
|
|
244
|
-
|
245
|
-
ziggeo.videos().create(arguments = nil, file = nil)
|
246
|
-
```
|
247
|
-
|
248
|
-
Arguments
|
249
|
-
- file: *Video file to be uploaded*
|
250
|
-
- min_duration: *Minimal duration of video*
|
251
|
-
- max_duration: *Maximal duration of video*
|
252
|
-
- tags: *Video Tags*
|
253
|
-
- key: *Unique (optional) name of video*
|
254
|
-
- volatile: *Automatically removed this video if it remains empty*
|
302
|
+
Apply a meta profile to a video.
|
255
303
|
|
304
|
+
```ruby
|
305
|
+
ziggeo.videos().apply_meta(token_or_key, arguments = nil)
|
306
|
+
```
|
256
307
|
|
257
|
-
|
258
|
-
|
259
|
-
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)*
|
260
310
|
|
261
|
-
|
262
|
-
ziggeo.videos().analytics(token_or_key, arguments = nil)
|
263
|
-
```
|
264
|
-
|
265
|
-
Arguments
|
266
|
-
- from: *A UNIX timestamp in microseconds used as the start date of the query*
|
267
|
-
- to: *A UNIX timestamp in microseconds used as the end date of the query*
|
268
|
-
- date: *A UNIX timestamp in microseconds to retrieve data from a single date. If set, it overwrites the from and to params.*
|
269
|
-
- 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>
|
270
312
|
|
313
|
+
Update single video by token or key.
|
271
314
|
|
272
|
-
|
315
|
+
```ruby
|
316
|
+
ziggeo.videos().update(token_or_key, arguments = nil)
|
317
|
+
```
|
273
318
|
|
274
|
-
|
275
|
-
|
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*
|
276
327
|
|
277
|
-
####
|
278
|
-
|
279
|
-
Return all streams associated with a video
|
328
|
+
#### Update Bulk<a name="method-videos-update-bulk"></a>
|
280
329
|
|
281
|
-
|
282
|
-
ziggeo.streams().index(video_token_or_key, arguments = nil)
|
283
|
-
```
|
284
|
-
|
285
|
-
Arguments
|
286
|
-
- states: *Filter streams by state*
|
330
|
+
Update multiple videos by token or key.
|
287
331
|
|
332
|
+
```ruby
|
333
|
+
ziggeo.videos().update_bulk(arguments = nil)
|
334
|
+
```
|
288
335
|
|
289
|
-
|
290
|
-
|
291
|
-
|
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*
|
292
344
|
|
293
|
-
|
294
|
-
ziggeo.streams().get(video_token_or_key, token_or_key)
|
295
|
-
```
|
296
|
-
|
345
|
+
#### Delete<a name="method-videos-delete"></a>
|
297
346
|
|
347
|
+
Delete a single video by token or key.
|
298
348
|
|
299
|
-
|
300
|
-
|
301
|
-
|
349
|
+
```ruby
|
350
|
+
ziggeo.videos().delete(token_or_key)
|
351
|
+
```
|
302
352
|
|
303
|
-
|
304
|
-
ziggeo.streams().download_video(video_token_or_key, token_or_key)
|
305
|
-
```
|
306
|
-
|
353
|
+
#### Create<a name="method-videos-create"></a>
|
307
354
|
|
355
|
+
Create a new video.
|
308
356
|
|
309
|
-
|
310
|
-
|
311
|
-
|
357
|
+
```ruby
|
358
|
+
ziggeo.videos().create(arguments = nil, file = nil)
|
359
|
+
```
|
312
360
|
|
313
|
-
|
314
|
-
|
315
|
-
|
316
|
-
|
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.*
|
317
371
|
|
372
|
+
#### Analytics<a name="method-videos-analytics"></a>
|
318
373
|
|
319
|
-
|
320
|
-
|
321
|
-
Push a stream to a provided push service.
|
374
|
+
Get analytics for a specific videos with the given params
|
322
375
|
|
323
|
-
```ruby
|
324
|
-
ziggeo.
|
325
|
-
```
|
326
|
-
|
327
|
-
Arguments
|
328
|
-
- 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
|
+
```
|
329
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*
|
330
385
|
|
331
|
-
|
332
|
-
|
333
|
-
Delete the stream
|
386
|
+
### Streams<a name="method-streams"></a>
|
334
387
|
|
335
|
-
```ruby
|
336
|
-
ziggeo.streams().delete(video_token_or_key, token_or_key)
|
337
|
-
```
|
338
|
-
|
339
388
|
|
389
|
+
The streams resource allows you to directly access all streams associated with a single video.
|
340
390
|
|
341
|
-
####
|
342
|
-
|
343
|
-
Create a new stream
|
391
|
+
#### Index<a name="method-streams-index"></a>
|
344
392
|
|
345
|
-
|
346
|
-
ziggeo.streams().create(video_token_or_key, arguments = nil, file = nil)
|
347
|
-
```
|
348
|
-
|
349
|
-
Arguments
|
350
|
-
- file: *Video file to be uploaded*
|
393
|
+
Return all streams associated with a video
|
351
394
|
|
395
|
+
```ruby
|
396
|
+
ziggeo.streams().index(video_token_or_key, arguments = nil)
|
397
|
+
```
|
352
398
|
|
353
|
-
|
354
|
-
|
355
|
-
Attaches an image to a new stream
|
399
|
+
Arguments
|
400
|
+
- states: *Filter streams by state*
|
356
401
|
|
357
|
-
|
358
|
-
ziggeo.streams().attach_image(video_token_or_key, token_or_key, arguments = nil, file = nil)
|
359
|
-
```
|
360
|
-
|
361
|
-
Arguments
|
362
|
-
- file: *Image file to be attached*
|
402
|
+
#### Get<a name="method-streams-get"></a>
|
363
403
|
|
404
|
+
Get a single stream
|
364
405
|
|
365
|
-
|
366
|
-
|
367
|
-
|
406
|
+
```ruby
|
407
|
+
ziggeo.streams().get(video_token_or_key, token_or_key)
|
408
|
+
```
|
368
409
|
|
369
|
-
|
370
|
-
ziggeo.streams().attach_video(video_token_or_key, token_or_key, arguments = nil, file = nil)
|
371
|
-
```
|
372
|
-
|
373
|
-
Arguments
|
374
|
-
- file: *Video file to be attached*
|
410
|
+
#### Download Video<a name="method-streams-download-video"></a>
|
375
411
|
|
412
|
+
Download the video data associated with the stream
|
376
413
|
|
377
|
-
|
378
|
-
|
379
|
-
|
414
|
+
```ruby
|
415
|
+
ziggeo.streams().download_video(video_token_or_key, token_or_key)
|
416
|
+
```
|
380
417
|
|
381
|
-
|
382
|
-
ziggeo.streams().bind(video_token_or_key, token_or_key, arguments = nil)
|
383
|
-
```
|
384
|
-
|
418
|
+
#### Download Image<a name="method-streams-download-image"></a>
|
385
419
|
|
420
|
+
Download the image data associated with the stream
|
386
421
|
|
387
|
-
|
422
|
+
```ruby
|
423
|
+
ziggeo.streams().download_image(video_token_or_key, token_or_key)
|
424
|
+
```
|
388
425
|
|
389
|
-
|
390
|
-
|
426
|
+
#### Push To Service<a name="method-streams-push-to-service"></a>
|
391
427
|
|
392
|
-
|
393
|
-
|
394
|
-
Get a single auth token by token.
|
428
|
+
Push a stream to a provided push service.
|
395
429
|
|
396
|
-
```ruby
|
397
|
-
ziggeo.
|
398
|
-
```
|
399
|
-
|
430
|
+
```ruby
|
431
|
+
ziggeo.streams().push_to_service(video_token_or_key, token_or_key, arguments = nil)
|
432
|
+
```
|
400
433
|
|
434
|
+
Arguments
|
435
|
+
- pushservicetoken: *Push Services's token (from the Push Services configured for the app)*
|
401
436
|
|
402
|
-
####
|
403
|
-
|
404
|
-
Update single auth token by token.
|
437
|
+
#### Delete<a name="method-streams-delete"></a>
|
405
438
|
|
406
|
-
|
407
|
-
ziggeo.authtokens().update(token_or_key, arguments = nil)
|
408
|
-
```
|
409
|
-
|
410
|
-
Arguments
|
411
|
-
- volatile: *Will this object automatically be deleted if it remains empty?*
|
412
|
-
- hidden: *If hidden, the token cannot be used directly.*
|
413
|
-
- expiration_date: *Expiration date for the auth token*
|
414
|
-
- usage_experitation_time: *Expiration time per session*
|
415
|
-
- session_limit: *Maximal number of sessions*
|
416
|
-
- grants: *Permissions this tokens grants*
|
439
|
+
Delete the stream
|
417
440
|
|
441
|
+
```ruby
|
442
|
+
ziggeo.streams().delete(video_token_or_key, token_or_key)
|
443
|
+
```
|
418
444
|
|
419
|
-
####
|
420
|
-
|
421
|
-
Delete a single auth token by token.
|
445
|
+
#### Create<a name="method-streams-create"></a>
|
422
446
|
|
423
|
-
|
424
|
-
ziggeo.authtokens().delete(token_or_key)
|
425
|
-
```
|
426
|
-
|
447
|
+
Create a new stream
|
427
448
|
|
449
|
+
```ruby
|
450
|
+
ziggeo.streams().create(video_token_or_key, arguments = nil, file = nil)
|
451
|
+
```
|
428
452
|
|
429
|
-
|
430
|
-
|
431
|
-
Create a new auth token.
|
453
|
+
Arguments
|
454
|
+
- file: *Video file to be uploaded*
|
432
455
|
|
433
|
-
|
434
|
-
ziggeo.authtokens().create(arguments = nil)
|
435
|
-
```
|
436
|
-
|
437
|
-
Arguments
|
438
|
-
- volatile: *Will this object automatically be deleted if it remains empty?*
|
439
|
-
- hidden: *If hidden, the token cannot be used directly.*
|
440
|
-
- expiration_date: *Expiration date for the auth token*
|
441
|
-
- usage_experitation_time: *Expiration time per session*
|
442
|
-
- session_limit: *Maximal number of sessions*
|
443
|
-
- grants: *Permissions this tokens grants*
|
456
|
+
#### Attach Image<a name="method-streams-attach-image"></a>
|
444
457
|
|
458
|
+
Attaches an image to a new stream
|
445
459
|
|
446
|
-
|
460
|
+
```ruby
|
461
|
+
ziggeo.streams().attach_image(video_token_or_key, token_or_key, arguments = nil, file = nil)
|
462
|
+
```
|
447
463
|
|
448
|
-
|
449
|
-
|
464
|
+
Arguments
|
465
|
+
- file: *Image file to be attached*
|
450
466
|
|
451
|
-
####
|
452
|
-
|
453
|
-
Read application.
|
467
|
+
#### Attach Video<a name="method-streams-attach-video"></a>
|
454
468
|
|
455
|
-
|
456
|
-
ziggeo.application().get()
|
457
|
-
```
|
458
|
-
|
469
|
+
Attaches a video to a new stream
|
459
470
|
|
471
|
+
```ruby
|
472
|
+
ziggeo.streams().attach_video(video_token_or_key, token_or_key, arguments = nil, file = nil)
|
473
|
+
```
|
460
474
|
|
461
|
-
|
462
|
-
|
463
|
-
Update application.
|
475
|
+
Arguments
|
476
|
+
- file: *Video file to be attached*
|
464
477
|
|
465
|
-
|
466
|
-
ziggeo.application().update(arguments = nil)
|
467
|
-
```
|
468
|
-
|
469
|
-
Arguments
|
470
|
-
- volatile: *Will this object automatically be deleted if it remains empty?*
|
471
|
-
- name: *Name of the application*
|
472
|
-
- auth_token_required_for_create: *Require auth token for creating videos*
|
473
|
-
- auth_token_required_for_update: *Require auth token for updating videos*
|
474
|
-
- auth_token_required_for_read: *Require auth token for reading videos*
|
475
|
-
- auth_token_required_for_destroy: *Require auth token for deleting videos*
|
476
|
-
- client_can_index_videos: *Client is allowed to perform the index operation*
|
477
|
-
- client_cannot_access_unaccepted_videos: *Client cannot view unaccepted videos*
|
478
|
-
- enable_video_subpages: *Enable hosted video pages*
|
479
|
-
|
480
|
-
|
481
|
-
#### Get Stats
|
482
|
-
|
483
|
-
Read application stats
|
478
|
+
#### Attach Subtitle<a name="method-streams-attach-subtitle"></a>
|
484
479
|
|
485
|
-
|
486
|
-
ziggeo.application().get_stats(arguments = nil)
|
487
|
-
```
|
488
|
-
|
489
|
-
Arguments
|
490
|
-
- period: *Optional. Can be 'year' or 'month'.*
|
480
|
+
Attaches a subtitle to the stream.
|
491
481
|
|
482
|
+
```ruby
|
483
|
+
ziggeo.streams().attach_subtitle(video_token_or_key, token_or_key, arguments = nil)
|
484
|
+
```
|
492
485
|
|
493
|
-
|
486
|
+
Arguments
|
487
|
+
- lang: *Subtitle language*
|
488
|
+
- label: *Subtitle reference*
|
489
|
+
- data: *Actual subtitle*
|
494
490
|
|
495
|
-
|
496
|
-
|
491
|
+
#### Bind<a name="method-streams-bind"></a>
|
497
492
|
|
498
|
-
|
499
|
-
|
500
|
-
Create a new effect profile.
|
493
|
+
Closes and submits the stream
|
501
494
|
|
502
|
-
```ruby
|
503
|
-
ziggeo.
|
504
|
-
```
|
505
|
-
|
506
|
-
Arguments
|
507
|
-
- key: *Effect profile key.*
|
508
|
-
- title: *Effect profile title.*
|
509
|
-
- default_effect: *Boolean. If TRUE, sets an effect profile as default. If FALSE, removes the default status for the given effect*
|
495
|
+
```ruby
|
496
|
+
ziggeo.streams().bind(video_token_or_key, token_or_key, arguments = nil)
|
497
|
+
```
|
510
498
|
|
499
|
+
Arguments
|
511
500
|
|
512
|
-
|
513
|
-
|
514
|
-
Get list of effect profiles.
|
501
|
+
### Authtokens<a name="method-authtokens"></a>
|
515
502
|
|
516
|
-
```ruby
|
517
|
-
ziggeo.effectProfiles().index(arguments = nil)
|
518
|
-
```
|
519
|
-
|
520
|
-
Arguments
|
521
|
-
- limit: *Limit the number of returned effect profiles. Can be set up to 100.*
|
522
|
-
- skip: *Skip the first [n] entries.*
|
523
|
-
- reverse: *Reverse the order in which effect profiles are returned.*
|
524
503
|
|
504
|
+
The auth token resource allows you to manage authorization settings for video objects.
|
525
505
|
|
526
|
-
#### Get
|
527
|
-
|
528
|
-
Get a single effect profile
|
506
|
+
#### Get<a name="method-authtokens-get"></a>
|
529
507
|
|
530
|
-
|
531
|
-
ziggeo.effectProfiles().get(token_or_key)
|
532
|
-
```
|
533
|
-
|
508
|
+
Get a single auth token by token.
|
534
509
|
|
510
|
+
```ruby
|
511
|
+
ziggeo.authtokens().get(token)
|
512
|
+
```
|
535
513
|
|
536
|
-
####
|
537
|
-
|
538
|
-
Delete the effect profile
|
514
|
+
#### Update<a name="method-authtokens-update"></a>
|
539
515
|
|
540
|
-
|
541
|
-
ziggeo.effectProfiles().delete(token_or_key)
|
542
|
-
```
|
543
|
-
|
516
|
+
Update single auth token by token.
|
544
517
|
|
518
|
+
```ruby
|
519
|
+
ziggeo.authtokens().update(token_or_key, arguments = nil)
|
520
|
+
```
|
545
521
|
|
546
|
-
|
547
|
-
|
548
|
-
|
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*
|
549
529
|
|
550
|
-
|
551
|
-
ziggeo.effectProfiles().update(token_or_key, arguments = nil)
|
552
|
-
```
|
553
|
-
|
554
|
-
Arguments
|
555
|
-
- default_effect: *Boolean. If TRUE, sets an effect profile as default. If FALSE, removes the default status for the given effect*
|
530
|
+
#### Delete<a name="method-authtokens-delete"></a>
|
556
531
|
|
532
|
+
Delete a single auth token by token.
|
557
533
|
|
558
|
-
|
534
|
+
```ruby
|
535
|
+
ziggeo.authtokens().delete(token_or_key)
|
536
|
+
```
|
559
537
|
|
560
|
-
|
561
|
-
|
538
|
+
#### Create<a name="method-authtokens-create"></a>
|
562
539
|
|
563
|
-
|
564
|
-
|
565
|
-
Return all processes associated with a effect profile
|
540
|
+
Create a new auth token.
|
566
541
|
|
567
|
-
```ruby
|
568
|
-
ziggeo.
|
569
|
-
```
|
570
|
-
|
571
|
-
Arguments
|
572
|
-
- states: *Filter streams by state*
|
542
|
+
```ruby
|
543
|
+
ziggeo.authtokens().create(arguments = nil)
|
544
|
+
```
|
573
545
|
|
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*
|
574
553
|
|
575
|
-
|
576
|
-
|
577
|
-
Get a single process
|
554
|
+
### Application<a name="method-application"></a>
|
578
555
|
|
579
|
-
```ruby
|
580
|
-
ziggeo.effectProfileProcess().get(effect_token_or_key, token_or_key)
|
581
|
-
```
|
582
|
-
|
583
556
|
|
557
|
+
The application token resource allows you to manage your application.
|
584
558
|
|
585
|
-
####
|
586
|
-
|
587
|
-
Delete the process
|
559
|
+
#### Get<a name="method-application-get"></a>
|
588
560
|
|
589
|
-
|
590
|
-
ziggeo.effectProfileProcess().delete(effect_token_or_key, token_or_key)
|
591
|
-
```
|
592
|
-
|
561
|
+
Read application.
|
593
562
|
|
563
|
+
```ruby
|
564
|
+
ziggeo.application().get()
|
565
|
+
```
|
594
566
|
|
595
|
-
####
|
596
|
-
|
597
|
-
Create a new filter effect process
|
567
|
+
#### Update<a name="method-application-update"></a>
|
598
568
|
|
599
|
-
|
600
|
-
ziggeo.effectProfileProcess().create_filter_process(effect_token_or_key, arguments = nil)
|
601
|
-
```
|
602
|
-
|
603
|
-
Arguments
|
604
|
-
- effect: *Effect to be applied in the process*
|
569
|
+
Update application.
|
605
570
|
|
571
|
+
```ruby
|
572
|
+
ziggeo.application().update(arguments = nil)
|
573
|
+
```
|
606
574
|
|
607
|
-
|
608
|
-
|
609
|
-
|
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*
|
610
585
|
|
611
|
-
|
612
|
-
ziggeo.effectProfileProcess().create_watermark_process(effect_token_or_key, arguments = nil, file = nil)
|
613
|
-
```
|
614
|
-
|
615
|
-
Arguments
|
616
|
-
- file: *Image file to be attached*
|
617
|
-
- vertical_position: *Specify the vertical position of your watermark (a value between 0.0 and 1.0)*
|
618
|
-
- horizontal_position: *Specify the horizontal position of your watermark (a value between 0.0 and 1.0)*
|
619
|
-
- video_scale: *Specify the image scale of your watermark (a value between 0.0 and 1.0)*
|
586
|
+
#### Get Stats<a name="method-application-get-stats"></a>
|
620
587
|
|
588
|
+
Read application stats
|
621
589
|
|
622
|
-
|
590
|
+
```ruby
|
591
|
+
ziggeo.application().get_stats(arguments = nil)
|
592
|
+
```
|
623
593
|
|
624
|
-
|
625
|
-
|
594
|
+
Arguments
|
595
|
+
- period: *Optional. Can be 'year' or 'month'.*
|
626
596
|
|
627
|
-
|
628
|
-
|
629
|
-
Create a new meta profile.
|
597
|
+
### Effect Profiles<a name="method-effect-profiles"></a>
|
630
598
|
|
631
|
-
```ruby
|
632
|
-
ziggeo.metaProfiles().create(arguments = nil)
|
633
|
-
```
|
634
|
-
|
635
|
-
Arguments
|
636
|
-
- key: *Meta Profile profile key.*
|
637
|
-
- title: *Meta Profile profile title.*
|
638
599
|
|
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.
|
639
601
|
|
640
|
-
####
|
641
|
-
|
642
|
-
Get list of meta profiles.
|
602
|
+
#### Create<a name="method-effect-profiles-create"></a>
|
643
603
|
|
644
|
-
|
645
|
-
ziggeo.metaProfiles().index(arguments = nil)
|
646
|
-
```
|
647
|
-
|
648
|
-
Arguments
|
649
|
-
- limit: *Limit the number of returned meta profiles. Can be set up to 100.*
|
650
|
-
- skip: *Skip the first [n] entries.*
|
651
|
-
- reverse: *Reverse the order in which meta profiles are returned.*
|
604
|
+
Create a new effect profile.
|
652
605
|
|
606
|
+
```ruby
|
607
|
+
ziggeo.effectProfiles().create(arguments = nil)
|
608
|
+
```
|
653
609
|
|
654
|
-
|
655
|
-
|
656
|
-
|
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*
|
657
614
|
|
658
|
-
|
659
|
-
ziggeo.metaProfiles().get(token_or_key)
|
660
|
-
```
|
661
|
-
|
615
|
+
#### Index<a name="method-effect-profiles-index"></a>
|
662
616
|
|
617
|
+
Get list of effect profiles.
|
663
618
|
|
664
|
-
|
665
|
-
|
666
|
-
|
619
|
+
```ruby
|
620
|
+
ziggeo.effectProfiles().index(arguments = nil)
|
621
|
+
```
|
667
622
|
|
668
|
-
|
669
|
-
|
670
|
-
|
671
|
-
|
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.*
|
672
627
|
|
628
|
+
#### Get<a name="method-effect-profiles-get"></a>
|
673
629
|
|
674
|
-
|
630
|
+
Get a single effect profile
|
675
631
|
|
676
|
-
|
677
|
-
|
632
|
+
```ruby
|
633
|
+
ziggeo.effectProfiles().get(token_or_key)
|
634
|
+
```
|
678
635
|
|
679
|
-
####
|
680
|
-
|
681
|
-
Return all processes associated with a meta profile
|
636
|
+
#### Delete<a name="method-effect-profiles-delete"></a>
|
682
637
|
|
683
|
-
|
684
|
-
ziggeo.metaProfileProcess().index(meta_token_or_key)
|
685
|
-
```
|
686
|
-
|
638
|
+
Delete the effect profile
|
687
639
|
|
640
|
+
```ruby
|
641
|
+
ziggeo.effectProfiles().delete(token_or_key)
|
642
|
+
```
|
688
643
|
|
689
|
-
####
|
690
|
-
|
691
|
-
Get a single process
|
644
|
+
#### Update<a name="method-effect-profiles-update"></a>
|
692
645
|
|
693
|
-
|
694
|
-
ziggeo.metaProfileProcess().get(meta_token_or_key, token_or_key)
|
695
|
-
```
|
696
|
-
|
646
|
+
Updates an effect profile.
|
697
647
|
|
648
|
+
```ruby
|
649
|
+
ziggeo.effectProfiles().update(token_or_key, arguments = nil)
|
650
|
+
```
|
698
651
|
|
699
|
-
|
700
|
-
|
701
|
-
Delete the process
|
652
|
+
Arguments
|
653
|
+
- default_effect: *Boolean. If TRUE, sets an effect profile as default. If FALSE, removes the default status for the given effect*
|
702
654
|
|
703
|
-
|
704
|
-
ziggeo.metaProfileProcess().delete(meta_token_or_key, token_or_key)
|
705
|
-
```
|
706
|
-
|
655
|
+
### Effect Profile Process<a name="method-effect-profile-process"></a>
|
707
656
|
|
708
657
|
|
709
|
-
|
710
|
-
|
711
|
-
Create a new video analysis meta process
|
658
|
+
The process resource allows you to directly access all process associated with a single effect profile.
|
712
659
|
|
713
|
-
|
714
|
-
ziggeo.metaProfileProcess().create_video_analysis_process(meta_token_or_key)
|
715
|
-
```
|
716
|
-
|
660
|
+
#### Index<a name="method-effect-profile-process-index"></a>
|
717
661
|
|
662
|
+
Return all processes associated with a effect profile
|
718
663
|
|
719
|
-
|
720
|
-
|
721
|
-
|
664
|
+
```ruby
|
665
|
+
ziggeo.effectProfileProcess().index(effect_token_or_key, arguments = nil)
|
666
|
+
```
|
722
667
|
|
723
|
-
|
724
|
-
|
725
|
-
```
|
726
|
-
|
668
|
+
Arguments
|
669
|
+
- states: *Filter streams by state*
|
727
670
|
|
671
|
+
#### Get<a name="method-effect-profile-process-get"></a>
|
728
672
|
|
729
|
-
|
730
|
-
|
731
|
-
Create a new nsfw filter meta process
|
673
|
+
Get a single process
|
732
674
|
|
733
|
-
```ruby
|
734
|
-
ziggeo.
|
735
|
-
```
|
736
|
-
|
737
|
-
Arguments
|
738
|
-
- nsfw_action: *One of the following three: approve, reject, nothing.*
|
675
|
+
```ruby
|
676
|
+
ziggeo.effectProfileProcess().get(effect_token_or_key, token_or_key)
|
677
|
+
```
|
739
678
|
|
679
|
+
#### Delete<a name="method-effect-profile-process-delete"></a>
|
740
680
|
|
741
|
-
|
681
|
+
Delete the process
|
742
682
|
|
743
|
-
|
744
|
-
|
683
|
+
```ruby
|
684
|
+
ziggeo.effectProfileProcess().delete(effect_token_or_key, token_or_key)
|
685
|
+
```
|
745
686
|
|
746
|
-
#### Create
|
747
|
-
|
748
|
-
Create a new webhook for the given url to catch the given events.
|
687
|
+
#### Create Filter Process<a name="method-effect-profile-process-create-filter-process"></a>
|
749
688
|
|
750
|
-
|
751
|
-
ziggeo.webhooks().create(arguments = nil)
|
752
|
-
```
|
753
|
-
|
754
|
-
Arguments
|
755
|
-
- target_url: *The url that will catch the events*
|
756
|
-
- encoding: *Data encoding to be used by the webhook to send the events.*
|
757
|
-
- events: *Comma-separated list of the events the webhook will catch. They must be valid webhook type events.*
|
689
|
+
Create a new filter effect process
|
758
690
|
|
691
|
+
```ruby
|
692
|
+
ziggeo.effectProfileProcess().create_filter_process(effect_token_or_key, arguments = nil)
|
693
|
+
```
|
759
694
|
|
760
|
-
|
761
|
-
|
762
|
-
Confirm a webhook using its ID and the corresponding validation code.
|
695
|
+
Arguments
|
696
|
+
- effect: *Effect to be applied in the process*
|
763
697
|
|
764
|
-
|
765
|
-
ziggeo.webhooks().confirm(arguments = nil)
|
766
|
-
```
|
767
|
-
|
768
|
-
Arguments
|
769
|
-
- webhook_id: *Webhook ID that's returned in the creation call.*
|
770
|
-
- validation_code: *Validation code that is sent to the webhook when created.*
|
698
|
+
#### Create Watermark Process<a name="method-effect-profile-process-create-watermark-process"></a>
|
771
699
|
|
700
|
+
Attaches an image to a new stream
|
772
701
|
|
773
|
-
|
774
|
-
|
775
|
-
|
702
|
+
```ruby
|
703
|
+
ziggeo.effectProfileProcess().create_watermark_process(effect_token_or_key, arguments = nil, file = nil)
|
704
|
+
```
|
776
705
|
|
777
|
-
|
778
|
-
|
779
|
-
|
780
|
-
|
781
|
-
|
782
|
-
- target_url: *The url that will catch the 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)*
|
783
711
|
|
712
|
+
#### Edit Watermark Process<a name="method-effect-profile-process-edit-watermark-process"></a>
|
784
713
|
|
785
|
-
|
714
|
+
Edits an existing watermark process.
|
786
715
|
|
787
|
-
|
788
|
-
|
716
|
+
```ruby
|
717
|
+
ziggeo.effectProfileProcess().edit_watermark_process(effect_token_or_key, token_or_key, arguments = nil, file = nil)
|
718
|
+
```
|
789
719
|
|
790
|
-
|
791
|
-
|
792
|
-
|
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)*
|
793
725
|
|
794
|
-
|
795
|
-
|
796
|
-
|
797
|
-
|
798
|
-
|
799
|
-
|
800
|
-
|
801
|
-
|
802
|
-
|
726
|
+
### Meta Profiles<a name="method-meta-profiles"></a>
|
727
|
+
|
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.
|
730
|
+
|
731
|
+
#### Create<a name="method-meta-profiles-create"></a>
|
732
|
+
|
733
|
+
Create a new meta profile.
|
734
|
+
|
735
|
+
```ruby
|
736
|
+
ziggeo.metaProfiles().create(arguments = nil)
|
737
|
+
```
|
738
|
+
|
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*
|
803
898
|
|
804
899
|
|
805
900
|
|
806
901
|
|
807
902
|
|
808
|
-
## License
|
903
|
+
## License <a name="license"></a>
|
809
904
|
|
810
|
-
Copyright (c) 2013-
|
905
|
+
Copyright (c) 2013-2021 Ziggeo
|
811
906
|
|
812
907
|
Apache 2.0 License
|