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 +4 -4
- data/README.md +27 -18
- data/docs/AudioApi.md +248 -0
- data/docs/NsfwResult.md +14 -0
- data/docs/NsfwScannedFrame.md +12 -0
- data/docs/SplitVideoResult.md +9 -0
- data/docs/StillFrame.md +10 -0
- data/docs/StillFramesResult.md +10 -0
- data/docs/VideoApi.md +418 -46
- data/docs/VideoFile.md +9 -0
- data/lib/cloudmersive-video-api-client.rb +7 -0
- data/lib/cloudmersive-video-api-client/api/audio_api.rb +251 -0
- data/lib/cloudmersive-video-api-client/api/video_api.rb +429 -79
- data/lib/cloudmersive-video-api-client/models/nsfw_result.rb +248 -0
- data/lib/cloudmersive-video-api-client/models/nsfw_scanned_frame.rb +241 -0
- data/lib/cloudmersive-video-api-client/models/split_video_result.rb +198 -0
- data/lib/cloudmersive-video-api-client/models/still_frame.rb +221 -0
- data/lib/cloudmersive-video-api-client/models/still_frames_result.rb +208 -0
- data/lib/cloudmersive-video-api-client/models/video_file.rb +211 -0
- data/lib/cloudmersive-video-api-client/version.rb +1 -1
- data/spec/api/audio_api_spec.rb +91 -0
- data/spec/api/video_api_spec.rb +109 -17
- data/spec/models/nsfw_result_spec.rb +77 -0
- data/spec/models/nsfw_scanned_frame_spec.rb +65 -0
- data/spec/models/split_video_result_spec.rb +47 -0
- data/spec/models/still_frame_spec.rb +53 -0
- data/spec/models/still_frames_result_spec.rb +53 -0
- data/spec/models/video_file_spec.rb +47 -0
- metadata +23 -2
@@ -0,0 +1,211 @@
|
|
1
|
+
=begin
|
2
|
+
#videoapi
|
3
|
+
|
4
|
+
#The video APIs help you convert, encode, and transcode videos.
|
5
|
+
|
6
|
+
OpenAPI spec version: v1
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.14
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module CloudmersiveVideoApiClient
|
16
|
+
# A video file
|
17
|
+
class VideoFile
|
18
|
+
# Sequence number of the video
|
19
|
+
attr_accessor :video_number
|
20
|
+
|
21
|
+
# The video file as a byte array
|
22
|
+
attr_accessor :content
|
23
|
+
|
24
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
25
|
+
def self.attribute_map
|
26
|
+
{
|
27
|
+
:'video_number' => :'VideoNumber',
|
28
|
+
:'content' => :'Content'
|
29
|
+
}
|
30
|
+
end
|
31
|
+
|
32
|
+
# Attribute type mapping.
|
33
|
+
def self.swagger_types
|
34
|
+
{
|
35
|
+
:'video_number' => :'Integer',
|
36
|
+
:'content' => :'String'
|
37
|
+
}
|
38
|
+
end
|
39
|
+
|
40
|
+
# Initializes the object
|
41
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
42
|
+
def initialize(attributes = {})
|
43
|
+
return unless attributes.is_a?(Hash)
|
44
|
+
|
45
|
+
# convert string to symbol for hash key
|
46
|
+
attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
|
47
|
+
|
48
|
+
if attributes.has_key?(:'VideoNumber')
|
49
|
+
self.video_number = attributes[:'VideoNumber']
|
50
|
+
end
|
51
|
+
|
52
|
+
if attributes.has_key?(:'Content')
|
53
|
+
self.content = attributes[:'Content']
|
54
|
+
end
|
55
|
+
end
|
56
|
+
|
57
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
58
|
+
# @return Array for valid properties with the reasons
|
59
|
+
def list_invalid_properties
|
60
|
+
invalid_properties = Array.new
|
61
|
+
if !@content.nil? && @content !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
|
62
|
+
invalid_properties.push('invalid value for "content", must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/.')
|
63
|
+
end
|
64
|
+
|
65
|
+
invalid_properties
|
66
|
+
end
|
67
|
+
|
68
|
+
# Check to see if the all the properties in the model are valid
|
69
|
+
# @return true if the model is valid
|
70
|
+
def valid?
|
71
|
+
return false if !@content.nil? && @content !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
|
72
|
+
true
|
73
|
+
end
|
74
|
+
|
75
|
+
# Custom attribute writer method with validation
|
76
|
+
# @param [Object] content Value to be assigned
|
77
|
+
def content=(content)
|
78
|
+
if !content.nil? && content !~ Regexp.new(/^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/)
|
79
|
+
fail ArgumentError, 'invalid value for "content", must conform to the pattern /^(?:[A-Za-z0-9+\/]{4})*(?:[A-Za-z0-9+\/]{2}==|[A-Za-z0-9+\/]{3}=)?$/.'
|
80
|
+
end
|
81
|
+
|
82
|
+
@content = content
|
83
|
+
end
|
84
|
+
|
85
|
+
# Checks equality by comparing each attribute.
|
86
|
+
# @param [Object] Object to be compared
|
87
|
+
def ==(o)
|
88
|
+
return true if self.equal?(o)
|
89
|
+
self.class == o.class &&
|
90
|
+
video_number == o.video_number &&
|
91
|
+
content == o.content
|
92
|
+
end
|
93
|
+
|
94
|
+
# @see the `==` method
|
95
|
+
# @param [Object] Object to be compared
|
96
|
+
def eql?(o)
|
97
|
+
self == o
|
98
|
+
end
|
99
|
+
|
100
|
+
# Calculates hash code according to all attributes.
|
101
|
+
# @return [Fixnum] Hash code
|
102
|
+
def hash
|
103
|
+
[video_number, content].hash
|
104
|
+
end
|
105
|
+
|
106
|
+
# Builds the object from hash
|
107
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
108
|
+
# @return [Object] Returns the model itself
|
109
|
+
def build_from_hash(attributes)
|
110
|
+
return nil unless attributes.is_a?(Hash)
|
111
|
+
self.class.swagger_types.each_pair do |key, type|
|
112
|
+
if type =~ /\AArray<(.*)>/i
|
113
|
+
# check to ensure the input is an array given that the attribute
|
114
|
+
# is documented as an array but the input is not
|
115
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
116
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
117
|
+
end
|
118
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
119
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
120
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
121
|
+
end
|
122
|
+
|
123
|
+
self
|
124
|
+
end
|
125
|
+
|
126
|
+
# Deserializes the data based on type
|
127
|
+
# @param string type Data type
|
128
|
+
# @param string value Value to be deserialized
|
129
|
+
# @return [Object] Deserialized data
|
130
|
+
def _deserialize(type, value)
|
131
|
+
case type.to_sym
|
132
|
+
when :DateTime
|
133
|
+
DateTime.parse(value)
|
134
|
+
when :Date
|
135
|
+
Date.parse(value)
|
136
|
+
when :String
|
137
|
+
value.to_s
|
138
|
+
when :Integer
|
139
|
+
value.to_i
|
140
|
+
when :Float
|
141
|
+
value.to_f
|
142
|
+
when :BOOLEAN
|
143
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
144
|
+
true
|
145
|
+
else
|
146
|
+
false
|
147
|
+
end
|
148
|
+
when :Object
|
149
|
+
# generic object (usually a Hash), return directly
|
150
|
+
value
|
151
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
152
|
+
inner_type = Regexp.last_match[:inner_type]
|
153
|
+
value.map { |v| _deserialize(inner_type, v) }
|
154
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
155
|
+
k_type = Regexp.last_match[:k_type]
|
156
|
+
v_type = Regexp.last_match[:v_type]
|
157
|
+
{}.tap do |hash|
|
158
|
+
value.each do |k, v|
|
159
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
160
|
+
end
|
161
|
+
end
|
162
|
+
else # model
|
163
|
+
temp_model = CloudmersiveVideoApiClient.const_get(type).new
|
164
|
+
temp_model.build_from_hash(value)
|
165
|
+
end
|
166
|
+
end
|
167
|
+
|
168
|
+
# Returns the string representation of the object
|
169
|
+
# @return [String] String presentation of the object
|
170
|
+
def to_s
|
171
|
+
to_hash.to_s
|
172
|
+
end
|
173
|
+
|
174
|
+
# to_body is an alias to to_hash (backward compatibility)
|
175
|
+
# @return [Hash] Returns the object in the form of hash
|
176
|
+
def to_body
|
177
|
+
to_hash
|
178
|
+
end
|
179
|
+
|
180
|
+
# Returns the object in the form of hash
|
181
|
+
# @return [Hash] Returns the object in the form of hash
|
182
|
+
def to_hash
|
183
|
+
hash = {}
|
184
|
+
self.class.attribute_map.each_pair do |attr, param|
|
185
|
+
value = self.send(attr)
|
186
|
+
next if value.nil?
|
187
|
+
hash[param] = _to_hash(value)
|
188
|
+
end
|
189
|
+
hash
|
190
|
+
end
|
191
|
+
|
192
|
+
# Outputs non-array value in the form of hash
|
193
|
+
# For object, use to_hash. Otherwise, just return the value
|
194
|
+
# @param [Object] value Any valid value
|
195
|
+
# @return [Hash] Returns the value in the form of hash
|
196
|
+
def _to_hash(value)
|
197
|
+
if value.is_a?(Array)
|
198
|
+
value.compact.map { |v| _to_hash(v) }
|
199
|
+
elsif value.is_a?(Hash)
|
200
|
+
{}.tap do |hash|
|
201
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
202
|
+
end
|
203
|
+
elsif value.respond_to? :to_hash
|
204
|
+
value.to_hash
|
205
|
+
else
|
206
|
+
value
|
207
|
+
end
|
208
|
+
end
|
209
|
+
|
210
|
+
end
|
211
|
+
end
|
@@ -0,0 +1,91 @@
|
|
1
|
+
=begin
|
2
|
+
#videoapi
|
3
|
+
|
4
|
+
#The video APIs help you convert, encode, and transcode videos.
|
5
|
+
|
6
|
+
OpenAPI spec version: v1
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.14
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'spec_helper'
|
14
|
+
require 'json'
|
15
|
+
|
16
|
+
# Unit tests for CloudmersiveVideoApiClient::AudioApi
|
17
|
+
# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
|
18
|
+
# Please update as you see appropriate
|
19
|
+
describe 'AudioApi' do
|
20
|
+
before do
|
21
|
+
# run before each test
|
22
|
+
@instance = CloudmersiveVideoApiClient::AudioApi.new
|
23
|
+
end
|
24
|
+
|
25
|
+
after do
|
26
|
+
# run after each test
|
27
|
+
end
|
28
|
+
|
29
|
+
describe 'test an instance of AudioApi' do
|
30
|
+
it 'should create an instance of AudioApi' do
|
31
|
+
expect(@instance).to be_instance_of(CloudmersiveVideoApiClient::AudioApi)
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
# unit tests for audio_convert_to_aac
|
36
|
+
# Convert Audio File to AAC format.
|
37
|
+
# 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.
|
38
|
+
# @param [Hash] opts the optional parameters
|
39
|
+
# @option opts [File] :input_file Input file to perform the operation on.
|
40
|
+
# @option opts [String] :file_url Optional; URL of an audio file being used for conversion. Use this option for files larger than 2GB.
|
41
|
+
# @option opts [Object] :bit_rate 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.
|
42
|
+
# @return [String]
|
43
|
+
describe 'audio_convert_to_aac test' do
|
44
|
+
it 'should work' do
|
45
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
49
|
+
# unit tests for audio_convert_to_m4a
|
50
|
+
# Convert Audio File to M4A format.
|
51
|
+
# 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.
|
52
|
+
# @param [Hash] opts the optional parameters
|
53
|
+
# @option opts [File] :input_file Input file to perform the operation on.
|
54
|
+
# @option opts [String] :file_url Optional; URL of an audio file being used for conversion. Use this option for files larger than 2GB.
|
55
|
+
# @option opts [Object] :bit_rate 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.
|
56
|
+
# @return [String]
|
57
|
+
describe 'audio_convert_to_m4a test' do
|
58
|
+
it 'should work' do
|
59
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
60
|
+
end
|
61
|
+
end
|
62
|
+
|
63
|
+
# unit tests for audio_convert_to_mp3
|
64
|
+
# Convert Audio File to MP3 format.
|
65
|
+
# 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.
|
66
|
+
# @param [Hash] opts the optional parameters
|
67
|
+
# @option opts [File] :input_file Input file to perform the operation on.
|
68
|
+
# @option opts [String] :file_url Optional; URL of an audio file being used for conversion. Use this option for files larger than 2GB.
|
69
|
+
# @option opts [Object] :bit_rate 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.
|
70
|
+
# @return [String]
|
71
|
+
describe 'audio_convert_to_mp3 test' do
|
72
|
+
it 'should work' do
|
73
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
74
|
+
end
|
75
|
+
end
|
76
|
+
|
77
|
+
# unit tests for audio_convert_to_wav
|
78
|
+
# Convert Audio File to WAV format.
|
79
|
+
# 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.
|
80
|
+
# @param [Hash] opts the optional parameters
|
81
|
+
# @option opts [File] :input_file Input file to perform the operation on.
|
82
|
+
# @option opts [String] :file_url Optional; URL of an audio file being used for conversion. Use this option for files larger than 2GB.
|
83
|
+
# @option opts [Object] :sample_rate 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.
|
84
|
+
# @return [String]
|
85
|
+
describe 'audio_convert_to_wav test' do
|
86
|
+
it 'should work' do
|
87
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
88
|
+
end
|
89
|
+
end
|
90
|
+
|
91
|
+
end
|
data/spec/api/video_api_spec.rb
CHANGED
@@ -34,17 +34,16 @@ describe 'VideoApi' do
|
|
34
34
|
|
35
35
|
# unit tests for video_convert_to_gif
|
36
36
|
# Convert Video to Animated GIF format.
|
37
|
-
# 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.
|
38
|
-
# @param input_file Input file to perform the operation on.
|
37
|
+
# 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.
|
39
38
|
# @param [Hash] opts the optional parameters
|
39
|
+
# @option opts [File] :input_file Input file to perform the operation on.
|
40
40
|
# @option opts [String] :file_url Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
|
41
|
-
# @option opts [Integer] :max_width Optional; Maximum width of the output video, up to the original video width. Defaults to 250 pixels.
|
42
|
-
# @option opts [Integer] :max_height Optional; Maximum height of the output video, up to the original video width. Defaults to 250 pixels.
|
41
|
+
# @option opts [Integer] :max_width Optional; Maximum width of the output video, up to the original video width. Defaults to 250 pixels, maximum is 500 pixels.
|
42
|
+
# @option opts [Integer] :max_height Optional; Maximum height of the output video, up to the original video width. Defaults to 250 pixels, maximum is 500 pixels.
|
43
43
|
# @option opts [BOOLEAN] :preserve_aspect_ratio 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.
|
44
44
|
# @option opts [Integer] :frame_rate Optional; Specify the frame rate of the output video. Defaults to 24 frames per second.
|
45
|
-
# @option opts [BOOLEAN] :extend_processing_time 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.
|
46
45
|
# @option opts [DateTime] :start_time Optional; Specify the desired starting time of the GIF video in TimeSpan format.
|
47
|
-
# @option opts [DateTime] :time_span Optional; Specify the desired length of the GIF video in TimeSpan format. Limit is 30
|
46
|
+
# @option opts [DateTime] :time_span Optional; Specify the desired length of the GIF video in TimeSpan format. Limit is 30 seconds. Default is 10 seconds.
|
48
47
|
# @return [String]
|
49
48
|
describe 'video_convert_to_gif test' do
|
50
49
|
it 'should work' do
|
@@ -54,16 +53,15 @@ describe 'VideoApi' do
|
|
54
53
|
|
55
54
|
# unit tests for video_convert_to_mov
|
56
55
|
# Convert Video to MOV format.
|
57
|
-
# 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.
|
58
|
-
# @param input_file Input file to perform the operation on.
|
56
|
+
# 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.
|
59
57
|
# @param [Hash] opts the optional parameters
|
58
|
+
# @option opts [File] :input_file Input file to perform the operation on.
|
60
59
|
# @option opts [String] :file_url Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
|
61
60
|
# @option opts [Integer] :max_width Optional; Maximum width of the output video, up to the original video width. Defaults to original video width.
|
62
61
|
# @option opts [Integer] :max_height Optional; Maximum height of the output video, up to the original video width. Defaults to original video height.
|
63
62
|
# @option opts [BOOLEAN] :preserve_aspect_ratio 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.
|
64
63
|
# @option opts [Integer] :frame_rate Optional; Specify the frame rate of the output video. Defaults to original video frame rate.
|
65
64
|
# @option opts [Integer] :quality 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.
|
66
|
-
# @option opts [BOOLEAN] :extend_processing_time 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.
|
67
65
|
# @return [String]
|
68
66
|
describe 'video_convert_to_mov test' do
|
69
67
|
it 'should work' do
|
@@ -73,16 +71,15 @@ describe 'VideoApi' do
|
|
73
71
|
|
74
72
|
# unit tests for video_convert_to_mp4
|
75
73
|
# Convert Video to MP4 format.
|
76
|
-
# 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.
|
77
|
-
# @param input_file Input file to perform the operation on.
|
74
|
+
# 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.
|
78
75
|
# @param [Hash] opts the optional parameters
|
76
|
+
# @option opts [File] :input_file Input file to perform the operation on.
|
79
77
|
# @option opts [String] :file_url Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
|
80
78
|
# @option opts [Integer] :max_width Optional; Maximum width of the output video, up to the original video width. Defaults to original video width.
|
81
79
|
# @option opts [Integer] :max_height Optional; Maximum height of the output video, up to the original video width. Defaults to original video height.
|
82
80
|
# @option opts [BOOLEAN] :preserve_aspect_ratio 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.
|
83
81
|
# @option opts [Integer] :frame_rate Optional; Specify the frame rate of the output video. Defaults to original video frame rate.
|
84
82
|
# @option opts [Integer] :quality 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.
|
85
|
-
# @option opts [BOOLEAN] :extend_processing_time 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.
|
86
83
|
# @return [String]
|
87
84
|
describe 'video_convert_to_mp4 test' do
|
88
85
|
it 'should work' do
|
@@ -90,18 +87,33 @@ describe 'VideoApi' do
|
|
90
87
|
end
|
91
88
|
end
|
92
89
|
|
90
|
+
# unit tests for video_convert_to_still_frames
|
91
|
+
# Convert Video to PNG Still Frames.
|
92
|
+
# 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.
|
93
|
+
# @param [Hash] opts the optional parameters
|
94
|
+
# @option opts [File] :input_file Input file to perform the operation on.
|
95
|
+
# @option opts [String] :file_url Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
|
96
|
+
# @option opts [Integer] :max_width Optional; Maximum width of the output video, up to the original video width. Defaults to original video width.
|
97
|
+
# @option opts [Integer] :max_height Optional; Maximum height of the output video, up to the original video width. Defaults to original video height.
|
98
|
+
# @option opts [Object] :frames_per_second 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.
|
99
|
+
# @return [StillFramesResult]
|
100
|
+
describe 'video_convert_to_still_frames test' do
|
101
|
+
it 'should work' do
|
102
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
103
|
+
end
|
104
|
+
end
|
105
|
+
|
93
106
|
# unit tests for video_convert_to_webm
|
94
107
|
# Convert Video to WEBM format.
|
95
|
-
# 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.
|
96
|
-
# @param input_file Input file to perform the operation on.
|
108
|
+
# 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.
|
97
109
|
# @param [Hash] opts the optional parameters
|
110
|
+
# @option opts [File] :input_file Input file to perform the operation on.
|
98
111
|
# @option opts [String] :file_url Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
|
99
112
|
# @option opts [Integer] :max_width Optional; Maximum width of the output video, up to the original video width. Defaults to original video width.
|
100
113
|
# @option opts [Integer] :max_height Optional; Maximum height of the output video, up to the original video width. Defaults to original video height.
|
101
114
|
# @option opts [BOOLEAN] :preserve_aspect_ratio 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.
|
102
115
|
# @option opts [Integer] :frame_rate Optional; Specify the frame rate of the output video. Defaults to original video frame rate.
|
103
116
|
# @option opts [Integer] :quality 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.
|
104
|
-
# @option opts [BOOLEAN] :extend_processing_time 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.
|
105
117
|
# @return [String]
|
106
118
|
describe 'video_convert_to_webm test' do
|
107
119
|
it 'should work' do
|
@@ -109,17 +121,97 @@ describe 'VideoApi' do
|
|
109
121
|
end
|
110
122
|
end
|
111
123
|
|
124
|
+
# unit tests for video_cut_video
|
125
|
+
# Cut a Video to a Shorter Length
|
126
|
+
# 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.
|
127
|
+
# @param [Hash] opts the optional parameters
|
128
|
+
# @option opts [File] :input_file Input file to perform the operation on.
|
129
|
+
# @option opts [String] :file_url Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
|
130
|
+
# @option opts [DateTime] :start_time Optional; Specify the desired starting time of the cut video in TimeSpan format.
|
131
|
+
# @option opts [DateTime] :time_span 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.
|
132
|
+
# @return [String]
|
133
|
+
describe 'video_cut_video test' do
|
134
|
+
it 'should work' do
|
135
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
136
|
+
end
|
137
|
+
end
|
138
|
+
|
112
139
|
# unit tests for video_get_info
|
113
140
|
# Get detailed information about a video or audio file
|
114
141
|
# Retrieve detailed information about a video or audio file, including format, dimensions, file size, bit rate, duration and start time. Compatible with many formats, including: AVI, ASF, FLV, GIF, MP4, MPEG/MPG, Matroska/WEBM, MOV, AIFF, ASF, CAF, MP3, MP2, MP1, Ogg, OMG/OMA, and WAV. Uses 1 API call per 10 MB of file size.
|
115
|
-
# @param input_file Input file to perform the operation on.
|
116
142
|
# @param [Hash] opts the optional parameters
|
143
|
+
# @option opts [File] :input_file Input file to perform the operation on.
|
117
144
|
# @option opts [String] :file_url Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
|
118
|
-
# @return [
|
145
|
+
# @return [MediaInformation]
|
119
146
|
describe 'video_get_info test' do
|
120
147
|
it 'should work' do
|
121
148
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
122
149
|
end
|
123
150
|
end
|
124
151
|
|
152
|
+
# unit tests for video_resize_video
|
153
|
+
# Resizes a Video Preserving the Original Aspect Ratio.
|
154
|
+
# 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.
|
155
|
+
# @param [Hash] opts the optional parameters
|
156
|
+
# @option opts [File] :input_file Input file to perform the operation on.
|
157
|
+
# @option opts [String] :file_url Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
|
158
|
+
# @option opts [Integer] :max_width Optional; Maximum width of the output video, up to the original video width. Defaults to original video width.
|
159
|
+
# @option opts [Integer] :max_height Optional; Maximum height of the output video, up to the original video width. Defaults to original video height.
|
160
|
+
# @option opts [Integer] :frame_rate Optional; Specify the frame rate of the output video. Defaults to original video frame rate.
|
161
|
+
# @option opts [Integer] :quality 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.
|
162
|
+
# @option opts [String] :extension 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.
|
163
|
+
# @return [String]
|
164
|
+
describe 'video_resize_video test' do
|
165
|
+
it 'should work' do
|
166
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
167
|
+
end
|
168
|
+
end
|
169
|
+
|
170
|
+
# unit tests for video_resize_video_simple
|
171
|
+
# Resizes a Video without Preserving Aspect Ratio.
|
172
|
+
# 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.
|
173
|
+
# @param [Hash] opts the optional parameters
|
174
|
+
# @option opts [File] :input_file Input file to perform the operation on.
|
175
|
+
# @option opts [String] :file_url Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
|
176
|
+
# @option opts [Integer] :max_width Optional; Maximum width of the output video, up to the original video width. Defaults to original video width.
|
177
|
+
# @option opts [Integer] :max_height Optional; Maximum height of the output video, up to the original video width. Defaults to original video height.
|
178
|
+
# @option opts [Integer] :frame_rate Optional; Specify the frame rate of the output video. Defaults to original video frame rate.
|
179
|
+
# @option opts [Integer] :quality 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.
|
180
|
+
# @option opts [String] :extension 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.
|
181
|
+
# @return [String]
|
182
|
+
describe 'video_resize_video_simple test' do
|
183
|
+
it 'should work' do
|
184
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
185
|
+
end
|
186
|
+
end
|
187
|
+
|
188
|
+
# unit tests for video_scan_for_nsfw
|
189
|
+
# Scan a Video for NSFW content.
|
190
|
+
# 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.
|
191
|
+
# @param [Hash] opts the optional parameters
|
192
|
+
# @option opts [File] :input_file Input file to perform the operation on.
|
193
|
+
# @option opts [String] :file_url Optional; URL of a video file being scanned. Use this option for files larger than 2GB.
|
194
|
+
# @option opts [Object] :frames_per_second 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.
|
195
|
+
# @return [NsfwResult]
|
196
|
+
describe 'video_scan_for_nsfw test' do
|
197
|
+
it 'should work' do
|
198
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
199
|
+
end
|
200
|
+
end
|
201
|
+
|
202
|
+
# unit tests for video_split_video
|
203
|
+
# Split a Video into Two Shorter Videos
|
204
|
+
# 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.
|
205
|
+
# @param split_time Specify the desired time at which to split the video in TimeSpan format.
|
206
|
+
# @param [Hash] opts the optional parameters
|
207
|
+
# @option opts [File] :input_file Input file to perform the operation on.
|
208
|
+
# @option opts [String] :file_url Optional; URL of a video file being used for conversion. Use this option for files larger than 2GB.
|
209
|
+
# @option opts [DateTime] :time_span 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.
|
210
|
+
# @return [SplitVideoResult]
|
211
|
+
describe 'video_split_video test' do
|
212
|
+
it 'should work' do
|
213
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
214
|
+
end
|
215
|
+
end
|
216
|
+
|
125
217
|
end
|