Ziggeo 2.21 → 2.30
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +247 -57
- data/lib/Ziggeo.rb +45 -12
- data/lib/classes/ZiggeoAudioStreams.rb +33 -0
- data/lib/classes/ZiggeoAudios.rb +49 -0
- data/lib/classes/ZiggeoConfig.rb +5 -3
- data/lib/classes/ZiggeoMetaProfileProcess.rb +4 -0
- data/lib/classes/ZiggeoStreams.rb +2 -6
- data/lib/classes/ZiggeoVideos.rb +2 -2
- metadata +5 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 746559bffc6707c66b456a08a8d1222c54e8bfa3bd69d857387ed0201cf3d580
|
4
|
+
data.tar.gz: 8b3fea02959f00fd879b21f672533ca7d3e4a85eced7dce6f3237c87dd05b695
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 92f758aa8325b261b1797fd1ddcc7c1a83bf12fe9955f19cdad2fc26af6e4a6375c5f00e3a6fcf5e851e6bc9519ee75edddcf318ad1edc46ea3e2d37c0eedda2
|
7
|
+
data.tar.gz: d20c7c9aced2adf8ba61d55f95fe4c52280c965f9722128d78d7f36810866f9c71311512c124e5fc271488b111b9213dc9b8d5e6a066d114701fa1675b6e8ae4
|
data/README.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# Ziggeo's Ruby Server SDK
|
2
2
|
|
3
|
-
latest version: **2.
|
3
|
+
latest version: **2.30**
|
4
4
|
|
5
5
|
## Index
|
6
6
|
|
@@ -41,46 +41,62 @@ latest version: **2.21**
|
|
41
41
|
8. [Streams Attach Image](#method-streams-attach-image)
|
42
42
|
9. [Streams Attach Video](#method-streams-attach-video)
|
43
43
|
10. [Streams Attach Subtitle](#method-streams-attach-subtitle)
|
44
|
-
|
45
|
-
|
44
|
+
5. [Methods for Audios](#method-audios)
|
45
|
+
1. [Audios Index](#method-audios-index)
|
46
|
+
2. [Audios Count](#method-audios-count)
|
47
|
+
3. [Audios Get](#method-audios-get)
|
48
|
+
4. [Audios Get Bulk](#method-audios-get-bulk)
|
49
|
+
5. [Audios Download Audio](#method-audios-download-audio)
|
50
|
+
6. [Audios Update](#method-audios-update)
|
51
|
+
7. [Audios Update Bulk](#method-audios-update-bulk)
|
52
|
+
8. [Audios Delete](#method-audios-delete)
|
53
|
+
9. [Audios Create](#method-audios-create)
|
54
|
+
6. [Methods for Audio Streams](#method-audio-streams)
|
55
|
+
1. [Audio Streams Index](#method-audio-streams-index)
|
56
|
+
2. [Audio Streams Get](#method-audio-streams-get)
|
57
|
+
3. [Audio Streams Download Audio](#method-audio-streams-download-audio)
|
58
|
+
4. [Audio Streams Delete](#method-audio-streams-delete)
|
59
|
+
5. [Audio Streams Create](#method-audio-streams-create)
|
60
|
+
7. [Methods for Authtokens](#method-authtokens)
|
46
61
|
1. [Authtokens Get](#method-authtokens-get)
|
47
62
|
2. [Authtokens Update](#method-authtokens-update)
|
48
63
|
3. [Authtokens Delete](#method-authtokens-delete)
|
49
64
|
4. [Authtokens Create](#method-authtokens-create)
|
50
|
-
|
65
|
+
8. [Methods for Application](#method-application)
|
51
66
|
1. [Application Get](#method-application-get)
|
52
67
|
2. [Application Update](#method-application-update)
|
53
68
|
3. [Application Get Stats](#method-application-get-stats)
|
54
|
-
|
69
|
+
9. [Methods for Effect Profiles](#method-effect-profiles)
|
55
70
|
1. [Effect Profiles Create](#method-effect-profiles-create)
|
56
71
|
2. [Effect Profiles Index](#method-effect-profiles-index)
|
57
72
|
3. [Effect Profiles Get](#method-effect-profiles-get)
|
58
73
|
4. [Effect Profiles Delete](#method-effect-profiles-delete)
|
59
74
|
5. [Effect Profiles Update](#method-effect-profiles-update)
|
60
|
-
|
75
|
+
10. [Methods for Effect Profile Process](#method-effect-profile-process)
|
61
76
|
1. [Effect Profile Process Index](#method-effect-profile-process-index)
|
62
77
|
2. [Effect Profile Process Get](#method-effect-profile-process-get)
|
63
78
|
3. [Effect Profile Process Delete](#method-effect-profile-process-delete)
|
64
79
|
4. [Effect Profile Process Create Filter Process](#method-effect-profile-process-create-filter-process)
|
65
80
|
5. [Effect Profile Process Create Watermark Process](#method-effect-profile-process-create-watermark-process)
|
66
81
|
6. [Effect Profile Process Edit Watermark Process](#method-effect-profile-process-edit-watermark-process)
|
67
|
-
|
82
|
+
11. [Methods for Meta Profiles](#method-meta-profiles)
|
68
83
|
1. [Meta Profiles Create](#method-meta-profiles-create)
|
69
84
|
2. [Meta Profiles Index](#method-meta-profiles-index)
|
70
85
|
3. [Meta Profiles Get](#method-meta-profiles-get)
|
71
86
|
4. [Meta Profiles Delete](#method-meta-profiles-delete)
|
72
|
-
|
87
|
+
12. [Methods for Meta Profile Process](#method-meta-profile-process)
|
73
88
|
1. [Meta Profile Process Index](#method-meta-profile-process-index)
|
74
89
|
2. [Meta Profile Process Get](#method-meta-profile-process-get)
|
75
90
|
3. [Meta Profile Process Delete](#method-meta-profile-process-delete)
|
76
91
|
4. [Meta Profile Process Create Video Analysis Process](#method-meta-profile-process-create-video-analysis-process)
|
77
92
|
5. [Meta Profile Process Create Audio Transcription Process](#method-meta-profile-process-create-audio-transcription-process)
|
78
93
|
6. [Meta Profile Process Create Nsfw Process](#method-meta-profile-process-create-nsfw-process)
|
79
|
-
|
94
|
+
7. [Meta Profile Process Create Profanity Process](#method-meta-profile-process-create-profanity-process)
|
95
|
+
13. [Methods for Webhooks](#method-webhooks)
|
80
96
|
1. [Webhooks Create](#method-webhooks-create)
|
81
97
|
2. [Webhooks Confirm](#method-webhooks-confirm)
|
82
98
|
3. [Webhooks Delete](#method-webhooks-delete)
|
83
|
-
|
99
|
+
14. [Methods for Analytics](#method-analytics)
|
84
100
|
1. [Analytics Get](#method-analytics-get)
|
85
101
|
5. [License](#license)
|
86
102
|
|
@@ -172,16 +188,18 @@ Config is optional and if not specified (recommended), the Config file will be u
|
|
172
188
|
|
173
189
|
Currently available methods are branched off within different categories:
|
174
190
|
|
175
|
-
1.Videos
|
176
|
-
|
177
|
-
|
178
|
-
|
179
|
-
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
|
191
|
+
1. Videos
|
192
|
+
2. Streams
|
193
|
+
3. Audios
|
194
|
+
4. Audio Streams
|
195
|
+
5. Authtokens
|
196
|
+
6. Application
|
197
|
+
7. Effect Profiles
|
198
|
+
8. Effect Profile Process
|
199
|
+
9. Meta Profiles
|
200
|
+
10. Meta Profile Process
|
201
|
+
11. Webhooks
|
202
|
+
12. Analytics
|
185
203
|
|
186
204
|
Each of this sections has their own actions and they are explained bellow
|
187
205
|
|
@@ -192,7 +210,7 @@ Each of this sections has their own actions and they are explained bellow
|
|
192
210
|
|
193
211
|
The videos resource allows you to access all single videos. Each video may contain more than one stream.
|
194
212
|
|
195
|
-
#### Index<a name="method-
|
213
|
+
#### Index<a name="method-videos-index"></a>
|
196
214
|
|
197
215
|
Query an array of videos (will return at most 50 videos by default). Newest videos come first.
|
198
216
|
|
@@ -219,7 +237,7 @@ ziggeo.videos().count(arguments = nil)
|
|
219
237
|
- states: *Filter videos by state*
|
220
238
|
- tags: *Filter the search result to certain tags, encoded as a comma-separated string*
|
221
239
|
|
222
|
-
#### Get<a name="method-
|
240
|
+
#### Get<a name="method-videos-get"></a>
|
223
241
|
|
224
242
|
Get a single video by token or key.
|
225
243
|
|
@@ -250,7 +268,7 @@ ziggeo.videos().stats_bulk(arguments = nil)
|
|
250
268
|
- tokens_or_keys: *Comma-separated list with the desired videos tokens or keys (Limit: 100 tokens or keys).*
|
251
269
|
- 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.*
|
252
270
|
|
253
|
-
#### Download Video<a name="method-
|
271
|
+
#### Download Video<a name="method-videos-download-video"></a>
|
254
272
|
|
255
273
|
Download the video data file
|
256
274
|
|
@@ -258,7 +276,7 @@ Download the video data file
|
|
258
276
|
ziggeo.videos().download_video(token_or_key)
|
259
277
|
```
|
260
278
|
|
261
|
-
#### Download Image<a name="method-
|
279
|
+
#### Download Image<a name="method-videos-download-image"></a>
|
262
280
|
|
263
281
|
Download the image data file
|
264
282
|
|
@@ -266,7 +284,7 @@ Download the image data file
|
|
266
284
|
ziggeo.videos().download_image(token_or_key)
|
267
285
|
```
|
268
286
|
|
269
|
-
#### Get Stats<a name="method-
|
287
|
+
#### Get Stats<a name="method-videos-get-stats"></a>
|
270
288
|
|
271
289
|
Get the video's stats
|
272
290
|
|
@@ -274,7 +292,7 @@ Get the video's stats
|
|
274
292
|
ziggeo.videos().get_stats(token_or_key)
|
275
293
|
```
|
276
294
|
|
277
|
-
#### Push To Service<a name="method-
|
295
|
+
#### Push To Service<a name="method-videos-push-to-service"></a>
|
278
296
|
|
279
297
|
Push a video to a provided push service.
|
280
298
|
|
@@ -307,7 +325,7 @@ ziggeo.videos().apply_meta(token_or_key, arguments = nil)
|
|
307
325
|
Arguments
|
308
326
|
- metaprofiletoken: *Meta Profile token (from the Meta Profiles configured for the app)*
|
309
327
|
|
310
|
-
#### Update<a name="method-
|
328
|
+
#### Update<a name="method-videos-update"></a>
|
311
329
|
|
312
330
|
Update single video by token or key.
|
313
331
|
|
@@ -341,7 +359,7 @@ ziggeo.videos().update_bulk(arguments = nil)
|
|
341
359
|
- expiration_days: *After how many days will this video be deleted*
|
342
360
|
- expire_on: *On which date will this video be deleted. String in ISO 8601 format: YYYY-MM-DD*
|
343
361
|
|
344
|
-
#### Delete<a name="method-
|
362
|
+
#### Delete<a name="method-videos-delete"></a>
|
345
363
|
|
346
364
|
Delete a single video by token or key.
|
347
365
|
|
@@ -349,7 +367,7 @@ Delete a single video by token or key.
|
|
349
367
|
ziggeo.videos().delete(token_or_key)
|
350
368
|
```
|
351
369
|
|
352
|
-
#### Create<a name="method-
|
370
|
+
#### Create<a name="method-videos-create"></a>
|
353
371
|
|
354
372
|
Create a new video.
|
355
373
|
|
@@ -364,6 +382,9 @@ ziggeo.videos().create(arguments = nil, file = nil)
|
|
364
382
|
- tags: *Video Tags*
|
365
383
|
- key: *Unique (optional) name of video*
|
366
384
|
- volatile: *Automatically removed this video if it remains empty*
|
385
|
+
- effect_profile: *Set the effect profile that you want to have applied to your video.*
|
386
|
+
- meta_profile: *Set the meta profile that you want to have applied to your video once created.*
|
387
|
+
- video_profile: *Set the video profile that you want to have applied to your video as you create it.*
|
367
388
|
|
368
389
|
#### Analytics<a name="method-videos-analytics"></a>
|
369
390
|
|
@@ -384,7 +405,7 @@ ziggeo.videos().analytics(token_or_key, arguments = nil)
|
|
384
405
|
|
385
406
|
The streams resource allows you to directly access all streams associated with a single video.
|
386
407
|
|
387
|
-
#### Index<a name="method-
|
408
|
+
#### Index<a name="method-streams-index"></a>
|
388
409
|
|
389
410
|
Return all streams associated with a video
|
390
411
|
|
@@ -395,7 +416,7 @@ ziggeo.streams().index(video_token_or_key, arguments = nil)
|
|
395
416
|
Arguments
|
396
417
|
- states: *Filter streams by state*
|
397
418
|
|
398
|
-
#### Get<a name="method-
|
419
|
+
#### Get<a name="method-streams-get"></a>
|
399
420
|
|
400
421
|
Get a single stream
|
401
422
|
|
@@ -430,7 +451,7 @@ ziggeo.streams().push_to_service(video_token_or_key, token_or_key, arguments = n
|
|
430
451
|
Arguments
|
431
452
|
- pushservicetoken: *Push Services's token (from the Push Services configured for the app)*
|
432
453
|
|
433
|
-
#### Delete<a name="method-
|
454
|
+
#### Delete<a name="method-streams-delete"></a>
|
434
455
|
|
435
456
|
Delete the stream
|
436
457
|
|
@@ -438,7 +459,7 @@ Delete the stream
|
|
438
459
|
ziggeo.streams().delete(video_token_or_key, token_or_key)
|
439
460
|
```
|
440
461
|
|
441
|
-
#### Create<a name="method-
|
462
|
+
#### Create<a name="method-streams-create"></a>
|
442
463
|
|
443
464
|
Create a new stream
|
444
465
|
|
@@ -451,7 +472,7 @@ ziggeo.streams().create(video_token_or_key, arguments = nil, file = nil)
|
|
451
472
|
|
452
473
|
#### Attach Image<a name="method-streams-attach-image"></a>
|
453
474
|
|
454
|
-
Attaches an image to a new stream
|
475
|
+
Attaches an image to a new stream. Must be attached before video, since video upload triggers the transcoding job and binds the stream
|
455
476
|
|
456
477
|
```ruby
|
457
478
|
ziggeo.streams().attach_image(video_token_or_key, token_or_key, arguments = nil, file = nil)
|
@@ -484,22 +505,180 @@ ziggeo.streams().attach_subtitle(video_token_or_key, token_or_key, arguments = n
|
|
484
505
|
- label: *Subtitle reference*
|
485
506
|
- data: *Actual subtitle*
|
486
507
|
|
487
|
-
|
508
|
+
### Audios<a name="method-audios"></a>
|
509
|
+
|
510
|
+
|
511
|
+
The audios resource allows you to access all single audios. Each video may contain more than one stream.
|
512
|
+
|
513
|
+
#### Index<a name="method-audios-index"></a>
|
488
514
|
|
489
|
-
|
515
|
+
Query an array of audios (will return at most 50 audios by default). Newest audios come first.
|
490
516
|
|
491
517
|
```ruby
|
492
|
-
ziggeo.
|
518
|
+
ziggeo.audios().index(arguments = nil)
|
493
519
|
```
|
494
520
|
|
495
521
|
Arguments
|
522
|
+
- limit: *Limit the number of returned audios. Can be set up to 100.*
|
523
|
+
- skip: *Skip the first [n] entries.*
|
524
|
+
- reverse: *Reverse the order in which audios are returned.*
|
525
|
+
- states: *Filter audios by state*
|
526
|
+
- tags: *Filter the search result to certain tags, encoded as a comma-separated string*
|
527
|
+
|
528
|
+
#### Count<a name="method-audios-count"></a>
|
529
|
+
|
530
|
+
Get the audio count for the application.
|
531
|
+
|
532
|
+
```ruby
|
533
|
+
ziggeo.audios().count(arguments = nil)
|
534
|
+
```
|
535
|
+
|
536
|
+
Arguments
|
537
|
+
- states: *Filter audios by state*
|
538
|
+
- tags: *Filter the search result to certain tags, encoded as a comma-separated string*
|
539
|
+
|
540
|
+
#### Get<a name="method-audios-get"></a>
|
541
|
+
|
542
|
+
Get a single audio by token or key.
|
543
|
+
|
544
|
+
```ruby
|
545
|
+
ziggeo.audios().get(token_or_key)
|
546
|
+
```
|
547
|
+
|
548
|
+
#### Get Bulk<a name="method-audios-get-bulk"></a>
|
549
|
+
|
550
|
+
Get multiple audios by tokens or keys.
|
551
|
+
|
552
|
+
```ruby
|
553
|
+
ziggeo.audios().get_bulk(arguments = nil)
|
554
|
+
```
|
555
|
+
|
556
|
+
Arguments
|
557
|
+
- tokens_or_keys: *Comma-separated list with the desired audios tokens or keys (Limit: 100 tokens or keys).*
|
558
|
+
|
559
|
+
#### Download Audio<a name="method-audios-download-audio"></a>
|
560
|
+
|
561
|
+
Download the audio data file
|
562
|
+
|
563
|
+
```ruby
|
564
|
+
ziggeo.audios().download_audio(token_or_key)
|
565
|
+
```
|
566
|
+
|
567
|
+
#### Update<a name="method-audios-update"></a>
|
568
|
+
|
569
|
+
Update single audio by token or key.
|
570
|
+
|
571
|
+
```ruby
|
572
|
+
ziggeo.audios().update(token_or_key, arguments = nil)
|
573
|
+
```
|
574
|
+
|
575
|
+
Arguments
|
576
|
+
- min_duration: *Minimal duration of audio*
|
577
|
+
- max_duration: *Maximal duration of audio*
|
578
|
+
- tags: *Audio Tags*
|
579
|
+
- key: *Unique (optional) name of audio*
|
580
|
+
- volatile: *Automatically removed this audio if it remains empty*
|
581
|
+
- expiration_days: *After how many days will this audio be deleted*
|
582
|
+
- expire_on: *On which date will this audio be deleted. String in ISO 8601 format: YYYY-MM-DD*
|
583
|
+
|
584
|
+
#### Update Bulk<a name="method-audios-update-bulk"></a>
|
585
|
+
|
586
|
+
Update multiple audios by token or key.
|
587
|
+
|
588
|
+
```ruby
|
589
|
+
ziggeo.audios().update_bulk(arguments = nil)
|
590
|
+
```
|
591
|
+
|
592
|
+
Arguments
|
593
|
+
- tokens_or_keys: *Comma-separated list with the desired audios tokens or keys (Limit: 100 tokens or keys).*
|
594
|
+
- min_duration: *Minimal duration of audio*
|
595
|
+
- max_duration: *Maximal duration of audio*
|
596
|
+
- tags: *Audio Tags*
|
597
|
+
- volatile: *Automatically removed this audio if it remains empty*
|
598
|
+
- expiration_days: *After how many days will this audio be deleted*
|
599
|
+
- expire_on: *On which date will this audio be deleted. String in ISO 8601 format: YYYY-MM-DD*
|
600
|
+
|
601
|
+
#### Delete<a name="method-audios-delete"></a>
|
602
|
+
|
603
|
+
Delete a single audio by token or key.
|
604
|
+
|
605
|
+
```ruby
|
606
|
+
ziggeo.audios().delete(token_or_key)
|
607
|
+
```
|
608
|
+
|
609
|
+
#### Create<a name="method-audios-create"></a>
|
610
|
+
|
611
|
+
Create a new audio.
|
612
|
+
|
613
|
+
```ruby
|
614
|
+
ziggeo.audios().create(arguments = nil, file = nil)
|
615
|
+
```
|
616
|
+
|
617
|
+
Arguments
|
618
|
+
- file: *Audio file to be uploaded*
|
619
|
+
- min_duration: *Minimal duration of audio*
|
620
|
+
- max_duration: *Maximal duration of audio*
|
621
|
+
- tags: *Audio Tags*
|
622
|
+
- key: *Unique (optional) name of audio*
|
623
|
+
- volatile: *Automatically removed this video if it remains empty*
|
624
|
+
|
625
|
+
### Audio Streams<a name="method-audio-streams"></a>
|
626
|
+
|
627
|
+
|
628
|
+
The streams resource allows you to directly access all streams associated with a single audio.
|
629
|
+
|
630
|
+
#### Index<a name="method-audio-streams-index"></a>
|
631
|
+
|
632
|
+
Return all streams associated with a audio
|
633
|
+
|
634
|
+
```ruby
|
635
|
+
ziggeo.audioStreams().index(audio_token_or_key, arguments = nil)
|
636
|
+
```
|
637
|
+
|
638
|
+
Arguments
|
639
|
+
- states: *Filter streams by state*
|
640
|
+
|
641
|
+
#### Get<a name="method-audio-streams-get"></a>
|
642
|
+
|
643
|
+
Get a single stream
|
644
|
+
|
645
|
+
```ruby
|
646
|
+
ziggeo.audioStreams().get(audio_token_or_key, token_or_key)
|
647
|
+
```
|
648
|
+
|
649
|
+
#### Download Audio<a name="method-audio-streams-download-audio"></a>
|
650
|
+
|
651
|
+
Download the audio data associated with the stream
|
652
|
+
|
653
|
+
```ruby
|
654
|
+
ziggeo.audioStreams().download_audio(audio_token_or_key, token_or_key)
|
655
|
+
```
|
656
|
+
|
657
|
+
#### Delete<a name="method-audio-streams-delete"></a>
|
658
|
+
|
659
|
+
Delete the stream
|
660
|
+
|
661
|
+
```ruby
|
662
|
+
ziggeo.audioStreams().delete(audio_token_or_key, token_or_key)
|
663
|
+
```
|
664
|
+
|
665
|
+
#### Create<a name="method-audio-streams-create"></a>
|
666
|
+
|
667
|
+
Create a new stream
|
668
|
+
|
669
|
+
```ruby
|
670
|
+
ziggeo.audioStreams().create(audio_token_or_key, arguments = nil, file = nil)
|
671
|
+
```
|
672
|
+
|
673
|
+
Arguments
|
674
|
+
- file: *Audio file to be uploaded*
|
496
675
|
|
497
676
|
### Authtokens<a name="method-authtokens"></a>
|
498
677
|
|
499
678
|
|
500
679
|
The auth token resource allows you to manage authorization settings for video objects.
|
501
680
|
|
502
|
-
#### Get<a name="method-
|
681
|
+
#### Get<a name="method-authtokens-get"></a>
|
503
682
|
|
504
683
|
Get a single auth token by token.
|
505
684
|
|
@@ -507,7 +686,7 @@ Get a single auth token by token.
|
|
507
686
|
ziggeo.authtokens().get(token)
|
508
687
|
```
|
509
688
|
|
510
|
-
#### Update<a name="method-
|
689
|
+
#### Update<a name="method-authtokens-update"></a>
|
511
690
|
|
512
691
|
Update single auth token by token.
|
513
692
|
|
@@ -523,7 +702,7 @@ ziggeo.authtokens().update(token_or_key, arguments = nil)
|
|
523
702
|
- session_limit: *Maximal number of sessions*
|
524
703
|
- grants: *Permissions this tokens grants*
|
525
704
|
|
526
|
-
#### Delete<a name="method-
|
705
|
+
#### Delete<a name="method-authtokens-delete"></a>
|
527
706
|
|
528
707
|
Delete a single auth token by token.
|
529
708
|
|
@@ -531,7 +710,7 @@ Delete a single auth token by token.
|
|
531
710
|
ziggeo.authtokens().delete(token_or_key)
|
532
711
|
```
|
533
712
|
|
534
|
-
#### Create<a name="method-
|
713
|
+
#### Create<a name="method-authtokens-create"></a>
|
535
714
|
|
536
715
|
Create a new auth token.
|
537
716
|
|
@@ -552,7 +731,7 @@ ziggeo.authtokens().create(arguments = nil)
|
|
552
731
|
|
553
732
|
The application token resource allows you to manage your application.
|
554
733
|
|
555
|
-
#### Get<a name="method-
|
734
|
+
#### Get<a name="method-application-get"></a>
|
556
735
|
|
557
736
|
Read application.
|
558
737
|
|
@@ -560,7 +739,7 @@ Read application.
|
|
560
739
|
ziggeo.application().get()
|
561
740
|
```
|
562
741
|
|
563
|
-
#### Update<a name="method-
|
742
|
+
#### Update<a name="method-application-update"></a>
|
564
743
|
|
565
744
|
Update application.
|
566
745
|
|
@@ -595,7 +774,7 @@ ziggeo.application().get_stats(arguments = nil)
|
|
595
774
|
|
596
775
|
The effect profiles resource allows you to access and create effect profiles for your app. Each effect profile may contain one process or more.
|
597
776
|
|
598
|
-
#### Create<a name="method-
|
777
|
+
#### Create<a name="method-effect-profiles-create"></a>
|
599
778
|
|
600
779
|
Create a new effect profile.
|
601
780
|
|
@@ -608,7 +787,7 @@ ziggeo.effectProfiles().create(arguments = nil)
|
|
608
787
|
- title: *Effect profile title.*
|
609
788
|
- default_effect: *Boolean. If TRUE, sets an effect profile as default. If FALSE, removes the default status for the given effect*
|
610
789
|
|
611
|
-
#### Index<a name="method-
|
790
|
+
#### Index<a name="method-effect-profiles-index"></a>
|
612
791
|
|
613
792
|
Get list of effect profiles.
|
614
793
|
|
@@ -621,7 +800,7 @@ ziggeo.effectProfiles().index(arguments = nil)
|
|
621
800
|
- skip: *Skip the first [n] entries.*
|
622
801
|
- reverse: *Reverse the order in which effect profiles are returned.*
|
623
802
|
|
624
|
-
#### Get<a name="method-
|
803
|
+
#### Get<a name="method-effect-profiles-get"></a>
|
625
804
|
|
626
805
|
Get a single effect profile
|
627
806
|
|
@@ -629,7 +808,7 @@ Get a single effect profile
|
|
629
808
|
ziggeo.effectProfiles().get(token_or_key)
|
630
809
|
```
|
631
810
|
|
632
|
-
#### Delete<a name="method-
|
811
|
+
#### Delete<a name="method-effect-profiles-delete"></a>
|
633
812
|
|
634
813
|
Delete the effect profile
|
635
814
|
|
@@ -653,7 +832,7 @@ ziggeo.effectProfiles().update(token_or_key, arguments = nil)
|
|
653
832
|
|
654
833
|
The process resource allows you to directly access all process associated with a single effect profile.
|
655
834
|
|
656
|
-
#### Index<a name="method-
|
835
|
+
#### Index<a name="method-effect-profile-process-index"></a>
|
657
836
|
|
658
837
|
Return all processes associated with a effect profile
|
659
838
|
|
@@ -664,7 +843,7 @@ ziggeo.effectProfileProcess().index(effect_token_or_key, arguments = nil)
|
|
664
843
|
Arguments
|
665
844
|
- states: *Filter streams by state*
|
666
845
|
|
667
|
-
#### Get<a name="method-
|
846
|
+
#### Get<a name="method-effect-profile-process-get"></a>
|
668
847
|
|
669
848
|
Get a single process
|
670
849
|
|
@@ -672,7 +851,7 @@ Get a single process
|
|
672
851
|
ziggeo.effectProfileProcess().get(effect_token_or_key, token_or_key)
|
673
852
|
```
|
674
853
|
|
675
|
-
#### Delete<a name="method-
|
854
|
+
#### Delete<a name="method-effect-profile-process-delete"></a>
|
676
855
|
|
677
856
|
Delete the process
|
678
857
|
|
@@ -724,7 +903,7 @@ ziggeo.effectProfileProcess().edit_watermark_process(effect_token_or_key, token_
|
|
724
903
|
|
725
904
|
The meta profiles resource allows you to access and create meta profiles for your app. Each meta profile may contain one process or more.
|
726
905
|
|
727
|
-
#### Create<a name="method-
|
906
|
+
#### Create<a name="method-meta-profiles-create"></a>
|
728
907
|
|
729
908
|
Create a new meta profile.
|
730
909
|
|
@@ -736,7 +915,7 @@ ziggeo.metaProfiles().create(arguments = nil)
|
|
736
915
|
- key: *Meta Profile profile key.*
|
737
916
|
- title: *Meta Profile profile title.*
|
738
917
|
|
739
|
-
#### Index<a name="method-meta-
|
918
|
+
#### Index<a name="method-meta-profiles-index"></a>
|
740
919
|
|
741
920
|
Get list of meta profiles.
|
742
921
|
|
@@ -749,7 +928,7 @@ ziggeo.metaProfiles().index(arguments = nil)
|
|
749
928
|
- skip: *Skip the first [n] entries.*
|
750
929
|
- reverse: *Reverse the order in which meta profiles are returned.*
|
751
930
|
|
752
|
-
#### Get<a name="method-
|
931
|
+
#### Get<a name="method-meta-profiles-get"></a>
|
753
932
|
|
754
933
|
Get a single meta profile
|
755
934
|
|
@@ -757,7 +936,7 @@ Get a single meta profile
|
|
757
936
|
ziggeo.metaProfiles().get(token_or_key)
|
758
937
|
```
|
759
938
|
|
760
|
-
#### Delete<a name="method-
|
939
|
+
#### Delete<a name="method-meta-profiles-delete"></a>
|
761
940
|
|
762
941
|
Delete the meta profile
|
763
942
|
|
@@ -778,7 +957,7 @@ Return all processes associated with a meta profile
|
|
778
957
|
ziggeo.metaProfileProcess().index(meta_token_or_key)
|
779
958
|
```
|
780
959
|
|
781
|
-
#### Get<a name="method-
|
960
|
+
#### Get<a name="method-meta-profile-process-get"></a>
|
782
961
|
|
783
962
|
Get a single process
|
784
963
|
|
@@ -786,7 +965,7 @@ Get a single process
|
|
786
965
|
ziggeo.metaProfileProcess().get(meta_token_or_key, token_or_key)
|
787
966
|
```
|
788
967
|
|
789
|
-
#### Delete<a name="method-
|
968
|
+
#### Delete<a name="method-meta-profile-process-delete"></a>
|
790
969
|
|
791
970
|
Delete the process
|
792
971
|
|
@@ -821,6 +1000,17 @@ ziggeo.metaProfileProcess().create_nsfw_process(meta_token_or_key, arguments = n
|
|
821
1000
|
Arguments
|
822
1001
|
- nsfw_action: *One of the following three: approve, reject, nothing.*
|
823
1002
|
|
1003
|
+
#### Create Profanity Process<a name="method-meta-profile-process-create-profanity-process"></a>
|
1004
|
+
|
1005
|
+
Create a new profanity filter meta process
|
1006
|
+
|
1007
|
+
```ruby
|
1008
|
+
ziggeo.metaProfileProcess().create_profanity_process(meta_token_or_key, arguments = nil)
|
1009
|
+
```
|
1010
|
+
|
1011
|
+
Arguments
|
1012
|
+
- profanity_action: *One of the following three: approve, reject, nothing.*
|
1013
|
+
|
824
1014
|
### Webhooks<a name="method-webhooks"></a>
|
825
1015
|
|
826
1016
|
|
@@ -887,6 +1077,6 @@ ziggeo.analytics().get(arguments = nil)
|
|
887
1077
|
|
888
1078
|
## License <a name="license"></a>
|
889
1079
|
|
890
|
-
Copyright (c) 2013-
|
1080
|
+
Copyright (c) 2013-2022 Ziggeo
|
891
1081
|
|
892
1082
|
Apache 2.0 License
|
data/lib/Ziggeo.rb
CHANGED
@@ -8,6 +8,8 @@ require_relative "classes/ZiggeoConnect"
|
|
8
8
|
require_relative "classes/ZiggeoAuth"
|
9
9
|
require_relative "classes/ZiggeoVideos"
|
10
10
|
require_relative "classes/ZiggeoStreams"
|
11
|
+
require_relative "classes/ZiggeoAudios"
|
12
|
+
require_relative "classes/ZiggeoAudioStreams"
|
11
13
|
require_relative "classes/ZiggeoAuthtokens"
|
12
14
|
require_relative "classes/ZiggeoApplication"
|
13
15
|
require_relative "classes/ZiggeoEffectProfiles"
|
@@ -19,7 +21,7 @@ require_relative "classes/ZiggeoAnalytics"
|
|
19
21
|
|
20
22
|
class Ziggeo
|
21
23
|
|
22
|
-
attr_accessor :token, :private_key, :encryption_key, :config, :connect, :api_connect, :cdn_connect
|
24
|
+
attr_accessor :token, :private_key, :encryption_key, :config, :connect, :api_connect, :cdn_connect, :js_cdn_connect
|
23
25
|
|
24
26
|
def initialize(token = nil, private_key = nil, encryption_key = nil)
|
25
27
|
@token = token
|
@@ -50,9 +52,19 @@ class Ziggeo
|
|
50
52
|
end
|
51
53
|
end
|
52
54
|
@cdn_connect = ZiggeoConnect.new(self, cdn_url)
|
55
|
+
js_cdn_url = @config.js_cdn_url
|
56
|
+
js_cdn_regions = @config.js_cdn_regions
|
57
|
+
js_cdn_regions.each do |key, value|
|
58
|
+
if (@token.start_with?(key))
|
59
|
+
js_cdn_url = value
|
60
|
+
end
|
61
|
+
end
|
62
|
+
@js_cdn_connect = ZiggeoConnect.new(self, js_cdn_url)
|
53
63
|
@auth = nil
|
54
64
|
@videos = nil
|
55
65
|
@streams = nil
|
66
|
+
@audios = nil
|
67
|
+
@audioStreams = nil
|
56
68
|
@authtokens = nil
|
57
69
|
@application = nil
|
58
70
|
@effectProfiles = nil
|
@@ -72,47 +84,68 @@ class Ziggeo
|
|
72
84
|
end
|
73
85
|
|
74
86
|
def auth()
|
75
|
-
|
87
|
+
@auth = @auth || ZiggeoAuth.new(self)
|
88
|
+
return @auth
|
76
89
|
end
|
77
90
|
|
78
91
|
def videos()
|
79
|
-
|
92
|
+
@videos = @videos || ZiggeoVideos.new(self)
|
93
|
+
return @videos
|
80
94
|
end
|
81
95
|
|
82
96
|
def streams()
|
83
|
-
|
97
|
+
@streams = @streams || ZiggeoStreams.new(self)
|
98
|
+
return @streams
|
99
|
+
end
|
100
|
+
|
101
|
+
def audios()
|
102
|
+
@audios = @audios || ZiggeoAudios.new(self)
|
103
|
+
return @audios
|
104
|
+
end
|
105
|
+
|
106
|
+
def audioStreams()
|
107
|
+
@audioStreams = @audioStreams || ZiggeoAudioStreams.new(self)
|
108
|
+
return @audioStreams
|
84
109
|
end
|
85
110
|
|
86
111
|
def authtokens()
|
87
|
-
|
112
|
+
@authtokens = @authtokens || ZiggeoAuthtokens.new(self)
|
113
|
+
return @authtokens
|
88
114
|
end
|
89
115
|
|
90
116
|
def application()
|
91
|
-
|
117
|
+
@application = @application || ZiggeoApplication.new(self)
|
118
|
+
return @application
|
92
119
|
end
|
93
120
|
|
94
121
|
def effectProfiles()
|
95
|
-
|
122
|
+
@effectProfiles = @effectProfiles || ZiggeoEffectProfiles.new(self)
|
123
|
+
return @effectProfiles
|
96
124
|
end
|
97
125
|
|
98
126
|
def effectProfileProcess()
|
99
|
-
|
127
|
+
@effectProfileProcess = @effectProfileProcess || ZiggeoEffectProfileProcess.new(self)
|
128
|
+
return @effectProfileProcess
|
100
129
|
end
|
101
130
|
|
102
131
|
def metaProfiles()
|
103
|
-
|
132
|
+
@metaProfiles = @metaProfiles || ZiggeoMetaProfiles.new(self)
|
133
|
+
return @metaProfiles
|
104
134
|
end
|
105
135
|
|
106
136
|
def metaProfileProcess()
|
107
|
-
|
137
|
+
@metaProfileProcess = @metaProfileProcess || ZiggeoMetaProfileProcess.new(self)
|
138
|
+
return @metaProfileProcess
|
108
139
|
end
|
109
140
|
|
110
141
|
def webhooks()
|
111
|
-
|
142
|
+
@webhooks = @webhooks || ZiggeoWebhooks.new(self)
|
143
|
+
return @webhooks
|
112
144
|
end
|
113
145
|
|
114
146
|
def analytics()
|
115
|
-
|
147
|
+
@analytics = @analytics || ZiggeoAnalytics.new(self)
|
148
|
+
return @analytics
|
116
149
|
end
|
117
150
|
|
118
151
|
end
|
@@ -0,0 +1,33 @@
|
|
1
|
+
class ZiggeoAudioStreams
|
2
|
+
|
3
|
+
def initialize(application)
|
4
|
+
@application = application
|
5
|
+
end
|
6
|
+
|
7
|
+
def index(audio_token_or_key, data = nil)
|
8
|
+
return @application.api_connect.getJSON('/v1/audios/' + audio_token_or_key + '/streams', data)
|
9
|
+
end
|
10
|
+
|
11
|
+
def get(audio_token_or_key, token_or_key)
|
12
|
+
return @application.api_connect.getJSON('/v1/audios/' + audio_token_or_key + '/streams/' + token_or_key + '')
|
13
|
+
end
|
14
|
+
|
15
|
+
def download_audio(audio_token_or_key, token_or_key)
|
16
|
+
return @application.js_cdn_connect.get('/v1/audios/' + audio_token_or_key + '/streams/' + token_or_key + '/audio')
|
17
|
+
end
|
18
|
+
|
19
|
+
def delete(audio_token_or_key, token_or_key)
|
20
|
+
return @application.api_connect.delete('/v1/audios/' + audio_token_or_key + '/streams/' + token_or_key + '')
|
21
|
+
end
|
22
|
+
|
23
|
+
def create(audio_token_or_key, data = nil, file = nil)
|
24
|
+
unless file.nil?
|
25
|
+
result = @application.connect.postUploadJSON('/v1/audios/' + audio_token_or_key + '/streams-upload-url', 'stream', data, file, 'audio_type')
|
26
|
+
result = @application.connect.postJSON('/v1/audios/' + audio_token_or_key + '/streams/' + result["token"] + '/confirm-audio');
|
27
|
+
return result
|
28
|
+
else
|
29
|
+
return @application.api_connect.postJSON('/v1/audios/' + audio_token_or_key + '/streams', data, file)
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
end
|
@@ -0,0 +1,49 @@
|
|
1
|
+
class ZiggeoAudios
|
2
|
+
|
3
|
+
def initialize(application)
|
4
|
+
@application = application
|
5
|
+
end
|
6
|
+
|
7
|
+
def index(data = nil)
|
8
|
+
return @application.api_connect.getJSON('/v1/audios/', data)
|
9
|
+
end
|
10
|
+
|
11
|
+
def count(data = nil)
|
12
|
+
return @application.api_connect.getJSON('/v1/audios/count', data)
|
13
|
+
end
|
14
|
+
|
15
|
+
def get(token_or_key)
|
16
|
+
return @application.api_connect.getJSON('/v1/audios/' + token_or_key + '')
|
17
|
+
end
|
18
|
+
|
19
|
+
def get_bulk(data = nil)
|
20
|
+
return @application.api_connect.postJSON('/v1/audios/get-bulk', data)
|
21
|
+
end
|
22
|
+
|
23
|
+
def download_audio(token_or_key)
|
24
|
+
return @application.js_cdn_connect.get('/v1/audios/' + token_or_key + '/audio')
|
25
|
+
end
|
26
|
+
|
27
|
+
def update(token_or_key, data = nil)
|
28
|
+
return @application.api_connect.postJSON('/v1/audios/' + token_or_key + '', data)
|
29
|
+
end
|
30
|
+
|
31
|
+
def update_bulk(data = nil)
|
32
|
+
return @application.api_connect.postJSON('/v1/audios/update-bulk', data)
|
33
|
+
end
|
34
|
+
|
35
|
+
def delete(token_or_key)
|
36
|
+
return @application.api_connect.delete('/v1/audios/' + token_or_key + '')
|
37
|
+
end
|
38
|
+
|
39
|
+
def create(data = nil, file = nil)
|
40
|
+
unless file.nil?
|
41
|
+
result = @application.connect.postUploadJSON('/v1/audios-upload-url', 'audio', data, file, 'audio_type')
|
42
|
+
result["default_stream"] = @application.connect.postJSON('/v1/audios/' + result["token"] + '/streams/' + result["default_stream"]["token"] + '/confirm-audio');
|
43
|
+
return result
|
44
|
+
else
|
45
|
+
return @application.api_connect.postJSON('/v1/audios/', data, file)
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
49
|
+
end
|
data/lib/classes/ZiggeoConfig.rb
CHANGED
@@ -1,16 +1,18 @@
|
|
1
1
|
|
2
2
|
class ZiggeoConfig
|
3
|
-
attr_accessor :request_timeout, :request_timeout_per_mb, :server_api_url, :api_url, :cdn_url, :regions, :api_regions, :cdn_regions, :resilience_factor, :resilience_on_fail
|
3
|
+
attr_accessor :request_timeout, :request_timeout_per_mb, :server_api_url, :api_url, :cdn_url, :js_cdn_url, :regions, :api_regions, :cdn_regions, :js_cdn_regions, :resilience_factor, :resilience_on_fail
|
4
4
|
|
5
5
|
def initialize()
|
6
6
|
@request_timeout = 30 # seconds
|
7
7
|
@request_timeout_per_mb = 20 # seconds per MB of uploaded file
|
8
|
-
@server_api_url = "https://
|
8
|
+
@server_api_url = "https://srv-api.ziggeo.com"
|
9
9
|
@api_url = "https://api-us-east-1.ziggeo.com"
|
10
10
|
@cdn_url = "https://video-cdn.ziggeo.com"
|
11
|
-
@
|
11
|
+
@js_cdn_url = "https://media-cdn.ziggeo.com"
|
12
|
+
@regions = {"r1" => "https://srv-api-eu-west-1.ziggeo.com", }
|
12
13
|
@api_regions = {"r1" => "https://api-eu-west-1.ziggeo.com", }
|
13
14
|
@cdn_regions = {"r1" => "https://video-cdn-eu-west-1.ziggeo.com", }
|
15
|
+
@js_cdn_regions = {"r1" => "https://media-cdn-eu-west-1.ziggeo.com", }
|
14
16
|
@resilience_factor = 5
|
15
17
|
@resilience_on_fail = {"error" => "Too many failed attempts"}
|
16
18
|
end
|
@@ -28,4 +28,8 @@ class ZiggeoMetaProfileProcess
|
|
28
28
|
return @application.connect.postJSON('/v1/metaprofiles/' + meta_token_or_key + '/process/nsfw', data)
|
29
29
|
end
|
30
30
|
|
31
|
+
def create_profanity_process(meta_token_or_key, data = nil)
|
32
|
+
return @application.connect.postJSON('/v1/metaprofiles/' + meta_token_or_key + '/process/profanity', data)
|
33
|
+
end
|
34
|
+
|
31
35
|
end
|
@@ -13,11 +13,11 @@ class ZiggeoStreams
|
|
13
13
|
end
|
14
14
|
|
15
15
|
def download_video(video_token_or_key, token_or_key)
|
16
|
-
return @application.
|
16
|
+
return @application.cdn_connect.get('/v1/videos/' + video_token_or_key + '/streams/' + token_or_key + '/video')
|
17
17
|
end
|
18
18
|
|
19
19
|
def download_image(video_token_or_key, token_or_key)
|
20
|
-
return @application.
|
20
|
+
return @application.cdn_connect.get('/v1/videos/' + video_token_or_key + '/streams/' + token_or_key + '/image')
|
21
21
|
end
|
22
22
|
|
23
23
|
def push_to_service(video_token_or_key, token_or_key, data = nil)
|
@@ -62,8 +62,4 @@ class ZiggeoStreams
|
|
62
62
|
return @application.connect.postJSON('/v1/videos/' + video_token_or_key + '/streams/' + token_or_key + '/subtitle', data)
|
63
63
|
end
|
64
64
|
|
65
|
-
def bind(video_token_or_key, token_or_key)
|
66
|
-
return @application.connect.postJSON('/v1/videos/' + video_token_or_key + '/streams/' + token_or_key + '/bind')
|
67
|
-
end
|
68
|
-
|
69
65
|
end
|
data/lib/classes/ZiggeoVideos.rb
CHANGED
@@ -25,11 +25,11 @@ class ZiggeoVideos
|
|
25
25
|
end
|
26
26
|
|
27
27
|
def download_video(token_or_key)
|
28
|
-
return @application.
|
28
|
+
return @application.cdn_connect.get('/v1/videos/' + token_or_key + '/video')
|
29
29
|
end
|
30
30
|
|
31
31
|
def download_image(token_or_key)
|
32
|
-
return @application.
|
32
|
+
return @application.cdn_connect.get('/v1/videos/' + token_or_key + '/image')
|
33
33
|
end
|
34
34
|
|
35
35
|
def get_stats(token_or_key)
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: Ziggeo
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: '2.
|
4
|
+
version: '2.30'
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Ziggeo, Inc
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2022-02-17 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: httparty
|
@@ -35,6 +35,8 @@ files:
|
|
35
35
|
- lib/Ziggeo.rb
|
36
36
|
- lib/classes/ZiggeoAnalytics.rb
|
37
37
|
- lib/classes/ZiggeoApplication.rb
|
38
|
+
- lib/classes/ZiggeoAudioStreams.rb
|
39
|
+
- lib/classes/ZiggeoAudios.rb
|
38
40
|
- lib/classes/ZiggeoAuth.rb
|
39
41
|
- lib/classes/ZiggeoAuthtokens.rb
|
40
42
|
- lib/classes/ZiggeoConfig.rb
|
@@ -65,7 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
65
67
|
- !ruby/object:Gem::Version
|
66
68
|
version: '0'
|
67
69
|
requirements: []
|
68
|
-
rubygems_version: 3.0.3
|
70
|
+
rubygems_version: 3.0.3.1
|
69
71
|
signing_key:
|
70
72
|
specification_version: 4
|
71
73
|
summary: The Ziggeo ServerSDK gem.
|