cloudmersive-video-api-client 2.0.2 → 2.0.3

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a2b1efa9645d3a85376d22f88ec694bea513150f0e8e544fb4ff3fcd15840c1d
4
- data.tar.gz: f5229cdac58afbe2f916db0220057293235fd4a16b8c1638ea22d64fa21c18a6
3
+ metadata.gz: da4725e4a5feed4bb521ed63697a3dfcf01a827f2b7640eef845ac6116f918cc
4
+ data.tar.gz: 840c01b7ce51c323ba7c5e7f5471e25cc2120a36f1e1f65a8fbcacee8bffe2ad
5
5
  SHA512:
6
- metadata.gz: 24eac0883003effe41bbdbe9cf73b434128db81aaab2a907e27cce05890b61aa0adecaecc24fb7e392e9e029e0e3d0a625d688d47e7b5347a6896486201cffc4
7
- data.tar.gz: 7c5f757af3f4f738607cf36126f0980db28b1a46f9eb6a97168782635ce1809b83b2b5f2c0b2a5a449a518b939ebb2c0087789351bc39bae207617177d6a81b5
6
+ metadata.gz: 8b405aa168bacecb7cfa106bfcf1e267f14e11b72b9f50a43e381605857dc6062b7a30582bd334ebd8ab57cce2356221a2e67291bc74dd1e7b7ccf7f4eade149
7
+ data.tar.gz: 898dfd32ed89064fd506cf847f92b9ce895fb140365cd9cc9a1434bc0115225e811c8a24ded82d6d0c7246d5dfdee1120b8c48f96f0493b8e45f4fd6f2b9f38f
data/README.md CHANGED
@@ -7,7 +7,7 @@ The video APIs help you convert, encode, and transcode videos.
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: v1
10
- - Package version: 2.0.2
10
+ - Package version: 2.0.3
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
 
13
13
  ## Installation
@@ -23,15 +23,15 @@ gem build cloudmersive-video-api-client.gemspec
23
23
  Then either install the gem locally:
24
24
 
25
25
  ```shell
26
- gem install ./cloudmersive-video-api-client-2.0.2.gem
26
+ gem install ./cloudmersive-video-api-client-2.0.3.gem
27
27
  ```
28
- (for development, run `gem install --dev ./cloudmersive-video-api-client-2.0.2.gem` to install the development dependencies)
28
+ (for development, run `gem install --dev ./cloudmersive-video-api-client-2.0.3.gem` to install the development dependencies)
29
29
 
30
30
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
31
31
 
32
32
  Finally add this to the Gemfile:
33
33
 
34
- gem 'cloudmersive-video-api-client', '~> 2.0.2'
34
+ gem 'cloudmersive-video-api-client', '~> 2.0.3'
35
35
 
36
36
  ### Install from Git
37
37
 
@@ -62,27 +62,20 @@ CloudmersiveVideoApiClient.configure do |config|
62
62
  #config.api_key_prefix['Apikey'] = 'Bearer'
63
63
  end
64
64
 
65
- api_instance = CloudmersiveVideoApiClient::VideoApi.new
66
-
67
- input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
65
+ api_instance = CloudmersiveVideoApiClient::AudioApi.new
68
66
 
69
67
  opts = {
70
- file_url: 'file_url_example', # String | Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
71
- max_width: 56, # Integer | Optional; Maximum width of the output video, up to the original video width. Defaults to 250 pixels.
72
- max_height: 56, # Integer | Optional; Maximum height of the output video, up to the original video width. Defaults to 250 pixels.
73
- preserve_aspect_ratio: true, # BOOLEAN | Optional; If false, the original video's aspect ratio will not be preserved, allowing customization of the aspect ratio using maxWidth and maxHeight, potentially skewing the video. Default is true.
74
- frame_rate: 56, # Integer | Optional; Specify the frame rate of the output video. Defaults to 24 frames per second.
75
- extend_processing_time: true, # BOOLEAN | Optional; If true, will allow additional processing time for the video file conversion, using one API call per additional minute over the 5 minute default processing time, up to a maximum of 25 total minutes. This is generally necessary for files larger than 500 MB or longer than 30 minutes.
76
- start_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Optional; Specify the desired starting time of the GIF video in TimeSpan format.
77
- time_span: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Optional; Specify the desired length of the GIF video in TimeSpan format. Limit is 30 minutes.
68
+ input_file: File.new('/path/to/file.txt'), # File | Input file to perform the operation on.
69
+ file_url: 'file_url_example', # String | Optional; URL of an audio file being used for conversion. Use this option for files larger than 2GB.
70
+ bit_rate: nil # Object | Optional; Specify the desired bitrate of the converted audio file in kilobytes per second (kB/s). Value may be between 48 and 1,411. By default, the optimal bitrate will be chosen automatically.
78
71
  }
79
72
 
80
73
  begin
81
- #Convert Video to Animated GIF format.
82
- result = api_instance.video_convert_to_gif(input_file, opts)
74
+ #Convert Audio File to AAC format.
75
+ result = api_instance.audio_convert_to_aac(opts)
83
76
  p result
84
77
  rescue CloudmersiveVideoApiClient::ApiError => e
85
- puts "Exception when calling VideoApi->video_convert_to_gif: #{e}"
78
+ puts "Exception when calling AudioApi->audio_convert_to_aac: #{e}"
86
79
  end
87
80
 
88
81
  ```
@@ -93,16 +86,32 @@ All URIs are relative to *https://api.cloudmersive.com*
93
86
 
94
87
  Class | Method | HTTP request | Description
95
88
  ------------ | ------------- | ------------- | -------------
89
+ *CloudmersiveVideoApiClient::AudioApi* | [**audio_convert_to_aac**](docs/AudioApi.md#audio_convert_to_aac) | **POST** /audio/convert/to/aac | Convert Audio File to AAC format.
90
+ *CloudmersiveVideoApiClient::AudioApi* | [**audio_convert_to_m4a**](docs/AudioApi.md#audio_convert_to_m4a) | **POST** /audio/convert/to/m4a | Convert Audio File to M4A format.
91
+ *CloudmersiveVideoApiClient::AudioApi* | [**audio_convert_to_mp3**](docs/AudioApi.md#audio_convert_to_mp3) | **POST** /audio/convert/to/mp3 | Convert Audio File to MP3 format.
92
+ *CloudmersiveVideoApiClient::AudioApi* | [**audio_convert_to_wav**](docs/AudioApi.md#audio_convert_to_wav) | **POST** /audio/convert/to/wav | Convert Audio File to WAV format.
96
93
  *CloudmersiveVideoApiClient::VideoApi* | [**video_convert_to_gif**](docs/VideoApi.md#video_convert_to_gif) | **POST** /video/convert/to/gif | Convert Video to Animated GIF format.
97
94
  *CloudmersiveVideoApiClient::VideoApi* | [**video_convert_to_mov**](docs/VideoApi.md#video_convert_to_mov) | **POST** /video/convert/to/mov | Convert Video to MOV format.
98
95
  *CloudmersiveVideoApiClient::VideoApi* | [**video_convert_to_mp4**](docs/VideoApi.md#video_convert_to_mp4) | **POST** /video/convert/to/mp4 | Convert Video to MP4 format.
96
+ *CloudmersiveVideoApiClient::VideoApi* | [**video_convert_to_still_frames**](docs/VideoApi.md#video_convert_to_still_frames) | **POST** /video/convert/to/still-frames | Convert Video to PNG Still Frames.
99
97
  *CloudmersiveVideoApiClient::VideoApi* | [**video_convert_to_webm**](docs/VideoApi.md#video_convert_to_webm) | **POST** /video/convert/to/webm | Convert Video to WEBM format.
98
+ *CloudmersiveVideoApiClient::VideoApi* | [**video_cut_video**](docs/VideoApi.md#video_cut_video) | **POST** /video/cut | Cut a Video to a Shorter Length
100
99
  *CloudmersiveVideoApiClient::VideoApi* | [**video_get_info**](docs/VideoApi.md#video_get_info) | **POST** /video/convert/get-info | Get detailed information about a video or audio file
100
+ *CloudmersiveVideoApiClient::VideoApi* | [**video_resize_video**](docs/VideoApi.md#video_resize_video) | **POST** /video/resize/preserveAspectRatio | Resizes a Video Preserving the Original Aspect Ratio.
101
+ *CloudmersiveVideoApiClient::VideoApi* | [**video_resize_video_simple**](docs/VideoApi.md#video_resize_video_simple) | **POST** /video/resize/target | Resizes a Video without Preserving Aspect Ratio.
102
+ *CloudmersiveVideoApiClient::VideoApi* | [**video_scan_for_nsfw**](docs/VideoApi.md#video_scan_for_nsfw) | **POST** /video/scan/nsfw | Scan a Video for NSFW content.
103
+ *CloudmersiveVideoApiClient::VideoApi* | [**video_split_video**](docs/VideoApi.md#video_split_video) | **POST** /video/split | Split a Video into Two Shorter Videos
101
104
 
102
105
 
103
106
  ## Documentation for Models
104
107
 
105
108
  - [CloudmersiveVideoApiClient::MediaInformation](docs/MediaInformation.md)
109
+ - [CloudmersiveVideoApiClient::NsfwResult](docs/NsfwResult.md)
110
+ - [CloudmersiveVideoApiClient::NsfwScannedFrame](docs/NsfwScannedFrame.md)
111
+ - [CloudmersiveVideoApiClient::SplitVideoResult](docs/SplitVideoResult.md)
112
+ - [CloudmersiveVideoApiClient::StillFrame](docs/StillFrame.md)
113
+ - [CloudmersiveVideoApiClient::StillFramesResult](docs/StillFramesResult.md)
114
+ - [CloudmersiveVideoApiClient::VideoFile](docs/VideoFile.md)
106
115
 
107
116
 
108
117
  ## Documentation for Authorization
@@ -0,0 +1,248 @@
1
+ # CloudmersiveVideoApiClient::AudioApi
2
+
3
+ All URIs are relative to *https://api.cloudmersive.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**audio_convert_to_aac**](AudioApi.md#audio_convert_to_aac) | **POST** /audio/convert/to/aac | Convert Audio File to AAC format.
8
+ [**audio_convert_to_m4a**](AudioApi.md#audio_convert_to_m4a) | **POST** /audio/convert/to/m4a | Convert Audio File to M4A format.
9
+ [**audio_convert_to_mp3**](AudioApi.md#audio_convert_to_mp3) | **POST** /audio/convert/to/mp3 | Convert Audio File to MP3 format.
10
+ [**audio_convert_to_wav**](AudioApi.md#audio_convert_to_wav) | **POST** /audio/convert/to/wav | Convert Audio File to WAV format.
11
+
12
+
13
+ # **audio_convert_to_aac**
14
+ > String audio_convert_to_aac(opts)
15
+
16
+ Convert Audio File to AAC format.
17
+
18
+ Automatically detect audio file format and convert it to AAC format. Supports many input audio formats, including AAC, FLAC, M4A, MP2, MP3, OGG, WMA, and WAV. Uses 1 API call per 10 MB of file size. Also uses 1 API call per additional minute of processing time over 5 minutes, up to a maximum of 25 minutes total processing time. Maximum output file size is 50GB.
19
+
20
+ ### Example
21
+ ```ruby
22
+ # load the gem
23
+ require 'cloudmersive-video-api-client'
24
+ # setup authorization
25
+ CloudmersiveVideoApiClient.configure do |config|
26
+ # Configure API key authorization: Apikey
27
+ config.api_key['Apikey'] = 'YOUR API KEY'
28
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
29
+ #config.api_key_prefix['Apikey'] = 'Bearer'
30
+ end
31
+
32
+ api_instance = CloudmersiveVideoApiClient::AudioApi.new
33
+
34
+ opts = {
35
+ input_file: File.new('/path/to/file.txt'), # File | Input file to perform the operation on.
36
+ file_url: 'file_url_example', # String | Optional; URL of an audio file being used for conversion. Use this option for files larger than 2GB.
37
+ bit_rate: nil # Object | Optional; Specify the desired bitrate of the converted audio file in kilobytes per second (kB/s). Value may be between 48 and 1,411. By default, the optimal bitrate will be chosen automatically.
38
+ }
39
+
40
+ begin
41
+ #Convert Audio File to AAC format.
42
+ result = api_instance.audio_convert_to_aac(opts)
43
+ p result
44
+ rescue CloudmersiveVideoApiClient::ApiError => e
45
+ puts "Exception when calling AudioApi->audio_convert_to_aac: #{e}"
46
+ end
47
+ ```
48
+
49
+ ### Parameters
50
+
51
+ Name | Type | Description | Notes
52
+ ------------- | ------------- | ------------- | -------------
53
+ **input_file** | **File**| Input file to perform the operation on. | [optional]
54
+ **file_url** | **String**| Optional; URL of an audio file being used for conversion. Use this option for files larger than 2GB. | [optional]
55
+ **bit_rate** | [**Object**](.md)| Optional; Specify the desired bitrate of the converted audio file in kilobytes per second (kB/s). Value may be between 48 and 1,411. By default, the optimal bitrate will be chosen automatically. | [optional]
56
+
57
+ ### Return type
58
+
59
+ **String**
60
+
61
+ ### Authorization
62
+
63
+ [Apikey](../README.md#Apikey)
64
+
65
+ ### HTTP request headers
66
+
67
+ - **Content-Type**: multipart/form-data
68
+ - **Accept**: application/json, text/json, application/xml, text/xml
69
+
70
+
71
+
72
+ # **audio_convert_to_m4a**
73
+ > String audio_convert_to_m4a(opts)
74
+
75
+ Convert Audio File to M4A format.
76
+
77
+ Automatically detect audio file format and convert it to M4A format. Supports many input audio formats, including AAC, FLAC, M4A, MP2, MP3, OGG, WMA, and WAV. Uses 1 API call per 10 MB of file size. Also uses 1 API call per additional minute of processing time over 5 minutes, up to a maximum of 25 minutes total processing time. Maximum output file size is 50GB.
78
+
79
+ ### Example
80
+ ```ruby
81
+ # load the gem
82
+ require 'cloudmersive-video-api-client'
83
+ # setup authorization
84
+ CloudmersiveVideoApiClient.configure do |config|
85
+ # Configure API key authorization: Apikey
86
+ config.api_key['Apikey'] = 'YOUR API KEY'
87
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
88
+ #config.api_key_prefix['Apikey'] = 'Bearer'
89
+ end
90
+
91
+ api_instance = CloudmersiveVideoApiClient::AudioApi.new
92
+
93
+ opts = {
94
+ input_file: File.new('/path/to/file.txt'), # File | Input file to perform the operation on.
95
+ file_url: 'file_url_example', # String | Optional; URL of an audio file being used for conversion. Use this option for files larger than 2GB.
96
+ bit_rate: nil # Object | Optional; Specify the desired bitrate of the converted audio file in kilobytes per second (kB/s). Value may be between 48 and 1,411. By default, the optimal bitrate will be chosen automatically.
97
+ }
98
+
99
+ begin
100
+ #Convert Audio File to M4A format.
101
+ result = api_instance.audio_convert_to_m4a(opts)
102
+ p result
103
+ rescue CloudmersiveVideoApiClient::ApiError => e
104
+ puts "Exception when calling AudioApi->audio_convert_to_m4a: #{e}"
105
+ end
106
+ ```
107
+
108
+ ### Parameters
109
+
110
+ Name | Type | Description | Notes
111
+ ------------- | ------------- | ------------- | -------------
112
+ **input_file** | **File**| Input file to perform the operation on. | [optional]
113
+ **file_url** | **String**| Optional; URL of an audio file being used for conversion. Use this option for files larger than 2GB. | [optional]
114
+ **bit_rate** | [**Object**](.md)| Optional; Specify the desired bitrate of the converted audio file in kilobytes per second (kB/s). Value may be between 48 and 1,411. By default, the optimal bitrate will be chosen automatically. | [optional]
115
+
116
+ ### Return type
117
+
118
+ **String**
119
+
120
+ ### Authorization
121
+
122
+ [Apikey](../README.md#Apikey)
123
+
124
+ ### HTTP request headers
125
+
126
+ - **Content-Type**: multipart/form-data
127
+ - **Accept**: application/json, text/json, application/xml, text/xml
128
+
129
+
130
+
131
+ # **audio_convert_to_mp3**
132
+ > String audio_convert_to_mp3(opts)
133
+
134
+ Convert Audio File to MP3 format.
135
+
136
+ Automatically detect audio file format and convert it to MP3 format. Supports many input audio formats, including AAC, FLAC, M4A, MP2, MP3, OGG, WMA, and WAV. Uses 1 API call per 10 MB of file size. Also uses 1 API call per additional minute of processing time over 5 minutes, up to a maximum of 25 minutes total processing time. Maximum output file size is 50GB.
137
+
138
+ ### Example
139
+ ```ruby
140
+ # load the gem
141
+ require 'cloudmersive-video-api-client'
142
+ # setup authorization
143
+ CloudmersiveVideoApiClient.configure do |config|
144
+ # Configure API key authorization: Apikey
145
+ config.api_key['Apikey'] = 'YOUR API KEY'
146
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
147
+ #config.api_key_prefix['Apikey'] = 'Bearer'
148
+ end
149
+
150
+ api_instance = CloudmersiveVideoApiClient::AudioApi.new
151
+
152
+ opts = {
153
+ input_file: File.new('/path/to/file.txt'), # File | Input file to perform the operation on.
154
+ file_url: 'file_url_example', # String | Optional; URL of an audio file being used for conversion. Use this option for files larger than 2GB.
155
+ bit_rate: nil # Object | Optional; Specify the desired bitrate of the converted audio file in kilobytes per second (kB/s). Value may be between 48 and 1,411. By default, the optimal bitrate will be chosen automatically.
156
+ }
157
+
158
+ begin
159
+ #Convert Audio File to MP3 format.
160
+ result = api_instance.audio_convert_to_mp3(opts)
161
+ p result
162
+ rescue CloudmersiveVideoApiClient::ApiError => e
163
+ puts "Exception when calling AudioApi->audio_convert_to_mp3: #{e}"
164
+ end
165
+ ```
166
+
167
+ ### Parameters
168
+
169
+ Name | Type | Description | Notes
170
+ ------------- | ------------- | ------------- | -------------
171
+ **input_file** | **File**| Input file to perform the operation on. | [optional]
172
+ **file_url** | **String**| Optional; URL of an audio file being used for conversion. Use this option for files larger than 2GB. | [optional]
173
+ **bit_rate** | [**Object**](.md)| Optional; Specify the desired bitrate of the converted audio file in kilobytes per second (kB/s). Value may be between 48 and 1,411. By default, the optimal bitrate will be chosen automatically. | [optional]
174
+
175
+ ### Return type
176
+
177
+ **String**
178
+
179
+ ### Authorization
180
+
181
+ [Apikey](../README.md#Apikey)
182
+
183
+ ### HTTP request headers
184
+
185
+ - **Content-Type**: multipart/form-data
186
+ - **Accept**: application/json, text/json, application/xml, text/xml
187
+
188
+
189
+
190
+ # **audio_convert_to_wav**
191
+ > String audio_convert_to_wav(opts)
192
+
193
+ Convert Audio File to WAV format.
194
+
195
+ Automatically detect audio file format and convert it to WAV format. Supports many input audio formats, including AAC, FLAC, M4A, MP2, MP3, OGG, WMA, and WAV. Uses 1 API call per 10 MB of file size. Also uses 1 API call per additional minute of processing time over 5 minutes, up to a maximum of 25 minutes total processing time. Maximum output file size is 50GB.
196
+
197
+ ### Example
198
+ ```ruby
199
+ # load the gem
200
+ require 'cloudmersive-video-api-client'
201
+ # setup authorization
202
+ CloudmersiveVideoApiClient.configure do |config|
203
+ # Configure API key authorization: Apikey
204
+ config.api_key['Apikey'] = 'YOUR API KEY'
205
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
206
+ #config.api_key_prefix['Apikey'] = 'Bearer'
207
+ end
208
+
209
+ api_instance = CloudmersiveVideoApiClient::AudioApi.new
210
+
211
+ opts = {
212
+ input_file: File.new('/path/to/file.txt'), # File | Input file to perform the operation on.
213
+ file_url: 'file_url_example', # String | Optional; URL of an audio file being used for conversion. Use this option for files larger than 2GB.
214
+ sample_rate: nil # Object | Optional; Specify the desired sample rate of the converted audio file in kHz. Value may be between 8 and 96. Standard for audio CDs is 44.1, while DVD audio standard is 48. By default, the optimal sample rate will be chosen automatically.
215
+ }
216
+
217
+ begin
218
+ #Convert Audio File to WAV format.
219
+ result = api_instance.audio_convert_to_wav(opts)
220
+ p result
221
+ rescue CloudmersiveVideoApiClient::ApiError => e
222
+ puts "Exception when calling AudioApi->audio_convert_to_wav: #{e}"
223
+ end
224
+ ```
225
+
226
+ ### Parameters
227
+
228
+ Name | Type | Description | Notes
229
+ ------------- | ------------- | ------------- | -------------
230
+ **input_file** | **File**| Input file to perform the operation on. | [optional]
231
+ **file_url** | **String**| Optional; URL of an audio file being used for conversion. Use this option for files larger than 2GB. | [optional]
232
+ **sample_rate** | [**Object**](.md)| Optional; Specify the desired sample rate of the converted audio file in kHz. Value may be between 8 and 96. Standard for audio CDs is 44.1, while DVD audio standard is 48. By default, the optimal sample rate will be chosen automatically. | [optional]
233
+
234
+ ### Return type
235
+
236
+ **String**
237
+
238
+ ### Authorization
239
+
240
+ [Apikey](../README.md#Apikey)
241
+
242
+ ### HTTP request headers
243
+
244
+ - **Content-Type**: multipart/form-data
245
+ - **Accept**: application/json, text/json, application/xml, text/xml
246
+
247
+
248
+
@@ -0,0 +1,14 @@
1
+ # CloudmersiveVideoApiClient::NsfwResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **highest_classification_result** | **String** | The highest NSFW classification of the video | [optional]
8
+ **highest_score** | **Float** | The highest NSFW score out of all frames scanned | [optional]
9
+ **total_racy_frames** | **Integer** | The total number of potentially \"racy\" frames. | [optional]
10
+ **total_nsfw_frames** | **Integer** | The total number of frames with high probability of NSFW. | [optional]
11
+ **total_frames** | **Integer** | The total number of frames scanned | [optional]
12
+ **nsfw_scanned_frames** | [**Array<NsfwScannedFrame>**](NsfwScannedFrame.md) | The NSFW scanning results for each frame | [optional]
13
+
14
+
@@ -0,0 +1,12 @@
1
+ # CloudmersiveVideoApiClient::NsfwScannedFrame
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **frame_number** | **Integer** | The number of the current frame | [optional]
7
+ **time_stamp** | **String** | The playback time of the current frame | [optional]
8
+ **content** | **String** | The still frame in PNG format as a byte array | [optional]
9
+ **classification_result** | **String** | The NSFW classification of the still frame | [optional]
10
+ **score** | **Float** | The NSFW score of the current frame | [optional]
11
+
12
+
@@ -0,0 +1,9 @@
1
+ # CloudmersiveVideoApiClient::SplitVideoResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **videos** | [**Array<VideoFile>**](VideoFile.md) | Individual video files resulting from the split operation | [optional]
8
+
9
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveVideoApiClient::StillFrame
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **frame_number** | **Integer** | The number of the current frame | [optional]
7
+ **time_stamp** | **String** | The playback time of the current frame | [optional]
8
+ **content** | **String** | The still frame in PNG format as a byte array | [optional]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # CloudmersiveVideoApiClient::StillFramesResult
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **successful** | **BOOLEAN** | True if the operation was successful, false otherwise | [optional]
7
+ **total_frames** | **Integer** | The total number of frames converted | [optional]
8
+ **still_frames** | [**Array<StillFrame>**](StillFrame.md) | Individual still frames from the conversion operation | [optional]
9
+
10
+
@@ -7,16 +7,22 @@ Method | HTTP request | Description
7
7
  [**video_convert_to_gif**](VideoApi.md#video_convert_to_gif) | **POST** /video/convert/to/gif | Convert Video to Animated GIF format.
8
8
  [**video_convert_to_mov**](VideoApi.md#video_convert_to_mov) | **POST** /video/convert/to/mov | Convert Video to MOV format.
9
9
  [**video_convert_to_mp4**](VideoApi.md#video_convert_to_mp4) | **POST** /video/convert/to/mp4 | Convert Video to MP4 format.
10
+ [**video_convert_to_still_frames**](VideoApi.md#video_convert_to_still_frames) | **POST** /video/convert/to/still-frames | Convert Video to PNG Still Frames.
10
11
  [**video_convert_to_webm**](VideoApi.md#video_convert_to_webm) | **POST** /video/convert/to/webm | Convert Video to WEBM format.
12
+ [**video_cut_video**](VideoApi.md#video_cut_video) | **POST** /video/cut | Cut a Video to a Shorter Length
11
13
  [**video_get_info**](VideoApi.md#video_get_info) | **POST** /video/convert/get-info | Get detailed information about a video or audio file
14
+ [**video_resize_video**](VideoApi.md#video_resize_video) | **POST** /video/resize/preserveAspectRatio | Resizes a Video Preserving the Original Aspect Ratio.
15
+ [**video_resize_video_simple**](VideoApi.md#video_resize_video_simple) | **POST** /video/resize/target | Resizes a Video without Preserving Aspect Ratio.
16
+ [**video_scan_for_nsfw**](VideoApi.md#video_scan_for_nsfw) | **POST** /video/scan/nsfw | Scan a Video for NSFW content.
17
+ [**video_split_video**](VideoApi.md#video_split_video) | **POST** /video/split | Split a Video into Two Shorter Videos
12
18
 
13
19
 
14
20
  # **video_convert_to_gif**
15
- > String video_convert_to_gif(input_file, opts)
21
+ > String video_convert_to_gif(opts)
16
22
 
17
23
  Convert Video to Animated GIF format.
18
24
 
19
- Automatically detect video file format and convert it to animated GIF format. Supports many input video formats, including AVI, ASF, FLV, MP4, MPEG/MPG, Matroska/WEBM, 3G2, OGV, MKV, M4V and MOV. Uses 1 API call per 10 MB of file size. Maximum output file size is 50GB. Default height is 250 pixels, while preserving the video's aspect ratio.
25
+ Automatically detect video file format and convert it to animated GIF format. Supports many input video formats, including AVI, ASF, FLV, MP4, MPEG/MPG, Matroska/WEBM, 3G2, OGV, MKV, M4V and MOV. Uses 1 API call per 10 MB of file size. Also uses 1 API call per additional minute of processing time over 5 minutes, up to a maximum of 25 minutes total processing time. Maximum output file size is 50GB. Default height is 250 pixels, while preserving the video's aspect ratio.
20
26
 
21
27
  ### Example
22
28
  ```ruby
@@ -32,22 +38,20 @@ end
32
38
 
33
39
  api_instance = CloudmersiveVideoApiClient::VideoApi.new
34
40
 
35
- input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
36
-
37
41
  opts = {
42
+ input_file: File.new('/path/to/file.txt'), # File | Input file to perform the operation on.
38
43
  file_url: 'file_url_example', # String | Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
39
- max_width: 56, # Integer | Optional; Maximum width of the output video, up to the original video width. Defaults to 250 pixels.
40
- max_height: 56, # Integer | Optional; Maximum height of the output video, up to the original video width. Defaults to 250 pixels.
44
+ max_width: 56, # Integer | Optional; Maximum width of the output video, up to the original video width. Defaults to 250 pixels, maximum is 500 pixels.
45
+ max_height: 56, # Integer | Optional; Maximum height of the output video, up to the original video width. Defaults to 250 pixels, maximum is 500 pixels.
41
46
  preserve_aspect_ratio: true, # BOOLEAN | Optional; If false, the original video's aspect ratio will not be preserved, allowing customization of the aspect ratio using maxWidth and maxHeight, potentially skewing the video. Default is true.
42
47
  frame_rate: 56, # Integer | Optional; Specify the frame rate of the output video. Defaults to 24 frames per second.
43
- extend_processing_time: true, # BOOLEAN | Optional; If true, will allow additional processing time for the video file conversion, using one API call per additional minute over the 5 minute default processing time, up to a maximum of 25 total minutes. This is generally necessary for files larger than 500 MB or longer than 30 minutes.
44
48
  start_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Optional; Specify the desired starting time of the GIF video in TimeSpan format.
45
- time_span: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Optional; Specify the desired length of the GIF video in TimeSpan format. Limit is 30 minutes.
49
+ time_span: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Optional; Specify the desired length of the GIF video in TimeSpan format. Limit is 30 seconds. Default is 10 seconds.
46
50
  }
47
51
 
48
52
  begin
49
53
  #Convert Video to Animated GIF format.
50
- result = api_instance.video_convert_to_gif(input_file, opts)
54
+ result = api_instance.video_convert_to_gif(opts)
51
55
  p result
52
56
  rescue CloudmersiveVideoApiClient::ApiError => e
53
57
  puts "Exception when calling VideoApi->video_convert_to_gif: #{e}"
@@ -58,15 +62,14 @@ end
58
62
 
59
63
  Name | Type | Description | Notes
60
64
  ------------- | ------------- | ------------- | -------------
61
- **input_file** | **File**| Input file to perform the operation on. |
65
+ **input_file** | **File**| Input file to perform the operation on. | [optional]
62
66
  **file_url** | **String**| Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB. | [optional]
63
- **max_width** | **Integer**| Optional; Maximum width of the output video, up to the original video width. Defaults to 250 pixels. | [optional]
64
- **max_height** | **Integer**| Optional; Maximum height of the output video, up to the original video width. Defaults to 250 pixels. | [optional]
67
+ **max_width** | **Integer**| Optional; Maximum width of the output video, up to the original video width. Defaults to 250 pixels, maximum is 500 pixels. | [optional]
68
+ **max_height** | **Integer**| Optional; Maximum height of the output video, up to the original video width. Defaults to 250 pixels, maximum is 500 pixels. | [optional]
65
69
  **preserve_aspect_ratio** | **BOOLEAN**| Optional; If false, the original video's aspect ratio will not be preserved, allowing customization of the aspect ratio using maxWidth and maxHeight, potentially skewing the video. Default is true. | [optional]
66
70
  **frame_rate** | **Integer**| Optional; Specify the frame rate of the output video. Defaults to 24 frames per second. | [optional]
67
- **extend_processing_time** | **BOOLEAN**| Optional; If true, will allow additional processing time for the video file conversion, using one API call per additional minute over the 5 minute default processing time, up to a maximum of 25 total minutes. This is generally necessary for files larger than 500 MB or longer than 30 minutes. | [optional]
68
71
  **start_time** | **DateTime**| Optional; Specify the desired starting time of the GIF video in TimeSpan format. | [optional]
69
- **time_span** | **DateTime**| Optional; Specify the desired length of the GIF video in TimeSpan format. Limit is 30 minutes. | [optional]
72
+ **time_span** | **DateTime**| Optional; Specify the desired length of the GIF video in TimeSpan format. Limit is 30 seconds. Default is 10 seconds. | [optional]
70
73
 
71
74
  ### Return type
72
75
 
@@ -84,11 +87,11 @@ Name | Type | Description | Notes
84
87
 
85
88
 
86
89
  # **video_convert_to_mov**
87
- > String video_convert_to_mov(input_file, opts)
90
+ > String video_convert_to_mov(opts)
88
91
 
89
92
  Convert Video to MOV format.
90
93
 
91
- Automatically detect video file format and convert it to MOV format. Supports many input video formats, including AVI, ASF, FLV, MP4, MPEG/MPG, Matroska/WEBM, 3G2, OGV, MKV, M4V and MOV. Uses 1 API call per 10 MB of file size. Maximum output file size is 50GB.
94
+ Automatically detect video file format and convert it to MOV format. Supports many input video formats, including AVI, ASF, FLV, MP4, MPEG/MPG, Matroska/WEBM, 3G2, OGV, MKV, M4V and MOV. Uses 1 API call per 10 MB of file size. Also uses 1 API call per additional minute of processing time over 5 minutes, up to a maximum of 25 minutes total processing time. Maximum output file size is 50GB.
92
95
 
93
96
  ### Example
94
97
  ```ruby
@@ -104,21 +107,19 @@ end
104
107
 
105
108
  api_instance = CloudmersiveVideoApiClient::VideoApi.new
106
109
 
107
- input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
108
-
109
110
  opts = {
111
+ input_file: File.new('/path/to/file.txt'), # File | Input file to perform the operation on.
110
112
  file_url: 'file_url_example', # String | Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
111
113
  max_width: 56, # Integer | Optional; Maximum width of the output video, up to the original video width. Defaults to original video width.
112
114
  max_height: 56, # Integer | Optional; Maximum height of the output video, up to the original video width. Defaults to original video height.
113
115
  preserve_aspect_ratio: true, # BOOLEAN | Optional; If false, the original video's aspect ratio will not be preserved, allowing customization of the aspect ratio using maxWidth and maxHeight, potentially skewing the video. Default is true.
114
116
  frame_rate: 56, # Integer | Optional; Specify the frame rate of the output video. Defaults to original video frame rate.
115
- quality: 56, # Integer | Optional; Specify the quality of the output video, where 100 is lossless and 1 is the lowest possible quality with highest compression. Default is 50.
116
- extend_processing_time: true # BOOLEAN | Optional; If true, will allow additional processing time for the video file conversion, using one API call per additional minute over the 5 minute default processing time, up to a maximum of 25 total minutes. This is generally necessary for files larger than 500 MB or longer than 30 minutes.
117
+ quality: 56 # Integer | Optional; Specify the quality of the output video, where 100 is lossless and 1 is the lowest possible quality with highest compression. Default is 50.
117
118
  }
118
119
 
119
120
  begin
120
121
  #Convert Video to MOV format.
121
- result = api_instance.video_convert_to_mov(input_file, opts)
122
+ result = api_instance.video_convert_to_mov(opts)
122
123
  p result
123
124
  rescue CloudmersiveVideoApiClient::ApiError => e
124
125
  puts "Exception when calling VideoApi->video_convert_to_mov: #{e}"
@@ -129,14 +130,13 @@ end
129
130
 
130
131
  Name | Type | Description | Notes
131
132
  ------------- | ------------- | ------------- | -------------
132
- **input_file** | **File**| Input file to perform the operation on. |
133
+ **input_file** | **File**| Input file to perform the operation on. | [optional]
133
134
  **file_url** | **String**| Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB. | [optional]
134
135
  **max_width** | **Integer**| Optional; Maximum width of the output video, up to the original video width. Defaults to original video width. | [optional]
135
136
  **max_height** | **Integer**| Optional; Maximum height of the output video, up to the original video width. Defaults to original video height. | [optional]
136
137
  **preserve_aspect_ratio** | **BOOLEAN**| Optional; If false, the original video's aspect ratio will not be preserved, allowing customization of the aspect ratio using maxWidth and maxHeight, potentially skewing the video. Default is true. | [optional]
137
138
  **frame_rate** | **Integer**| Optional; Specify the frame rate of the output video. Defaults to original video frame rate. | [optional]
138
139
  **quality** | **Integer**| Optional; Specify the quality of the output video, where 100 is lossless and 1 is the lowest possible quality with highest compression. Default is 50. | [optional]
139
- **extend_processing_time** | **BOOLEAN**| Optional; If true, will allow additional processing time for the video file conversion, using one API call per additional minute over the 5 minute default processing time, up to a maximum of 25 total minutes. This is generally necessary for files larger than 500 MB or longer than 30 minutes. | [optional]
140
140
 
141
141
  ### Return type
142
142
 
@@ -154,11 +154,11 @@ Name | Type | Description | Notes
154
154
 
155
155
 
156
156
  # **video_convert_to_mp4**
157
- > String video_convert_to_mp4(input_file, opts)
157
+ > String video_convert_to_mp4(opts)
158
158
 
159
159
  Convert Video to MP4 format.
160
160
 
161
- Automatically detect video file format and convert it to MP4 format. Supports many input video formats, including AVI, ASF, FLV, MP4, MPEG/MPG, Matroska/WEBM, 3G2, OGV, MKV, M4V and MOV. Uses 1 API call per 10 MB of file size. Maximum output file size is 50GB.
161
+ Automatically detect video file format and convert it to MP4 format. Supports many input video formats, including AVI, ASF, FLV, MP4, MPEG/MPG, Matroska/WEBM, 3G2, OGV, MKV, M4V and MOV. Uses 1 API call per 10 MB of file size. Also uses 1 API call per additional minute of processing time over 5 minutes, up to a maximum of 25 minutes total processing time. Maximum output file size is 50GB.
162
162
 
163
163
  ### Example
164
164
  ```ruby
@@ -174,21 +174,19 @@ end
174
174
 
175
175
  api_instance = CloudmersiveVideoApiClient::VideoApi.new
176
176
 
177
- input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
178
-
179
177
  opts = {
178
+ input_file: File.new('/path/to/file.txt'), # File | Input file to perform the operation on.
180
179
  file_url: 'file_url_example', # String | Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
181
180
  max_width: 56, # Integer | Optional; Maximum width of the output video, up to the original video width. Defaults to original video width.
182
181
  max_height: 56, # Integer | Optional; Maximum height of the output video, up to the original video width. Defaults to original video height.
183
182
  preserve_aspect_ratio: true, # BOOLEAN | Optional; If false, the original video's aspect ratio will not be preserved, allowing customization of the aspect ratio using maxWidth and maxHeight, potentially skewing the video. Default is true.
184
183
  frame_rate: 56, # Integer | Optional; Specify the frame rate of the output video. Defaults to original video frame rate.
185
- quality: 56, # Integer | Optional; Specify the quality of the output video, where 100 is lossless and 1 is the lowest possible quality with highest compression. Default is 50.
186
- extend_processing_time: true # BOOLEAN | Optional; If true, will allow additional processing time for the video file conversion, using one API call per additional minute over the 5 minute default processing time, up to a maximum of 25 total minutes. This is generally necessary for files larger than 500 MB or longer than 30 minutes.
184
+ quality: 56 # Integer | Optional; Specify the quality of the output video, where 100 is lossless and 1 is the lowest possible quality with highest compression. Default is 50.
187
185
  }
188
186
 
189
187
  begin
190
188
  #Convert Video to MP4 format.
191
- result = api_instance.video_convert_to_mp4(input_file, opts)
189
+ result = api_instance.video_convert_to_mp4(opts)
192
190
  p result
193
191
  rescue CloudmersiveVideoApiClient::ApiError => e
194
192
  puts "Exception when calling VideoApi->video_convert_to_mp4: #{e}"
@@ -199,14 +197,13 @@ end
199
197
 
200
198
  Name | Type | Description | Notes
201
199
  ------------- | ------------- | ------------- | -------------
202
- **input_file** | **File**| Input file to perform the operation on. |
200
+ **input_file** | **File**| Input file to perform the operation on. | [optional]
203
201
  **file_url** | **String**| Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB. | [optional]
204
202
  **max_width** | **Integer**| Optional; Maximum width of the output video, up to the original video width. Defaults to original video width. | [optional]
205
203
  **max_height** | **Integer**| Optional; Maximum height of the output video, up to the original video width. Defaults to original video height. | [optional]
206
204
  **preserve_aspect_ratio** | **BOOLEAN**| Optional; If false, the original video's aspect ratio will not be preserved, allowing customization of the aspect ratio using maxWidth and maxHeight, potentially skewing the video. Default is true. | [optional]
207
205
  **frame_rate** | **Integer**| Optional; Specify the frame rate of the output video. Defaults to original video frame rate. | [optional]
208
206
  **quality** | **Integer**| Optional; Specify the quality of the output video, where 100 is lossless and 1 is the lowest possible quality with highest compression. Default is 50. | [optional]
209
- **extend_processing_time** | **BOOLEAN**| Optional; If true, will allow additional processing time for the video file conversion, using one API call per additional minute over the 5 minute default processing time, up to a maximum of 25 total minutes. This is generally necessary for files larger than 500 MB or longer than 30 minutes. | [optional]
210
207
 
211
208
  ### Return type
212
209
 
@@ -223,12 +220,75 @@ Name | Type | Description | Notes
223
220
 
224
221
 
225
222
 
223
+ # **video_convert_to_still_frames**
224
+ > StillFramesResult video_convert_to_still_frames(opts)
225
+
226
+ Convert Video to PNG Still Frames.
227
+
228
+ Automatically detect video file format and convert it to an array of still frame PNG images. Supports many input video formats, including AVI, ASF, FLV, MP4, MPEG/MPG, Matroska/WEBM, 3G2, OGV, MKV, M4V and MOV. Uses 1 API call per 10 MB of file size. Also uses 1 API call per additional minute of processing time over 5 minutes, up to a maximum of 25 minutes total processing time.
229
+
230
+ ### Example
231
+ ```ruby
232
+ # load the gem
233
+ require 'cloudmersive-video-api-client'
234
+ # setup authorization
235
+ CloudmersiveVideoApiClient.configure do |config|
236
+ # Configure API key authorization: Apikey
237
+ config.api_key['Apikey'] = 'YOUR API KEY'
238
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
239
+ #config.api_key_prefix['Apikey'] = 'Bearer'
240
+ end
241
+
242
+ api_instance = CloudmersiveVideoApiClient::VideoApi.new
243
+
244
+ opts = {
245
+ input_file: File.new('/path/to/file.txt'), # File | Input file to perform the operation on.
246
+ file_url: 'file_url_example', # String | Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
247
+ max_width: 56, # Integer | Optional; Maximum width of the output video, up to the original video width. Defaults to original video width.
248
+ max_height: 56, # Integer | Optional; Maximum height of the output video, up to the original video width. Defaults to original video height.
249
+ frames_per_second: nil # Object | Optional; How many video frames per second to be returned as PNG images. Minimum value is 0.1, maximum is 60. Default is 1 frame per second. Maximum of 2000 total frames.
250
+ }
251
+
252
+ begin
253
+ #Convert Video to PNG Still Frames.
254
+ result = api_instance.video_convert_to_still_frames(opts)
255
+ p result
256
+ rescue CloudmersiveVideoApiClient::ApiError => e
257
+ puts "Exception when calling VideoApi->video_convert_to_still_frames: #{e}"
258
+ end
259
+ ```
260
+
261
+ ### Parameters
262
+
263
+ Name | Type | Description | Notes
264
+ ------------- | ------------- | ------------- | -------------
265
+ **input_file** | **File**| Input file to perform the operation on. | [optional]
266
+ **file_url** | **String**| Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB. | [optional]
267
+ **max_width** | **Integer**| Optional; Maximum width of the output video, up to the original video width. Defaults to original video width. | [optional]
268
+ **max_height** | **Integer**| Optional; Maximum height of the output video, up to the original video width. Defaults to original video height. | [optional]
269
+ **frames_per_second** | [**Object**](.md)| Optional; How many video frames per second to be returned as PNG images. Minimum value is 0.1, maximum is 60. Default is 1 frame per second. Maximum of 2000 total frames. | [optional]
270
+
271
+ ### Return type
272
+
273
+ [**StillFramesResult**](StillFramesResult.md)
274
+
275
+ ### Authorization
276
+
277
+ [Apikey](../README.md#Apikey)
278
+
279
+ ### HTTP request headers
280
+
281
+ - **Content-Type**: multipart/form-data
282
+ - **Accept**: application/json, text/json, application/xml, text/xml
283
+
284
+
285
+
226
286
  # **video_convert_to_webm**
227
- > String video_convert_to_webm(input_file, opts)
287
+ > String video_convert_to_webm(opts)
228
288
 
229
289
  Convert Video to WEBM format.
230
290
 
231
- Automatically detect video file format and convert it to WEBM format. Supports many input video formats, including AVI, ASF, FLV, MP4, MPEG/MPG, Matroska/WEBM, 3G2, OGV, MKV, M4V and MOV. Uses 1 API call per 10 MB of file size. Maximum output file size is 50GB.
291
+ Automatically detect video file format and convert it to WEBM format. Supports many input video formats, including AVI, ASF, FLV, MP4, MPEG/MPG, Matroska/WEBM, 3G2, OGV, MKV, M4V and MOV. Uses 1 API call per 10 MB of file size. Also uses 1 API call per additional minute of processing time over 5 minutes, up to a maximum of 25 minutes total processing time. Maximum output file size is 50GB.
232
292
 
233
293
  ### Example
234
294
  ```ruby
@@ -244,21 +304,19 @@ end
244
304
 
245
305
  api_instance = CloudmersiveVideoApiClient::VideoApi.new
246
306
 
247
- input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
248
-
249
307
  opts = {
308
+ input_file: File.new('/path/to/file.txt'), # File | Input file to perform the operation on.
250
309
  file_url: 'file_url_example', # String | Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
251
310
  max_width: 56, # Integer | Optional; Maximum width of the output video, up to the original video width. Defaults to original video width.
252
311
  max_height: 56, # Integer | Optional; Maximum height of the output video, up to the original video width. Defaults to original video height.
253
312
  preserve_aspect_ratio: true, # BOOLEAN | Optional; If false, the original video's aspect ratio will not be preserved, allowing customization of the aspect ratio using maxWidth and maxHeight, potentially skewing the video. Default is true.
254
313
  frame_rate: 56, # Integer | Optional; Specify the frame rate of the output video. Defaults to original video frame rate.
255
- quality: 56, # Integer | Optional; Specify the quality of the output video, where 100 is lossless and 1 is the lowest possible quality with highest compression. Default is 50.
256
- extend_processing_time: true # BOOLEAN | Optional; If true, will allow additional processing time for the video file conversion, using one API call per additional minute over the 5 minute default processing time, up to a maximum of 25 total minutes. This is generally necessary for files larger than 500 MB or longer than 30 minutes.
314
+ quality: 56 # Integer | Optional; Specify the quality of the output video, where 100 is lossless and 1 is the lowest possible quality with highest compression. Default is 50.
257
315
  }
258
316
 
259
317
  begin
260
318
  #Convert Video to WEBM format.
261
- result = api_instance.video_convert_to_webm(input_file, opts)
319
+ result = api_instance.video_convert_to_webm(opts)
262
320
  p result
263
321
  rescue CloudmersiveVideoApiClient::ApiError => e
264
322
  puts "Exception when calling VideoApi->video_convert_to_webm: #{e}"
@@ -269,14 +327,74 @@ end
269
327
 
270
328
  Name | Type | Description | Notes
271
329
  ------------- | ------------- | ------------- | -------------
272
- **input_file** | **File**| Input file to perform the operation on. |
330
+ **input_file** | **File**| Input file to perform the operation on. | [optional]
273
331
  **file_url** | **String**| Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB. | [optional]
274
332
  **max_width** | **Integer**| Optional; Maximum width of the output video, up to the original video width. Defaults to original video width. | [optional]
275
333
  **max_height** | **Integer**| Optional; Maximum height of the output video, up to the original video width. Defaults to original video height. | [optional]
276
334
  **preserve_aspect_ratio** | **BOOLEAN**| Optional; If false, the original video's aspect ratio will not be preserved, allowing customization of the aspect ratio using maxWidth and maxHeight, potentially skewing the video. Default is true. | [optional]
277
335
  **frame_rate** | **Integer**| Optional; Specify the frame rate of the output video. Defaults to original video frame rate. | [optional]
278
336
  **quality** | **Integer**| Optional; Specify the quality of the output video, where 100 is lossless and 1 is the lowest possible quality with highest compression. Default is 50. | [optional]
279
- **extend_processing_time** | **BOOLEAN**| Optional; If true, will allow additional processing time for the video file conversion, using one API call per additional minute over the 5 minute default processing time, up to a maximum of 25 total minutes. This is generally necessary for files larger than 500 MB or longer than 30 minutes. | [optional]
337
+
338
+ ### Return type
339
+
340
+ **String**
341
+
342
+ ### Authorization
343
+
344
+ [Apikey](../README.md#Apikey)
345
+
346
+ ### HTTP request headers
347
+
348
+ - **Content-Type**: multipart/form-data
349
+ - **Accept**: application/json, text/json, application/xml, text/xml
350
+
351
+
352
+
353
+ # **video_cut_video**
354
+ > String video_cut_video(opts)
355
+
356
+ Cut a Video to a Shorter Length
357
+
358
+ Cuts a video to the specified start and end times. Supports many input video formats, including AVI, ASF, FLV, MP4, MPEG/MPG, Matroska/WEBM, 3G2, MKV, M4V and MOV. Uses 1 API call per 10 MB of file size. Also uses 1 API call per additional minute of processing time over 5 minutes, up to a maximum of 25 minutes total processing time. Maximum output file size is 50GB.
359
+
360
+ ### Example
361
+ ```ruby
362
+ # load the gem
363
+ require 'cloudmersive-video-api-client'
364
+ # setup authorization
365
+ CloudmersiveVideoApiClient.configure do |config|
366
+ # Configure API key authorization: Apikey
367
+ config.api_key['Apikey'] = 'YOUR API KEY'
368
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
369
+ #config.api_key_prefix['Apikey'] = 'Bearer'
370
+ end
371
+
372
+ api_instance = CloudmersiveVideoApiClient::VideoApi.new
373
+
374
+ opts = {
375
+ input_file: File.new('/path/to/file.txt'), # File | Input file to perform the operation on.
376
+ file_url: 'file_url_example', # String | Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
377
+ start_time: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Optional; Specify the desired starting time of the cut video in TimeSpan format.
378
+ time_span: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Optional; Specify the desired length of the cut video in TimeSpan format. Leave blank to include the rest of the video. Maximum time is 4 hours.
379
+ }
380
+
381
+ begin
382
+ #Cut a Video to a Shorter Length
383
+ result = api_instance.video_cut_video(opts)
384
+ p result
385
+ rescue CloudmersiveVideoApiClient::ApiError => e
386
+ puts "Exception when calling VideoApi->video_cut_video: #{e}"
387
+ end
388
+ ```
389
+
390
+ ### Parameters
391
+
392
+ Name | Type | Description | Notes
393
+ ------------- | ------------- | ------------- | -------------
394
+ **input_file** | **File**| Input file to perform the operation on. | [optional]
395
+ **file_url** | **String**| Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB. | [optional]
396
+ **start_time** | **DateTime**| Optional; Specify the desired starting time of the cut video in TimeSpan format. | [optional]
397
+ **time_span** | **DateTime**| Optional; Specify the desired length of the cut video in TimeSpan format. Leave blank to include the rest of the video. Maximum time is 4 hours. | [optional]
280
398
 
281
399
  ### Return type
282
400
 
@@ -294,7 +412,7 @@ Name | Type | Description | Notes
294
412
 
295
413
 
296
414
  # **video_get_info**
297
- > String video_get_info(input_file, opts)
415
+ > MediaInformation video_get_info(opts)
298
416
 
299
417
  Get detailed information about a video or audio file
300
418
 
@@ -314,15 +432,14 @@ end
314
432
 
315
433
  api_instance = CloudmersiveVideoApiClient::VideoApi.new
316
434
 
317
- input_file = File.new('/path/to/file.txt') # File | Input file to perform the operation on.
318
-
319
435
  opts = {
436
+ input_file: File.new('/path/to/file.txt'), # File | Input file to perform the operation on.
320
437
  file_url: 'file_url_example' # String | Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
321
438
  }
322
439
 
323
440
  begin
324
441
  #Get detailed information about a video or audio file
325
- result = api_instance.video_get_info(input_file, opts)
442
+ result = api_instance.video_get_info(opts)
326
443
  p result
327
444
  rescue CloudmersiveVideoApiClient::ApiError => e
328
445
  puts "Exception when calling VideoApi->video_get_info: #{e}"
@@ -333,11 +450,145 @@ end
333
450
 
334
451
  Name | Type | Description | Notes
335
452
  ------------- | ------------- | ------------- | -------------
336
- **input_file** | **File**| Input file to perform the operation on. |
453
+ **input_file** | **File**| Input file to perform the operation on. | [optional]
337
454
  **file_url** | **String**| Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB. | [optional]
338
455
 
339
456
  ### Return type
340
457
 
458
+ [**MediaInformation**](MediaInformation.md)
459
+
460
+ ### Authorization
461
+
462
+ [Apikey](../README.md#Apikey)
463
+
464
+ ### HTTP request headers
465
+
466
+ - **Content-Type**: multipart/form-data
467
+ - **Accept**: application/json, text/json, application/xml, text/xml
468
+
469
+
470
+
471
+ # **video_resize_video**
472
+ > String video_resize_video(opts)
473
+
474
+ Resizes a Video Preserving the Original Aspect Ratio.
475
+
476
+ Resizes a video, while maintaining the original aspect ratio and encoding. Supports many input video formats, including AVI, ASF, FLV, MP4, MPEG/MPG, Matroska/WEBM, 3G2, MKV, M4V and MOV. Uses 1 API call per 10 MB of file size. Also uses 1 API call per additional minute of processing time over 5 minutes, up to a maximum of 25 minutes total processing time. Maximum output file size is 50GB.
477
+
478
+ ### Example
479
+ ```ruby
480
+ # load the gem
481
+ require 'cloudmersive-video-api-client'
482
+ # setup authorization
483
+ CloudmersiveVideoApiClient.configure do |config|
484
+ # Configure API key authorization: Apikey
485
+ config.api_key['Apikey'] = 'YOUR API KEY'
486
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
487
+ #config.api_key_prefix['Apikey'] = 'Bearer'
488
+ end
489
+
490
+ api_instance = CloudmersiveVideoApiClient::VideoApi.new
491
+
492
+ opts = {
493
+ input_file: File.new('/path/to/file.txt'), # File | Input file to perform the operation on.
494
+ file_url: 'file_url_example', # String | Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
495
+ max_width: 56, # Integer | Optional; Maximum width of the output video, up to the original video width. Defaults to original video width.
496
+ max_height: 56, # Integer | Optional; Maximum height of the output video, up to the original video width. Defaults to original video height.
497
+ frame_rate: 56, # Integer | Optional; Specify the frame rate of the output video. Defaults to original video frame rate.
498
+ quality: 56, # Integer | Optional; Specify the quality of the output video, where 100 is lossless and 1 is the lowest possible quality with highest compression. Default is 50.
499
+ extension: 'extension_example' # String | Optional; Specify the file extension of the input video. This is recommended when inputting a file directly, without a file name. If no file name is available and no extension is provided, the extension will be inferred from the file data, which may cause a different extension to be used in the output.
500
+ }
501
+
502
+ begin
503
+ #Resizes a Video Preserving the Original Aspect Ratio.
504
+ result = api_instance.video_resize_video(opts)
505
+ p result
506
+ rescue CloudmersiveVideoApiClient::ApiError => e
507
+ puts "Exception when calling VideoApi->video_resize_video: #{e}"
508
+ end
509
+ ```
510
+
511
+ ### Parameters
512
+
513
+ Name | Type | Description | Notes
514
+ ------------- | ------------- | ------------- | -------------
515
+ **input_file** | **File**| Input file to perform the operation on. | [optional]
516
+ **file_url** | **String**| Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB. | [optional]
517
+ **max_width** | **Integer**| Optional; Maximum width of the output video, up to the original video width. Defaults to original video width. | [optional]
518
+ **max_height** | **Integer**| Optional; Maximum height of the output video, up to the original video width. Defaults to original video height. | [optional]
519
+ **frame_rate** | **Integer**| Optional; Specify the frame rate of the output video. Defaults to original video frame rate. | [optional]
520
+ **quality** | **Integer**| Optional; Specify the quality of the output video, where 100 is lossless and 1 is the lowest possible quality with highest compression. Default is 50. | [optional]
521
+ **extension** | **String**| Optional; Specify the file extension of the input video. This is recommended when inputting a file directly, without a file name. If no file name is available and no extension is provided, the extension will be inferred from the file data, which may cause a different extension to be used in the output. | [optional]
522
+
523
+ ### Return type
524
+
525
+ **String**
526
+
527
+ ### Authorization
528
+
529
+ [Apikey](../README.md#Apikey)
530
+
531
+ ### HTTP request headers
532
+
533
+ - **Content-Type**: multipart/form-data
534
+ - **Accept**: application/json, text/json, application/xml, text/xml
535
+
536
+
537
+
538
+ # **video_resize_video_simple**
539
+ > String video_resize_video_simple(opts)
540
+
541
+ Resizes a Video without Preserving Aspect Ratio.
542
+
543
+ Resizes a video without maintaining original aspect ratio, allowing fully customizable dimensions. May cause image skewing. Supports many input video formats, including AVI, ASF, FLV, MP4, MPEG/MPG, Matroska/WEBM, 3G2, MKV, M4V and MOV. Uses 1 API call per 10 MB of file size. Also uses 1 API call per additional minute of processing time over 5 minutes, up to a maximum of 25 minutes total processing time. Maximum output file size is 50GB.
544
+
545
+ ### Example
546
+ ```ruby
547
+ # load the gem
548
+ require 'cloudmersive-video-api-client'
549
+ # setup authorization
550
+ CloudmersiveVideoApiClient.configure do |config|
551
+ # Configure API key authorization: Apikey
552
+ config.api_key['Apikey'] = 'YOUR API KEY'
553
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
554
+ #config.api_key_prefix['Apikey'] = 'Bearer'
555
+ end
556
+
557
+ api_instance = CloudmersiveVideoApiClient::VideoApi.new
558
+
559
+ opts = {
560
+ input_file: File.new('/path/to/file.txt'), # File | Input file to perform the operation on.
561
+ file_url: 'file_url_example', # String | Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
562
+ max_width: 56, # Integer | Optional; Maximum width of the output video, up to the original video width. Defaults to original video width.
563
+ max_height: 56, # Integer | Optional; Maximum height of the output video, up to the original video width. Defaults to original video height.
564
+ frame_rate: 56, # Integer | Optional; Specify the frame rate of the output video. Defaults to original video frame rate.
565
+ quality: 56, # Integer | Optional; Specify the quality of the output video, where 100 is lossless and 1 is the lowest possible quality with highest compression. Default is 50.
566
+ extension: 'extension_example' # String | Optional; Specify the file extension of the input video. This is recommended when inputting a file directly, without a file name. If no file name is available and no extension is provided, the extension will be inferred from the file data, which may cause a different extension to be used in the output.
567
+ }
568
+
569
+ begin
570
+ #Resizes a Video without Preserving Aspect Ratio.
571
+ result = api_instance.video_resize_video_simple(opts)
572
+ p result
573
+ rescue CloudmersiveVideoApiClient::ApiError => e
574
+ puts "Exception when calling VideoApi->video_resize_video_simple: #{e}"
575
+ end
576
+ ```
577
+
578
+ ### Parameters
579
+
580
+ Name | Type | Description | Notes
581
+ ------------- | ------------- | ------------- | -------------
582
+ **input_file** | **File**| Input file to perform the operation on. | [optional]
583
+ **file_url** | **String**| Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB. | [optional]
584
+ **max_width** | **Integer**| Optional; Maximum width of the output video, up to the original video width. Defaults to original video width. | [optional]
585
+ **max_height** | **Integer**| Optional; Maximum height of the output video, up to the original video width. Defaults to original video height. | [optional]
586
+ **frame_rate** | **Integer**| Optional; Specify the frame rate of the output video. Defaults to original video frame rate. | [optional]
587
+ **quality** | **Integer**| Optional; Specify the quality of the output video, where 100 is lossless and 1 is the lowest possible quality with highest compression. Default is 50. | [optional]
588
+ **extension** | **String**| Optional; Specify the file extension of the input video. This is recommended when inputting a file directly, without a file name. If no file name is available and no extension is provided, the extension will be inferred from the file data, which may cause a different extension to be used in the output. | [optional]
589
+
590
+ ### Return type
591
+
341
592
  **String**
342
593
 
343
594
  ### Authorization
@@ -351,3 +602,124 @@ Name | Type | Description | Notes
351
602
 
352
603
 
353
604
 
605
+ # **video_scan_for_nsfw**
606
+ > NsfwResult video_scan_for_nsfw(opts)
607
+
608
+ Scan a Video for NSFW content.
609
+
610
+ Automatically detect video file format and scan it for Not Safe For Work (NSFW)/Porn/Racy content. Supports many input video formats, including AVI, ASF, FLV, MP4, MPEG/MPG, Matroska/WEBM, 3G2, OGV, MKV, M4V and MOV. Uses 1 API call per 10 MB of file size. Also uses 1 API call per frame scanned.
611
+
612
+ ### Example
613
+ ```ruby
614
+ # load the gem
615
+ require 'cloudmersive-video-api-client'
616
+ # setup authorization
617
+ CloudmersiveVideoApiClient.configure do |config|
618
+ # Configure API key authorization: Apikey
619
+ config.api_key['Apikey'] = 'YOUR API KEY'
620
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
621
+ #config.api_key_prefix['Apikey'] = 'Bearer'
622
+ end
623
+
624
+ api_instance = CloudmersiveVideoApiClient::VideoApi.new
625
+
626
+ opts = {
627
+ input_file: File.new('/path/to/file.txt'), # File | Input file to perform the operation on.
628
+ file_url: 'file_url_example', # String | Optional; URL of a video file being scanned. Use this option for files larger than 2GB.
629
+ frames_per_second: nil # Object | Optional; How many video frames per second to be scanned. Minimum value is 0.05 (1 frame per 20 seconds), maximum is 1. Default is 0.33 frame per second (1 frame scanned every 3 seconds). Maximum of 1000 total frames can be scanned, potentially adjusting the framerate for longer videos.
630
+ }
631
+
632
+ begin
633
+ #Scan a Video for NSFW content.
634
+ result = api_instance.video_scan_for_nsfw(opts)
635
+ p result
636
+ rescue CloudmersiveVideoApiClient::ApiError => e
637
+ puts "Exception when calling VideoApi->video_scan_for_nsfw: #{e}"
638
+ end
639
+ ```
640
+
641
+ ### Parameters
642
+
643
+ Name | Type | Description | Notes
644
+ ------------- | ------------- | ------------- | -------------
645
+ **input_file** | **File**| Input file to perform the operation on. | [optional]
646
+ **file_url** | **String**| Optional; URL of a video file being scanned. Use this option for files larger than 2GB. | [optional]
647
+ **frames_per_second** | [**Object**](.md)| Optional; How many video frames per second to be scanned. Minimum value is 0.05 (1 frame per 20 seconds), maximum is 1. Default is 0.33 frame per second (1 frame scanned every 3 seconds). Maximum of 1000 total frames can be scanned, potentially adjusting the framerate for longer videos. | [optional]
648
+
649
+ ### Return type
650
+
651
+ [**NsfwResult**](NsfwResult.md)
652
+
653
+ ### Authorization
654
+
655
+ [Apikey](../README.md#Apikey)
656
+
657
+ ### HTTP request headers
658
+
659
+ - **Content-Type**: multipart/form-data
660
+ - **Accept**: application/json, text/json, application/xml, text/xml
661
+
662
+
663
+
664
+ # **video_split_video**
665
+ > SplitVideoResult video_split_video(split_time, opts)
666
+
667
+ Split a Video into Two Shorter Videos
668
+
669
+ Cuts a video into two videos based on the specified start time. Supports many input video formats, including AVI, ASF, FLV, MP4, MPEG/MPG, Matroska/WEBM, 3G2, MKV, M4V and MOV. Uses 1 API call per 10 MB of file size. Also uses 1 API call per additional minute of processing time over 5 minutes, up to a maximum of 25 minutes total processing time. Maximum output file size is 50GB.
670
+
671
+ ### Example
672
+ ```ruby
673
+ # load the gem
674
+ require 'cloudmersive-video-api-client'
675
+ # setup authorization
676
+ CloudmersiveVideoApiClient.configure do |config|
677
+ # Configure API key authorization: Apikey
678
+ config.api_key['Apikey'] = 'YOUR API KEY'
679
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
680
+ #config.api_key_prefix['Apikey'] = 'Bearer'
681
+ end
682
+
683
+ api_instance = CloudmersiveVideoApiClient::VideoApi.new
684
+
685
+ split_time = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Specify the desired time at which to split the video in TimeSpan format.
686
+
687
+ opts = {
688
+ input_file: File.new('/path/to/file.txt'), # File | Input file to perform the operation on.
689
+ file_url: 'file_url_example', # String | Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
690
+ time_span: DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | Optional; Specify the desired length of the second video in TimeSpan format. Leave blank to include the rest of the video. Maximum time is 4 hours.
691
+ }
692
+
693
+ begin
694
+ #Split a Video into Two Shorter Videos
695
+ result = api_instance.video_split_video(split_time, opts)
696
+ p result
697
+ rescue CloudmersiveVideoApiClient::ApiError => e
698
+ puts "Exception when calling VideoApi->video_split_video: #{e}"
699
+ end
700
+ ```
701
+
702
+ ### Parameters
703
+
704
+ Name | Type | Description | Notes
705
+ ------------- | ------------- | ------------- | -------------
706
+ **split_time** | **DateTime**| Specify the desired time at which to split the video in TimeSpan format. |
707
+ **input_file** | **File**| Input file to perform the operation on. | [optional]
708
+ **file_url** | **String**| Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB. | [optional]
709
+ **time_span** | **DateTime**| Optional; Specify the desired length of the second video in TimeSpan format. Leave blank to include the rest of the video. Maximum time is 4 hours. | [optional]
710
+
711
+ ### Return type
712
+
713
+ [**SplitVideoResult**](SplitVideoResult.md)
714
+
715
+ ### Authorization
716
+
717
+ [Apikey](../README.md#Apikey)
718
+
719
+ ### HTTP request headers
720
+
721
+ - **Content-Type**: multipart/form-data
722
+ - **Accept**: application/json, text/json, application/xml, text/xml
723
+
724
+
725
+