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
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: c044286b34bcbcef33adfecdf11fe6d7cd281e3d
|
4
|
+
data.tar.gz: be863724c59f4df580a769964941a57ca1bf4670
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 549949bdd03950358abaf3b710bd82845bbdd607f3883b1b42e198ac368c0a7451c1d57392eee185b38e41381c5243c5c544d373a58bff53d78b5da70299c412
|
7
|
+
data.tar.gz: 2a78a10f98b5d2b3db13a90066a63feaeccc47c54ad6ae59517b4bf888dfc5fbf187ab8d7484d5555c58dc0006597de44b43183824fb50b23bb1c5bad4361cb7
|
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,58 @@
|
|
1
|
+
# Telestream Cloud Quality Control Ruby SDK
|
2
|
+
|
3
|
+
This library provides a low-level interface to the REST API of Telestream Cloud, the online video encoding service.
|
4
|
+
|
5
|
+
## Getting Started
|
6
|
+
|
7
|
+
## Documentation for API Endpoints
|
8
|
+
|
9
|
+
All URIs are relative to *https://api.cloud.telestream.net/qc/v1.0*
|
10
|
+
|
11
|
+
Class | Method | HTTP request | Description
|
12
|
+
------------ | ------------- | ------------- | -------------
|
13
|
+
*TelestreamCloud::Qc::QcApi* | [**cancel_job**](docs/QcApi.md#cancel_job) | **PUT** /projects/{project_id}/jobs/{job_id}/cancel.json |
|
14
|
+
*TelestreamCloud::Qc::QcApi* | [**create_job**](docs/QcApi.md#create_job) | **POST** /projects/{project_id}/jobs.json | Create a new job
|
15
|
+
*TelestreamCloud::Qc::QcApi* | [**create_project**](docs/QcApi.md#create_project) | **POST** /projects.json | Create a new project
|
16
|
+
*TelestreamCloud::Qc::QcApi* | [**get_job**](docs/QcApi.md#get_job) | **GET** /projects/{project_id}/jobs/{job_id}.json | Get QC job
|
17
|
+
*TelestreamCloud::Qc::QcApi* | [**get_project**](docs/QcApi.md#get_project) | **GET** /projects/{project_id}.json | Get project by Id
|
18
|
+
*TelestreamCloud::Qc::QcApi* | [**list_jobs**](docs/QcApi.md#list_jobs) | **GET** /projects/{project_id}/jobs.json | Get jobs form projects
|
19
|
+
*TelestreamCloud::Qc::QcApi* | [**list_projects**](docs/QcApi.md#list_projects) | **GET** /projects.json | List all projects for an account
|
20
|
+
*TelestreamCloud::Qc::QcApi* | [**modify_project**](docs/QcApi.md#modify_project) | **PUT** /projects/{project_id}.json | Modify project
|
21
|
+
*TelestreamCloud::Qc::QcApi* | [**proxy**](docs/QcApi.md#proxy) | **GET** /projects/{project_id}/jobs/{job_id}/proxy.json |
|
22
|
+
*TelestreamCloud::Qc::QcApi* | [**remove_job**](docs/QcApi.md#remove_job) | **DELETE** /projects/{project_id}/jobs/{job_id}.json |
|
23
|
+
*TelestreamCloud::Qc::QcApi* | [**remove_project**](docs/QcApi.md#remove_project) | **DELETE** /projects/{project_id}.json |
|
24
|
+
*TelestreamCloud::Qc::QcApi* | [**signed_urls**](docs/QcApi.md#signed_urls) | **GET** /projects/{project_id}/jobs/{job_id}/signed-urls.json |
|
25
|
+
*TelestreamCloud::Qc::QcApi* | [**upload_video**](docs/QcApi.md#upload_video) | **POST** /projects/{project_id}/upload.json | Creates an upload session
|
26
|
+
|
27
|
+
|
28
|
+
## Documentation for Models
|
29
|
+
|
30
|
+
- [TelestreamCloud::Qc::Alert](docs/Alert.md)
|
31
|
+
- [TelestreamCloud::Qc::AudioStream](docs/AudioStream.md)
|
32
|
+
- [TelestreamCloud::Qc::Container](docs/Container.md)
|
33
|
+
- [TelestreamCloud::Qc::Data](docs/Data.md)
|
34
|
+
- [TelestreamCloud::Qc::Data1](docs/Data1.md)
|
35
|
+
- [TelestreamCloud::Qc::ExtraFile](docs/ExtraFile.md)
|
36
|
+
- [TelestreamCloud::Qc::Job](docs/Job.md)
|
37
|
+
- [TelestreamCloud::Qc::JobData](docs/JobData.md)
|
38
|
+
- [TelestreamCloud::Qc::JobDetails](docs/JobDetails.md)
|
39
|
+
- [TelestreamCloud::Qc::JobDetailsResult](docs/JobDetailsResult.md)
|
40
|
+
- [TelestreamCloud::Qc::JobsCollection](docs/JobsCollection.md)
|
41
|
+
- [TelestreamCloud::Qc::Media](docs/Media.md)
|
42
|
+
- [TelestreamCloud::Qc::Options](docs/Options.md)
|
43
|
+
- [TelestreamCloud::Qc::Project](docs/Project.md)
|
44
|
+
- [TelestreamCloud::Qc::Proxy](docs/Proxy.md)
|
45
|
+
- [TelestreamCloud::Qc::UploadSession](docs/UploadSession.md)
|
46
|
+
- [TelestreamCloud::Qc::VideoStream](docs/VideoStream.md)
|
47
|
+
- [TelestreamCloud::Qc::VideoUploadBody](docs/VideoUploadBody.md)
|
48
|
+
|
49
|
+
|
50
|
+
## Documentation for Authorization
|
51
|
+
|
52
|
+
|
53
|
+
### apiKey
|
54
|
+
|
55
|
+
- **Type**: API key
|
56
|
+
- **API key parameter name**: X-Api-Key
|
57
|
+
- **Location**: HTTP header
|
58
|
+
|
data/Rakefile
ADDED
data/docs/Alert.md
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
# TelestreamCloud::Qc::Alert
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**level** | **String** | | [optional]
|
7
|
+
**info** | **String** | Extra information for an alert. | [optional]
|
8
|
+
**_begin** | **String** | Start time of alert. | [optional]
|
9
|
+
**_end** | **String** | End time of alert. | [optional]
|
10
|
+
**stream** | **Integer** | | [optional]
|
11
|
+
**detail** | **String** | | [optional]
|
12
|
+
|
13
|
+
|
data/docs/AudioStream.md
ADDED
@@ -0,0 +1,13 @@
|
|
1
|
+
# TelestreamCloud::Qc::AudioStream
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**duration** | **Float** | Audio duration measured in seconds. | [optional]
|
7
|
+
**codec** | **String** | Audio codec name. | [optional]
|
8
|
+
**channels** | **Integer** | Number of audio channels. | [optional]
|
9
|
+
**program** | **String** | | [optional]
|
10
|
+
**bitrate** | **Integer** | Audio bitrate measured in bps | [optional]
|
11
|
+
**sample_rate** | **Integer** | Sample rate measured in Hz. | [optional]
|
12
|
+
|
13
|
+
|
data/docs/Container.md
ADDED
data/docs/Data.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# TelestreamCloud::Qc::Data
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | Human-readable identifier of a Project. | [optional]
|
7
|
+
**template** | **String** | Name of QC template. | [optional]
|
8
|
+
**options** | [**Options**](Options.md) | | [optional]
|
9
|
+
|
10
|
+
|
data/docs/Data1.md
ADDED
data/docs/ExtraFile.md
ADDED
data/docs/Job.md
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
# TelestreamCloud::Qc::Job
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | | [optional]
|
7
|
+
**status** | **String** | | [optional]
|
8
|
+
**duration** | **Integer** | | [optional]
|
9
|
+
**type** | **String** | | [optional]
|
10
|
+
**details** | [**JobDetails**](JobDetails.md) | | [optional]
|
11
|
+
|
12
|
+
|
data/docs/JobData.md
ADDED
data/docs/JobDetails.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# TelestreamCloud::Qc::JobDetails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**media** | [**Array<Media>**](Media.md) | | [optional]
|
7
|
+
**result** | [**JobDetailsResult**](JobDetailsResult.md) | | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# TelestreamCloud::Qc::JobsCollection
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**jobs** | [**Array<Job>**](Job.md) | | [optional]
|
7
|
+
**page** | **Integer** | A number of the fetched page. | [optional]
|
8
|
+
**per_page** | **Integer** | A number of jobs per page. | [optional]
|
9
|
+
**page_count** | **Integer** | A number of all pages. | [optional]
|
10
|
+
**total_count** | **Integer** | A number of all jobs stored in the db. | [optional]
|
11
|
+
|
12
|
+
|
data/docs/Media.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# TelestreamCloud::Qc::Media
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**audio** | [**Array<AudioStream>**](AudioStream.md) | | [optional]
|
7
|
+
**video** | [**Array<VideoStream>**](VideoStream.md) | | [optional]
|
8
|
+
**container** | [**Container**](Container.md) | | [optional]
|
9
|
+
|
10
|
+
|
data/docs/Options.md
ADDED
data/docs/Project.md
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
# TelestreamCloud::Qc::Project
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | A unique identifier of a Project. | [optional]
|
7
|
+
**name** | **String** | Human-readable identifier of a Project. | [optional]
|
8
|
+
**status** | **String** | Project status. | [optional]
|
9
|
+
**template** | **String** | Name of QC template. | [optional]
|
10
|
+
**options** | **String** | JSON with specific options | [optional]
|
11
|
+
|
12
|
+
|
data/docs/Proxy.md
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
# TelestreamCloud::Qc::Proxy
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**status** | **String** | | [optional]
|
7
|
+
**progress** | **Integer** | | [optional]
|
8
|
+
**url** | **String** | | [optional]
|
9
|
+
**id** | **String** | | [optional]
|
10
|
+
**updated_at** | **String** | | [optional]
|
11
|
+
|
12
|
+
|