telestream_cloud_qc 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/README.md +58 -0
- data/Rakefile +8 -0
- data/docs/Alert.md +13 -0
- data/docs/AudioStream.md +13 -0
- data/docs/Container.md +9 -0
- data/docs/Data.md +10 -0
- data/docs/Data1.md +9 -0
- data/docs/ExtraFile.md +10 -0
- data/docs/Job.md +12 -0
- data/docs/JobData.md +9 -0
- data/docs/JobDetails.md +9 -0
- data/docs/JobDetailsResult.md +8 -0
- data/docs/JobsCollection.md +12 -0
- data/docs/Media.md +10 -0
- data/docs/Options.md +7 -0
- data/docs/Project.md +12 -0
- data/docs/Proxy.md +12 -0
- data/docs/QcApi.md +719 -0
- data/docs/UploadSession.md +13 -0
- data/docs/VideoStream.md +13 -0
- data/docs/VideoUploadBody.md +12 -0
- data/git_push.sh +55 -0
- data/lib/telestream_cloud_qc/api/qc_api.rb +781 -0
- data/lib/telestream_cloud_qc/api_client.rb +389 -0
- data/lib/telestream_cloud_qc/api_error.rb +38 -0
- data/lib/telestream_cloud_qc/configuration.rb +209 -0
- data/lib/telestream_cloud_qc/models/alert.rb +236 -0
- data/lib/telestream_cloud_qc/models/audio_stream.rb +238 -0
- data/lib/telestream_cloud_qc/models/container.rb +198 -0
- data/lib/telestream_cloud_qc/models/data.rb +208 -0
- data/lib/telestream_cloud_qc/models/data_1.rb +197 -0
- data/lib/telestream_cloud_qc/models/extra_file.rb +221 -0
- data/lib/telestream_cloud_qc/models/job.rb +269 -0
- data/lib/telestream_cloud_qc/models/job_data.rb +197 -0
- data/lib/telestream_cloud_qc/models/job_details.rb +199 -0
- data/lib/telestream_cloud_qc/models/job_details_result.rb +190 -0
- data/lib/telestream_cloud_qc/models/jobs_collection.rb +230 -0
- data/lib/telestream_cloud_qc/models/media.rb +210 -0
- data/lib/telestream_cloud_qc/models/options.rb +179 -0
- data/lib/telestream_cloud_qc/models/project.rb +262 -0
- data/lib/telestream_cloud_qc/models/proxy.rb +224 -0
- data/lib/telestream_cloud_qc/models/upload_session.rb +249 -0
- data/lib/telestream_cloud_qc/models/video_stream.rb +235 -0
- data/lib/telestream_cloud_qc/models/video_upload_body.rb +242 -0
- data/lib/telestream_cloud_qc/uploader.rb +244 -0
- data/lib/telestream_cloud_qc/version.rb +18 -0
- data/lib/telestream_cloud_qc.rb +64 -0
- data/spec/api/qc_api_spec.rb +202 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/alert_spec.rb +72 -0
- data/spec/models/audio_stream_spec.rb +72 -0
- data/spec/models/container_spec.rb +48 -0
- data/spec/models/data_1_spec.rb +48 -0
- data/spec/models/data_spec.rb +54 -0
- data/spec/models/extra_file_spec.rb +54 -0
- data/spec/models/job_data_spec.rb +48 -0
- data/spec/models/job_details_result_spec.rb +42 -0
- data/spec/models/job_details_spec.rb +48 -0
- data/spec/models/job_spec.rb +74 -0
- data/spec/models/jobs_collection_spec.rb +66 -0
- data/spec/models/media_spec.rb +54 -0
- data/spec/models/options_spec.rb +36 -0
- data/spec/models/project_spec.rb +70 -0
- data/spec/models/proxy_spec.rb +66 -0
- data/spec/models/upload_session_spec.rb +72 -0
- data/spec/models/video_stream_spec.rb +72 -0
- data/spec/models/video_upload_body_spec.rb +66 -0
- data/spec/spec_helper.rb +111 -0
- data/telestream_cloud_qc.gemspec +47 -0
- metadata +336 -0
data/docs/QcApi.md
ADDED
@@ -0,0 +1,719 @@
|
|
1
|
+
# TelestreamCloud::Qc::QcApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.cloud.telestream.net/qc/v1.0*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**cancel_job**](QcApi.md#cancel_job) | **PUT** /projects/{project_id}/jobs/{job_id}/cancel.json |
|
8
|
+
[**create_job**](QcApi.md#create_job) | **POST** /projects/{project_id}/jobs.json | Create a new job
|
9
|
+
[**create_project**](QcApi.md#create_project) | **POST** /projects.json | Create a new project
|
10
|
+
[**get_job**](QcApi.md#get_job) | **GET** /projects/{project_id}/jobs/{job_id}.json | Get QC job
|
11
|
+
[**get_project**](QcApi.md#get_project) | **GET** /projects/{project_id}.json | Get project by Id
|
12
|
+
[**list_jobs**](QcApi.md#list_jobs) | **GET** /projects/{project_id}/jobs.json | Get jobs form projects
|
13
|
+
[**list_projects**](QcApi.md#list_projects) | **GET** /projects.json | List all projects for an account
|
14
|
+
[**modify_project**](QcApi.md#modify_project) | **PUT** /projects/{project_id}.json | Modify project
|
15
|
+
[**proxy**](QcApi.md#proxy) | **GET** /projects/{project_id}/jobs/{job_id}/proxy.json |
|
16
|
+
[**remove_job**](QcApi.md#remove_job) | **DELETE** /projects/{project_id}/jobs/{job_id}.json |
|
17
|
+
[**remove_project**](QcApi.md#remove_project) | **DELETE** /projects/{project_id}.json |
|
18
|
+
[**signed_urls**](QcApi.md#signed_urls) | **GET** /projects/{project_id}/jobs/{job_id}/signed-urls.json |
|
19
|
+
[**upload_video**](QcApi.md#upload_video) | **POST** /projects/{project_id}/upload.json | Creates an upload session
|
20
|
+
|
21
|
+
|
22
|
+
# **cancel_job**
|
23
|
+
> cancel_job(project_id, job_id)
|
24
|
+
|
25
|
+
|
26
|
+
|
27
|
+
### Example
|
28
|
+
```ruby
|
29
|
+
# load the gem
|
30
|
+
require 'telestream_cloud_qc'
|
31
|
+
# setup authorization
|
32
|
+
TelestreamCloud::Qc.configure do |config|
|
33
|
+
# Configure API key authorization: apiKey
|
34
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
35
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
36
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
37
|
+
end
|
38
|
+
|
39
|
+
api_instance = TelestreamCloud::Qc::QcApi.new
|
40
|
+
|
41
|
+
project_id = "project_id_example" # String | A unique identifier of a Project.
|
42
|
+
|
43
|
+
job_id = "job_id_example" # String | A unique identifier of a Job.
|
44
|
+
|
45
|
+
|
46
|
+
begin
|
47
|
+
api_instance.cancel_job(project_id, job_id)
|
48
|
+
rescue TelestreamCloud::Qc::ApiError => e
|
49
|
+
puts "Exception when calling QcApi->cancel_job: #{e}"
|
50
|
+
end
|
51
|
+
```
|
52
|
+
|
53
|
+
### Parameters
|
54
|
+
|
55
|
+
Name | Type | Description | Notes
|
56
|
+
------------- | ------------- | ------------- | -------------
|
57
|
+
**project_id** | **String**| A unique identifier of a Project. |
|
58
|
+
**job_id** | **String**| A unique identifier of a Job. |
|
59
|
+
|
60
|
+
### Return type
|
61
|
+
|
62
|
+
nil (empty response body)
|
63
|
+
|
64
|
+
### Authorization
|
65
|
+
|
66
|
+
[apiKey](../README.md#apiKey)
|
67
|
+
|
68
|
+
### HTTP request headers
|
69
|
+
|
70
|
+
- **Content-Type**: application/json
|
71
|
+
- **Accept**: application/json
|
72
|
+
|
73
|
+
|
74
|
+
|
75
|
+
# **create_job**
|
76
|
+
> Job create_job(project_id, data)
|
77
|
+
|
78
|
+
Create a new job
|
79
|
+
|
80
|
+
### Example
|
81
|
+
```ruby
|
82
|
+
# load the gem
|
83
|
+
require 'telestream_cloud_qc'
|
84
|
+
# setup authorization
|
85
|
+
TelestreamCloud::Qc.configure do |config|
|
86
|
+
# Configure API key authorization: apiKey
|
87
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
88
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
89
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
90
|
+
end
|
91
|
+
|
92
|
+
api_instance = TelestreamCloud::Qc::QcApi.new
|
93
|
+
|
94
|
+
project_id = "project_id_example" # String | A unique identifier of a Project.
|
95
|
+
|
96
|
+
data = TelestreamCloud::Qc::JobData.new # JobData |
|
97
|
+
|
98
|
+
|
99
|
+
begin
|
100
|
+
#Create a new job
|
101
|
+
result = api_instance.create_job(project_id, data)
|
102
|
+
p result
|
103
|
+
rescue TelestreamCloud::Qc::ApiError => e
|
104
|
+
puts "Exception when calling QcApi->create_job: #{e}"
|
105
|
+
end
|
106
|
+
```
|
107
|
+
|
108
|
+
### Parameters
|
109
|
+
|
110
|
+
Name | Type | Description | Notes
|
111
|
+
------------- | ------------- | ------------- | -------------
|
112
|
+
**project_id** | **String**| A unique identifier of a Project. |
|
113
|
+
**data** | [**JobData**](JobData.md)| |
|
114
|
+
|
115
|
+
### Return type
|
116
|
+
|
117
|
+
[**Job**](Job.md)
|
118
|
+
|
119
|
+
### Authorization
|
120
|
+
|
121
|
+
[apiKey](../README.md#apiKey)
|
122
|
+
|
123
|
+
### HTTP request headers
|
124
|
+
|
125
|
+
- **Content-Type**: application/json
|
126
|
+
- **Accept**: application/json
|
127
|
+
|
128
|
+
|
129
|
+
|
130
|
+
# **create_project**
|
131
|
+
> Project create_project(opts)
|
132
|
+
|
133
|
+
Create a new project
|
134
|
+
|
135
|
+
### Example
|
136
|
+
```ruby
|
137
|
+
# load the gem
|
138
|
+
require 'telestream_cloud_qc'
|
139
|
+
# setup authorization
|
140
|
+
TelestreamCloud::Qc.configure do |config|
|
141
|
+
# Configure API key authorization: apiKey
|
142
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
143
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
144
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
145
|
+
end
|
146
|
+
|
147
|
+
api_instance = TelestreamCloud::Qc::QcApi.new
|
148
|
+
|
149
|
+
opts = {
|
150
|
+
data: TelestreamCloud::Qc::Data.new # Data |
|
151
|
+
}
|
152
|
+
|
153
|
+
begin
|
154
|
+
#Create a new project
|
155
|
+
result = api_instance.create_project(opts)
|
156
|
+
p result
|
157
|
+
rescue TelestreamCloud::Qc::ApiError => e
|
158
|
+
puts "Exception when calling QcApi->create_project: #{e}"
|
159
|
+
end
|
160
|
+
```
|
161
|
+
|
162
|
+
### Parameters
|
163
|
+
|
164
|
+
Name | Type | Description | Notes
|
165
|
+
------------- | ------------- | ------------- | -------------
|
166
|
+
**data** | [**Data**](Data.md)| | [optional]
|
167
|
+
|
168
|
+
### Return type
|
169
|
+
|
170
|
+
[**Project**](Project.md)
|
171
|
+
|
172
|
+
### Authorization
|
173
|
+
|
174
|
+
[apiKey](../README.md#apiKey)
|
175
|
+
|
176
|
+
### HTTP request headers
|
177
|
+
|
178
|
+
- **Content-Type**: application/json
|
179
|
+
- **Accept**: application/json
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
# **get_job**
|
184
|
+
> Job get_job(project_id, job_id)
|
185
|
+
|
186
|
+
Get QC job
|
187
|
+
|
188
|
+
### Example
|
189
|
+
```ruby
|
190
|
+
# load the gem
|
191
|
+
require 'telestream_cloud_qc'
|
192
|
+
# setup authorization
|
193
|
+
TelestreamCloud::Qc.configure do |config|
|
194
|
+
# Configure API key authorization: apiKey
|
195
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
196
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
197
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
198
|
+
end
|
199
|
+
|
200
|
+
api_instance = TelestreamCloud::Qc::QcApi.new
|
201
|
+
|
202
|
+
project_id = "project_id_example" # String | A unique identifier of a Project.
|
203
|
+
|
204
|
+
job_id = "job_id_example" # String | A unique identifier of a Job.
|
205
|
+
|
206
|
+
|
207
|
+
begin
|
208
|
+
#Get QC job
|
209
|
+
result = api_instance.get_job(project_id, job_id)
|
210
|
+
p result
|
211
|
+
rescue TelestreamCloud::Qc::ApiError => e
|
212
|
+
puts "Exception when calling QcApi->get_job: #{e}"
|
213
|
+
end
|
214
|
+
```
|
215
|
+
|
216
|
+
### Parameters
|
217
|
+
|
218
|
+
Name | Type | Description | Notes
|
219
|
+
------------- | ------------- | ------------- | -------------
|
220
|
+
**project_id** | **String**| A unique identifier of a Project. |
|
221
|
+
**job_id** | **String**| A unique identifier of a Job. |
|
222
|
+
|
223
|
+
### Return type
|
224
|
+
|
225
|
+
[**Job**](Job.md)
|
226
|
+
|
227
|
+
### Authorization
|
228
|
+
|
229
|
+
[apiKey](../README.md#apiKey)
|
230
|
+
|
231
|
+
### HTTP request headers
|
232
|
+
|
233
|
+
- **Content-Type**: application/json
|
234
|
+
- **Accept**: application/json
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
# **get_project**
|
239
|
+
> Project get_project(project_id)
|
240
|
+
|
241
|
+
Get project by Id
|
242
|
+
|
243
|
+
### Example
|
244
|
+
```ruby
|
245
|
+
# load the gem
|
246
|
+
require 'telestream_cloud_qc'
|
247
|
+
# setup authorization
|
248
|
+
TelestreamCloud::Qc.configure do |config|
|
249
|
+
# Configure API key authorization: apiKey
|
250
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
251
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
252
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
253
|
+
end
|
254
|
+
|
255
|
+
api_instance = TelestreamCloud::Qc::QcApi.new
|
256
|
+
|
257
|
+
project_id = "project_id_example" # String | A unique identifier of a Project.
|
258
|
+
|
259
|
+
|
260
|
+
begin
|
261
|
+
#Get project by Id
|
262
|
+
result = api_instance.get_project(project_id)
|
263
|
+
p result
|
264
|
+
rescue TelestreamCloud::Qc::ApiError => e
|
265
|
+
puts "Exception when calling QcApi->get_project: #{e}"
|
266
|
+
end
|
267
|
+
```
|
268
|
+
|
269
|
+
### Parameters
|
270
|
+
|
271
|
+
Name | Type | Description | Notes
|
272
|
+
------------- | ------------- | ------------- | -------------
|
273
|
+
**project_id** | **String**| A unique identifier of a Project. |
|
274
|
+
|
275
|
+
### Return type
|
276
|
+
|
277
|
+
[**Project**](Project.md)
|
278
|
+
|
279
|
+
### Authorization
|
280
|
+
|
281
|
+
[apiKey](../README.md#apiKey)
|
282
|
+
|
283
|
+
### HTTP request headers
|
284
|
+
|
285
|
+
- **Content-Type**: application/json
|
286
|
+
- **Accept**: application/json
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
# **list_jobs**
|
291
|
+
> JobsCollection list_jobs(project_id, opts)
|
292
|
+
|
293
|
+
Get jobs form projects
|
294
|
+
|
295
|
+
### Example
|
296
|
+
```ruby
|
297
|
+
# load the gem
|
298
|
+
require 'telestream_cloud_qc'
|
299
|
+
# setup authorization
|
300
|
+
TelestreamCloud::Qc.configure do |config|
|
301
|
+
# Configure API key authorization: apiKey
|
302
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
303
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
304
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
305
|
+
end
|
306
|
+
|
307
|
+
api_instance = TelestreamCloud::Qc::QcApi.new
|
308
|
+
|
309
|
+
project_id = "project_id_example" # String | A unique identifier of a Project.
|
310
|
+
|
311
|
+
opts = {
|
312
|
+
expand: true, # BOOLEAN | Expand details of job
|
313
|
+
status: "status_example", # String | Filter jobs by status
|
314
|
+
per_page: 30, # Integer | Limit number of listed jobs
|
315
|
+
page: 56 # Integer | Index of jobs page to be listed
|
316
|
+
}
|
317
|
+
|
318
|
+
begin
|
319
|
+
#Get jobs form projects
|
320
|
+
result = api_instance.list_jobs(project_id, opts)
|
321
|
+
p result
|
322
|
+
rescue TelestreamCloud::Qc::ApiError => e
|
323
|
+
puts "Exception when calling QcApi->list_jobs: #{e}"
|
324
|
+
end
|
325
|
+
```
|
326
|
+
|
327
|
+
### Parameters
|
328
|
+
|
329
|
+
Name | Type | Description | Notes
|
330
|
+
------------- | ------------- | ------------- | -------------
|
331
|
+
**project_id** | **String**| A unique identifier of a Project. |
|
332
|
+
**expand** | **BOOLEAN**| Expand details of job | [optional]
|
333
|
+
**status** | **String**| Filter jobs by status | [optional]
|
334
|
+
**per_page** | **Integer**| Limit number of listed jobs | [optional] [default to 30]
|
335
|
+
**page** | **Integer**| Index of jobs page to be listed | [optional]
|
336
|
+
|
337
|
+
### Return type
|
338
|
+
|
339
|
+
[**JobsCollection**](JobsCollection.md)
|
340
|
+
|
341
|
+
### Authorization
|
342
|
+
|
343
|
+
[apiKey](../README.md#apiKey)
|
344
|
+
|
345
|
+
### HTTP request headers
|
346
|
+
|
347
|
+
- **Content-Type**: application/json
|
348
|
+
- **Accept**: application/json
|
349
|
+
|
350
|
+
|
351
|
+
|
352
|
+
# **list_projects**
|
353
|
+
> Array<Project> list_projects
|
354
|
+
|
355
|
+
List all projects for an account
|
356
|
+
|
357
|
+
### Example
|
358
|
+
```ruby
|
359
|
+
# load the gem
|
360
|
+
require 'telestream_cloud_qc'
|
361
|
+
# setup authorization
|
362
|
+
TelestreamCloud::Qc.configure do |config|
|
363
|
+
# Configure API key authorization: apiKey
|
364
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
365
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
366
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
367
|
+
end
|
368
|
+
|
369
|
+
api_instance = TelestreamCloud::Qc::QcApi.new
|
370
|
+
|
371
|
+
begin
|
372
|
+
#List all projects for an account
|
373
|
+
result = api_instance.list_projects
|
374
|
+
p result
|
375
|
+
rescue TelestreamCloud::Qc::ApiError => e
|
376
|
+
puts "Exception when calling QcApi->list_projects: #{e}"
|
377
|
+
end
|
378
|
+
```
|
379
|
+
|
380
|
+
### Parameters
|
381
|
+
This endpoint does not need any parameter.
|
382
|
+
|
383
|
+
### Return type
|
384
|
+
|
385
|
+
[**Array<Project>**](Project.md)
|
386
|
+
|
387
|
+
### Authorization
|
388
|
+
|
389
|
+
[apiKey](../README.md#apiKey)
|
390
|
+
|
391
|
+
### HTTP request headers
|
392
|
+
|
393
|
+
- **Content-Type**: application/json
|
394
|
+
- **Accept**: application/json
|
395
|
+
|
396
|
+
|
397
|
+
|
398
|
+
# **modify_project**
|
399
|
+
> Project modify_project(project_id, opts)
|
400
|
+
|
401
|
+
Modify project
|
402
|
+
|
403
|
+
### Example
|
404
|
+
```ruby
|
405
|
+
# load the gem
|
406
|
+
require 'telestream_cloud_qc'
|
407
|
+
# setup authorization
|
408
|
+
TelestreamCloud::Qc.configure do |config|
|
409
|
+
# Configure API key authorization: apiKey
|
410
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
411
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
412
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
413
|
+
end
|
414
|
+
|
415
|
+
api_instance = TelestreamCloud::Qc::QcApi.new
|
416
|
+
|
417
|
+
project_id = "project_id_example" # String |
|
418
|
+
|
419
|
+
opts = {
|
420
|
+
data: TelestreamCloud::Qc::Data1.new # Data1 |
|
421
|
+
}
|
422
|
+
|
423
|
+
begin
|
424
|
+
#Modify project
|
425
|
+
result = api_instance.modify_project(project_id, opts)
|
426
|
+
p result
|
427
|
+
rescue TelestreamCloud::Qc::ApiError => e
|
428
|
+
puts "Exception when calling QcApi->modify_project: #{e}"
|
429
|
+
end
|
430
|
+
```
|
431
|
+
|
432
|
+
### Parameters
|
433
|
+
|
434
|
+
Name | Type | Description | Notes
|
435
|
+
------------- | ------------- | ------------- | -------------
|
436
|
+
**project_id** | **String**| |
|
437
|
+
**data** | [**Data1**](Data1.md)| | [optional]
|
438
|
+
|
439
|
+
### Return type
|
440
|
+
|
441
|
+
[**Project**](Project.md)
|
442
|
+
|
443
|
+
### Authorization
|
444
|
+
|
445
|
+
[apiKey](../README.md#apiKey)
|
446
|
+
|
447
|
+
### HTTP request headers
|
448
|
+
|
449
|
+
- **Content-Type**: application/json
|
450
|
+
- **Accept**: application/json
|
451
|
+
|
452
|
+
|
453
|
+
|
454
|
+
# **proxy**
|
455
|
+
> Proxy proxy(project_id, job_id)
|
456
|
+
|
457
|
+
|
458
|
+
|
459
|
+
### Example
|
460
|
+
```ruby
|
461
|
+
# load the gem
|
462
|
+
require 'telestream_cloud_qc'
|
463
|
+
# setup authorization
|
464
|
+
TelestreamCloud::Qc.configure do |config|
|
465
|
+
# Configure API key authorization: apiKey
|
466
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
467
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
468
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
469
|
+
end
|
470
|
+
|
471
|
+
api_instance = TelestreamCloud::Qc::QcApi.new
|
472
|
+
|
473
|
+
project_id = "project_id_example" # String | A unique identifier of a Project.
|
474
|
+
|
475
|
+
job_id = "job_id_example" # String | A unique identifier of a Job.
|
476
|
+
|
477
|
+
|
478
|
+
begin
|
479
|
+
result = api_instance.proxy(project_id, job_id)
|
480
|
+
p result
|
481
|
+
rescue TelestreamCloud::Qc::ApiError => e
|
482
|
+
puts "Exception when calling QcApi->proxy: #{e}"
|
483
|
+
end
|
484
|
+
```
|
485
|
+
|
486
|
+
### Parameters
|
487
|
+
|
488
|
+
Name | Type | Description | Notes
|
489
|
+
------------- | ------------- | ------------- | -------------
|
490
|
+
**project_id** | **String**| A unique identifier of a Project. |
|
491
|
+
**job_id** | **String**| A unique identifier of a Job. |
|
492
|
+
|
493
|
+
### Return type
|
494
|
+
|
495
|
+
[**Proxy**](Proxy.md)
|
496
|
+
|
497
|
+
### Authorization
|
498
|
+
|
499
|
+
[apiKey](../README.md#apiKey)
|
500
|
+
|
501
|
+
### HTTP request headers
|
502
|
+
|
503
|
+
- **Content-Type**: application/json
|
504
|
+
- **Accept**: application/json
|
505
|
+
|
506
|
+
|
507
|
+
|
508
|
+
# **remove_job**
|
509
|
+
> remove_job(project_id, job_id)
|
510
|
+
|
511
|
+
|
512
|
+
|
513
|
+
### Example
|
514
|
+
```ruby
|
515
|
+
# load the gem
|
516
|
+
require 'telestream_cloud_qc'
|
517
|
+
# setup authorization
|
518
|
+
TelestreamCloud::Qc.configure do |config|
|
519
|
+
# Configure API key authorization: apiKey
|
520
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
521
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
522
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
523
|
+
end
|
524
|
+
|
525
|
+
api_instance = TelestreamCloud::Qc::QcApi.new
|
526
|
+
|
527
|
+
project_id = "project_id_example" # String | A unique identifier of a Project.
|
528
|
+
|
529
|
+
job_id = "job_id_example" # String | A unique identifier of a Job.
|
530
|
+
|
531
|
+
|
532
|
+
begin
|
533
|
+
api_instance.remove_job(project_id, job_id)
|
534
|
+
rescue TelestreamCloud::Qc::ApiError => e
|
535
|
+
puts "Exception when calling QcApi->remove_job: #{e}"
|
536
|
+
end
|
537
|
+
```
|
538
|
+
|
539
|
+
### Parameters
|
540
|
+
|
541
|
+
Name | Type | Description | Notes
|
542
|
+
------------- | ------------- | ------------- | -------------
|
543
|
+
**project_id** | **String**| A unique identifier of a Project. |
|
544
|
+
**job_id** | **String**| A unique identifier of a Job. |
|
545
|
+
|
546
|
+
### Return type
|
547
|
+
|
548
|
+
nil (empty response body)
|
549
|
+
|
550
|
+
### Authorization
|
551
|
+
|
552
|
+
[apiKey](../README.md#apiKey)
|
553
|
+
|
554
|
+
### HTTP request headers
|
555
|
+
|
556
|
+
- **Content-Type**: application/json
|
557
|
+
- **Accept**: application/json
|
558
|
+
|
559
|
+
|
560
|
+
|
561
|
+
# **remove_project**
|
562
|
+
> remove_project(project_id)
|
563
|
+
|
564
|
+
|
565
|
+
|
566
|
+
### Example
|
567
|
+
```ruby
|
568
|
+
# load the gem
|
569
|
+
require 'telestream_cloud_qc'
|
570
|
+
# setup authorization
|
571
|
+
TelestreamCloud::Qc.configure do |config|
|
572
|
+
# Configure API key authorization: apiKey
|
573
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
574
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
575
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
576
|
+
end
|
577
|
+
|
578
|
+
api_instance = TelestreamCloud::Qc::QcApi.new
|
579
|
+
|
580
|
+
project_id = "project_id_example" # String |
|
581
|
+
|
582
|
+
|
583
|
+
begin
|
584
|
+
api_instance.remove_project(project_id)
|
585
|
+
rescue TelestreamCloud::Qc::ApiError => e
|
586
|
+
puts "Exception when calling QcApi->remove_project: #{e}"
|
587
|
+
end
|
588
|
+
```
|
589
|
+
|
590
|
+
### Parameters
|
591
|
+
|
592
|
+
Name | Type | Description | Notes
|
593
|
+
------------- | ------------- | ------------- | -------------
|
594
|
+
**project_id** | **String**| |
|
595
|
+
|
596
|
+
### Return type
|
597
|
+
|
598
|
+
nil (empty response body)
|
599
|
+
|
600
|
+
### Authorization
|
601
|
+
|
602
|
+
[apiKey](../README.md#apiKey)
|
603
|
+
|
604
|
+
### HTTP request headers
|
605
|
+
|
606
|
+
- **Content-Type**: application/json
|
607
|
+
- **Accept**: application/json
|
608
|
+
|
609
|
+
|
610
|
+
|
611
|
+
# **signed_urls**
|
612
|
+
> Hash<String, String> signed_urls(project_id, job_id)
|
613
|
+
|
614
|
+
|
615
|
+
|
616
|
+
### Example
|
617
|
+
```ruby
|
618
|
+
# load the gem
|
619
|
+
require 'telestream_cloud_qc'
|
620
|
+
# setup authorization
|
621
|
+
TelestreamCloud::Qc.configure do |config|
|
622
|
+
# Configure API key authorization: apiKey
|
623
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
624
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
625
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
626
|
+
end
|
627
|
+
|
628
|
+
api_instance = TelestreamCloud::Qc::QcApi.new
|
629
|
+
|
630
|
+
project_id = "project_id_example" # String | A unique identifier of a Project.
|
631
|
+
|
632
|
+
job_id = "job_id_example" # String | A unique identifier of a Job.
|
633
|
+
|
634
|
+
|
635
|
+
begin
|
636
|
+
result = api_instance.signed_urls(project_id, job_id)
|
637
|
+
p result
|
638
|
+
rescue TelestreamCloud::Qc::ApiError => e
|
639
|
+
puts "Exception when calling QcApi->signed_urls: #{e}"
|
640
|
+
end
|
641
|
+
```
|
642
|
+
|
643
|
+
### Parameters
|
644
|
+
|
645
|
+
Name | Type | Description | Notes
|
646
|
+
------------- | ------------- | ------------- | -------------
|
647
|
+
**project_id** | **String**| A unique identifier of a Project. |
|
648
|
+
**job_id** | **String**| A unique identifier of a Job. |
|
649
|
+
|
650
|
+
### Return type
|
651
|
+
|
652
|
+
**Hash<String, String>**
|
653
|
+
|
654
|
+
### Authorization
|
655
|
+
|
656
|
+
[apiKey](../README.md#apiKey)
|
657
|
+
|
658
|
+
### HTTP request headers
|
659
|
+
|
660
|
+
- **Content-Type**: application/json
|
661
|
+
- **Accept**: application/json
|
662
|
+
|
663
|
+
|
664
|
+
|
665
|
+
# **upload_video**
|
666
|
+
> UploadSession upload_video(project_id, video_upload_body)
|
667
|
+
|
668
|
+
Creates an upload session
|
669
|
+
|
670
|
+
### Example
|
671
|
+
```ruby
|
672
|
+
# load the gem
|
673
|
+
require 'telestream_cloud_qc'
|
674
|
+
# setup authorization
|
675
|
+
TelestreamCloud::Qc.configure do |config|
|
676
|
+
# Configure API key authorization: apiKey
|
677
|
+
config.api_key['X-Api-Key'] = 'YOUR API KEY'
|
678
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
679
|
+
#config.api_key_prefix['X-Api-Key'] = 'Bearer'
|
680
|
+
end
|
681
|
+
|
682
|
+
api_instance = TelestreamCloud::Qc::QcApi.new
|
683
|
+
|
684
|
+
project_id = "project_id_example" # String | A unique identifier of a Project.
|
685
|
+
|
686
|
+
video_upload_body = TelestreamCloud::Qc::VideoUploadBody.new # VideoUploadBody |
|
687
|
+
|
688
|
+
|
689
|
+
begin
|
690
|
+
#Creates an upload session
|
691
|
+
result = api_instance.upload_video(project_id, video_upload_body)
|
692
|
+
p result
|
693
|
+
rescue TelestreamCloud::Qc::ApiError => e
|
694
|
+
puts "Exception when calling QcApi->upload_video: #{e}"
|
695
|
+
end
|
696
|
+
```
|
697
|
+
|
698
|
+
### Parameters
|
699
|
+
|
700
|
+
Name | Type | Description | Notes
|
701
|
+
------------- | ------------- | ------------- | -------------
|
702
|
+
**project_id** | **String**| A unique identifier of a Project. |
|
703
|
+
**video_upload_body** | [**VideoUploadBody**](VideoUploadBody.md)| |
|
704
|
+
|
705
|
+
### Return type
|
706
|
+
|
707
|
+
[**UploadSession**](UploadSession.md)
|
708
|
+
|
709
|
+
### Authorization
|
710
|
+
|
711
|
+
[apiKey](../README.md#apiKey)
|
712
|
+
|
713
|
+
### HTTP request headers
|
714
|
+
|
715
|
+
- **Content-Type**: application/json
|
716
|
+
- **Accept**: application/json
|
717
|
+
|
718
|
+
|
719
|
+
|