Connectors Reference
Cloudmersive Video and Media Connector is critical for converting, editing, resizing, moderating and processing video, audio and other media. Cloudmersive Video and Media Services covers a wide array of common video and audio processing needs, including encoding, decoding, editing, resizing, moderating and extracting metadata. Stateless high-security processing ensures fast performance and strong security.
|
Status: Preview |
Tier: Premium |
Version: v1 |
|
Name |
Summary |
|
Audio_ConvertToMp3 ([Optional]file inputFile, [Optional]string fileUrl, [Optional]integer bitRate) |
Convert Audio File to MP3 format |
|
Audio_ConvertToM4a ([Optional]file inputFile, [Optional]string fileUrl, [Optional]integer bitRate) |
Convert Audio File to M4A format |
|
Audio_ConvertToAac ([Optional]file inputFile, [Optional]string fileUrl, [Optional]integer bitRate) |
Convert Audio File to AAC format |
|
Audio_ConvertToWav ([Optional]file inputFile, [Optional]string fileUrl, [Optional]number sampleRate) |
Convert Audio File to WAV format |
|
Video_GetInfo ([Optional]file inputFile, [Optional]string fileUrl) |
Get detailed information about a video or audio file |
|
Convert Video to WEBM format |
|
|
Convert Video to MOV format |
|
|
Convert Video to MP4 format |
|
|
Convert Video to Animated GIF format |
|
|
Resizes a Video Preserving the Original Aspect Ratio |
|
|
Resizes a Video without Preserving Aspect Ratio |
|
|
Cut a Video to a Shorter Length |
|
|
Split a Video into Two Shorter Videos |
|
|
Convert Video to PNG Still Frames |
|
|
Scan a Video for NSFW content |
|
Name |
Summary |
|
Name |
Summary |
|
Input file to perform the operation on. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Convert Audio File to MP3 format
Description: 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.
Syntax:
CloudmersiveVideoandMedia.Audio_ConvertToMp3 ([Optional]file inputFile, [Optional]string fileUrl, [Optional]integer bitRate)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
False |
|
|
fileUrl |
string (Optional; URL of an audio file being used for conversion) |
Optional; URL of an audio file being used for conversion. Use this opt... |
False |
|
|
bitRate |
integer (Optional; Specify the desired bitrate of the converted audio file) |
Optional; Specify the desired bitrate of the converted audio file in k... |
False |
Returns:
Type:string(binary)
Summary: Convert Audio File to M4A format
Description: 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.
Syntax:
CloudmersiveVideoandMedia.Audio_ConvertToM4a ([Optional]file inputFile, [Optional]string fileUrl, [Optional]integer bitRate)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputFile |
(Input file to perform the operation on) |
Input file to perform the operation on. |
False |
|
|
fileUrl |
string (Optional; URL of an audio file being used for conversion) |
Optional; URL of an audio file being used for conversion. Use this opt... |
False |
|
|
bitRate |
integer (Optional; Specify the desired bitrate of the converted audio file) |
Optional; Specify the desired bitrate of the converted audio file in k... |
False |
Returns:
Type:string(binary)
Summary: Convert Audio File to AAC format
Description: 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.
Syntax:
CloudmersiveVideoandMedia.Audio_ConvertToAac ([Optional]file inputFile, [Optional]string fileUrl, [Optional]integer bitRate)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputFile |
(Input file to perform the operation on) |
Input file to perform the operation on. |
False |
|
|
fileUrl |
string (Optional; URL of an audio file being used for conversion) |
Optional; URL of an audio file being used for conversion. Use this opt... |
False |
|
|
bitRate |
integer (Optional; Specify the desired bitrate of the converted audio file) |
Optional; Specify the desired bitrate of the converted audio file in k... |
False |
Returns:
Type:string(binary)
Summary: Convert Audio File to WAV format
Description: 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.
Syntax:
CloudmersiveVideoandMedia.Audio_ConvertToWav ([Optional]file inputFile, [Optional]string fileUrl, [Optional]number sampleRate)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputFile |
(Input file to perform the operation on) |
Input file to perform the operation on. |
False |
|
|
fileUrl |
string (Optional; URL of an audio file being used for conversion) |
Optional; URL of an audio file being used for conversion. Use this opt... |
False |
|
|
sampleRate |
number (Optional; Specify the desired sample rate of the converted audio file) |
Optional; Specify the desired sample rate of the converted audio file ... |
False |
Returns:
Type:string(binary)
Summary: Get detailed information about a video or audio file
Description: 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.
Syntax:
CloudmersiveVideoandMedia.Video_GetInfo ([Optional]file inputFile, [Optional]string fileUrl)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
False |
|
|
fileUrl |
string (Optional; URL of a video file being used for conversion) |
Optional; URL of a video file being used for conversion. Use this opti... |
False |
Returns:
Type:MediaInformation
Description: Result of retrieving information about a video or audio file
Summary: Convert Video to WEBM format
Description: 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.
Syntax:
CloudmersiveVideoandMedia.Video_ConvertToWebm ([Optional]file inputFile, [Optional]string fileUrl, [Optional]integer maxWidth, [Optional]integer maxHeight, [Optional]boolean preserveAspectRatio, [Optional]integer frameRate, [Optional]integer quality)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputFile |
(Input file to perform the operation on) |
Input file to perform the operation on. |
False |
|
|
fileUrl |
string (Optional; URL of a video file being used for conversion) |
Optional; URL of a video file being used for conversion. Use this opti... |
False |
|
|
maxWidth |
integer (Optional; Maximum width of the output video, up to the original video) |
Optional; Maximum width of the output video, up to the original video ... |
False |
|
|
maxHeight |
integer (Optional; Maximum height of the output video, up to the original video) |
Optional; Maximum height of the output video, up to the original video... |
False |
|
|
preserveAspectRatio |
boolean (Optional; If false, the original video's aspect ratio) |
Optional; If false, the original video's aspect ratio will not be pres... |
False |
|
|
frameRate |
integer (Optional; Specify the frame rate of the output video) |
Optional; Specify the frame rate of the output video. Defaults to orig... |
False |
|
|
quality |
integer (Optional; Specify the quality of the output video) |
Optional; Specify the quality of the output video, where 100 is lossle... |
False |
Returns:
Type:string(binary)
Summary: Convert Video to MOV format
Description: 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.
Syntax:
CloudmersiveVideoandMedia.Video_ConvertToMov ([Optional]file inputFile, [Optional]string fileUrl, [Optional]integer maxWidth, [Optional]integer maxHeight, [Optional]boolean preserveAspectRatio, [Optional]integer frameRate, [Optional]integer quality)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
False |
|
|
fileUrl |
string (Optional; URL of a video file being used for conversion) |
Optional; URL of a video file being used for conversion. Use this opti... |
False |
|
|
maxWidth |
integer (Optional; Maximum width of the output video, up to the original video) |
Optional; Maximum width of the output video, up to the original video ... |
False |
|
|
maxHeight |
integer (Optional; Maximum height of the output video, up to the original video) |
Optional; Maximum height of the output video, up to the original video... |
False |
|
|
preserveAspectRatio |
boolean (Optional; If false, the original video's aspect ratio will not be pres) |
Optional; If false, the original video's aspect ratio will not be pres... |
False |
|
|
frameRate |
integer (Optional; Specify the frame rate of the output video. Defaults to orig) |
Optional; Specify the frame rate of the output video. Defaults to orig... |
False |
|
|
quality |
integer (Optional; Specify the quality of the output video) |
Optional; Specify the quality of the output video, where 100 is lossle... |
False |
Returns:
Type:string(binary)
Summary: Convert Video to MP4 format
Description: 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.
Syntax:
CloudmersiveVideoandMedia.Video_ConvertToMp4 ([Optional]file inputFile, [Optional]string fileUrl, [Optional]integer maxWidth, [Optional]integer maxHeight, [Optional]boolean preserveAspectRatio, [Optional]integer frameRate, [Optional]integer quality)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputFile |
(Input file to perform the operation on) |
Input file to perform the operation on. |
False |
|
|
fileUrl |
string (Optional; URL of a video file being used for conversion) |
Optional; URL of a video file being used for conversion. Use this opti... |
False |
|
|
maxWidth |
integer (Optional; Maximum width of the output video, up to the original video) |
Optional; Maximum width of the output video, up to the original video ... |
False |
|
|
maxHeight |
integer (Optional; Maximum height of the output video, up to the original video) |
Optional; Maximum height of the output video, up to the original video... |
False |
|
|
preserveAspectRatio |
boolean (Optional; If false, the original video's aspect ratio) |
Optional; If false, the original video's aspect ratio will not be pres... |
False |
|
|
frameRate |
integer (Optional; Specify the frame rate of the output video) |
Optional; Specify the frame rate of the output video. Defaults to orig... |
False |
|
|
quality |
integer (Optional; Specify the quality of the output video) |
Optional; Specify the quality of the output video, where 100 is lossle... |
False |
Returns:
Type:string(binary)
Summary: Convert Video to Animated GIF format
Description: 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.
Syntax:
CloudmersiveVideoandMedia.Video_ConvertToGif ([Optional]file inputFile, [Optional]string fileUrl, [Optional]integer maxWidth, [Optional]integer maxHeight, [Optional]boolean preserveAspectRatio, [Optional]integer frameRate, [Optional]string startTime, [Optional]string timeSpan)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputFile |
(Input file to perform the operation on) |
Input file to perform the operation on. |
False |
|
|
fileUrl |
string (Optional; URL of a video file being used for conversion) |
Optional; URL of a video file being used for conversion. Use this opti... |
False |
|
|
maxWidth |
integer (Optional; Maximum width of the output video) |
Optional; Maximum width of the output video, up to the original video ... |
False |
|
|
maxHeight |
integer (Optional; Maximum height of the output video) |
Optional; Maximum height of the output video, up to the original video... |
False |
|
|
preserveAspectRatio |
boolean (Optional; If false, the original video's aspect ratio) |
Optional; If false, the original video's aspect ratio will not be pres... |
False |
|
|
frameRate |
integer (Optional; Specify the frame rate of the output video) |
Optional; Specify the frame rate of the output video. Defaults to 24 f... |
False |
|
|
startTime |
string(date-time) (Optional; Specify the desired starting time of the GIF video in TimeSpan format) |
Optional; Specify the desired starting time of the GIF video in TimeSpan format. |
False |
|
|
timeSpan |
string(date-time) (Optional; Specify the desired length of the GIF video) |
Optional; Specify the desired length of the GIF video in TimeSpan form... |
False |
Returns:
Type:string(binary)
Summary: Resizes a Video Preserving the Original Aspect Ratio
Description: 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.
Syntax:
CloudmersiveVideoandMedia.Video_ResizeVideo ([Optional]file inputFile, [Optional]string fileUrl, [Optional]integer maxWidth, [Optional]integer maxHeight, [Optional]integer frameRate, [Optional]integer quality, [Optional]string extension)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputFile |
(Input file to perform the operation on) |
Input file to perform the operation on. |
False |
|
|
fileUrl |
string (Optional; URL of a video file being used for conversion) |
Optional; URL of a video file being used for conversion. Use this opti... |
False |
|
|
maxWidth |
integer (Optional; Maximum width of the output video) |
Optional; Maximum width of the output video, up to the original video ... |
False |
|
|
maxHeight |
integer (Optional; Maximum height of the output video) |
Optional; Maximum height of the output video, up to the original video... |
False |
|
|
frameRate |
integer (Optional; Specify the frame rate of the output video) |
Optional; Specify the frame rate of the output video. Defaults to orig... |
False |
|
|
quality |
integer (Optional; Specify the quality of the output video) |
Optional; Specify the quality of the output video, where 100 is lossle... |
False |
|
|
extension |
string (Optional; Specify the file extension of the input video) |
Optional; Specify the file extension of the input video. This is recom... |
False |
Returns:
Type:string(binary)
Summary: Resizes a Video without Preserving Aspect Ratio
Description: 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.
Syntax:
CloudmersiveVideoandMedia.Video_ResizeVideoSimple ([Optional]file inputFile, [Optional]string fileUrl, [Optional]integer maxWidth, [Optional]integer maxHeight, [Optional]integer frameRate, [Optional]integer quality, [Optional]string extension)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputFile |
(Input file to perform the operation on) |
Input file to perform the operation on. |
False |
|
|
fileUrl |
string (Optional; URL of a video file being used for conversion) |
Optional; URL of a video file being used for conversion. Use this opti... |
False |
|
|
maxWidth |
integer (Optional; Maximum width of the output video) |
Optional; Maximum width of the output video, up to the original video ... |
False |
|
|
maxHeight |
integer (Optional; Maximum height of the output video) |
Optional; Maximum height of the output video, up to the original video... |
False |
|
|
frameRate |
integer (Optional; Specify the frame rate of the output video) |
Optional; Specify the frame rate of the output video. Defaults to orig... |
False |
|
|
quality |
integer (Optional; Specify the quality of the output video) |
Optional; Specify the quality of the output video, where 100 is lossle... |
False |
|
|
extension |
string (Optional; Specify the file extension of the input video) |
Optional; Specify the file extension of the input video. This is recom... |
False |
Returns:
Type:string(binary)
Summary: Cut a Video to a Shorter Length
Description: 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.
Syntax:
CloudmersiveVideoandMedia.Video_CutVideo ([Optional]file inputFile, [Optional]string fileUrl, [Optional]string startTime, [Optional]string timeSpan)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputFile |
(Input file to perform the operation on) |
Input file to perform the operation on. |
False |
|
|
fileUrl |
string (Optional; URL of a video file being used for conversion) |
Optional; URL of a video file being used for conversion. Use this opti... |
False |
|
|
startTime |
string(date-time) (Optional; Specify the desired starting time of the cut video in TimeSpan format) |
Optional; Specify the desired starting time of the cut video in TimeSpan format. |
False |
|
|
timeSpan |
string(date-time) (Optional; Specify the desired length of the cut video in TimeSpan form) |
Optional; Specify the desired length of the cut video in TimeSpan form... |
False |
Returns:
Type:string(binary)
Summary: Split a Video into Two Shorter Videos
Description: 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.
Syntax:
CloudmersiveVideoandMedia.Video_SplitVideo ([Optional]file inputFile, [Optional]string fileUrl, string splitTime, [Optional]string timeSpan)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputFile |
(Input file to perform the operation on) |
Input file to perform the operation on. |
False |
|
|
fileUrl |
string (Optional; URL of a video file being used for conversion) |
Optional; URL of a video file being used for conversion. Use this opti... |
False |
|
|
splitTime |
string(date-time) (Specify the desired time at which to split the video in TimeSpan format) |
Specify the desired time at which to split the video in TimeSpan format. |
True |
|
|
timeSpan |
string(date-time) (Optional; Specify the desired length of the second video in TimeSpan) |
Optional; Specify the desired length of the second video in TimeSpan f... |
False |
Returns:
Type:SplitVideoResult
Description: The result of splitting a video
Summary: Convert Video to PNG Still Frames
Description: 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.
Syntax:
CloudmersiveVideoandMedia.Video_ConvertToStillFrames ([Optional]file inputFile, [Optional]string fileUrl, [Optional]integer maxWidth, [Optional]integer maxHeight, [Optional]number framesPerSecond)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputFile |
(Input file to perform the operation on.) |
Input file to perform the operation on. |
False |
|
|
fileUrl |
string (Optional; URL of a video file being used for conversion) |
Optional; URL of a video file being used for conversion. Use this opti... |
False |
|
|
maxWidth |
integer (Optional; Maximum width of the output video) |
Optional; Maximum width of the output video, up to the original video ... |
False |
|
|
maxHeight |
integer (Optional; Maximum height of the output video) |
Optional; Maximum height of the output video, up to the original video... |
False |
|
|
framesPerSecond |
number (Optional; How many video frames per second to be returned as PNG image) |
Optional; How many video frames per second to be returned as PNG image... |
False |
Returns:
Type:StillFramesResult
Description: The result of converting a video into still frames
Summary: Scan a Video for NSFW content
Description: 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.
Syntax:
CloudmersiveVideoandMedia.Video_ScanForNsfw ([Optional]file inputFile, [Optional]string fileUrl, [Optional]number framesPerSecond)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
inputFile |
(Input file to perform the operation on) |
Input file to perform the operation on. |
False |
|
|
fileUrl |
string (Optional; URL of a video file being scanned. Use this option for files) |
Optional; URL of a video file being scanned. Use this option for files... |
False |
|
|
framesPerSecond |
number (Optional; How many video frames per second to be scanned) |
Optional; How many video frames per second to be scanned |
False |
Returns:
Type:NsfwResult
Description: The result of scanning a video file for NSFW content
Summary: Input file to perform the operation on.
Description: Input file to perform the operation on.
Properties:
|
Name |
Type |
Summary |
Summary:
Description: Result of retrieving information about a video or audio file
Properties:
|
Name |
Type |
Summary |
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
|
FileFormat |
string
|
The file's short format name |
|
FileFormatFull |
string
|
The file's full format name |
|
ValidFileFormats |
array of (string)
|
A list of the file's valid formats |
|
Width |
integer(int32)
|
The video's width, if file is a video |
|
Height |
integer(int32)
|
The video's height, if file is a video |
|
Size |
integer(int32)
|
The file's size in bytes |
|
BitRate |
integer(int32)
|
The file's bit rate |
|
Duration |
number(double)
|
The file's duration in seconds |
|
StartTime |
number(double)
|
The file's media start time |
Summary:
Description: The result of scanning a video file for NSFW content
Properties:
|
Name |
Type |
Summary |
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
|
HighestClassificationResult |
string
|
The highest NSFW classification of the video |
|
HighestScore |
number(double)
|
The highest NSFW score out of all frames scanned |
|
TotalRacyFrames |
integer(int32)
|
The total number of potentially "racy" frames. |
|
TotalNsfwFrames |
integer(int32)
|
The total number of frames with high probability of NSFW. |
|
TotalFrames |
integer(int32)
|
The total number of frames scanned |
|
NsfwScannedFrames |
array of (NsfwScannedFrame)
|
The NSFW scanning results for each frame |
Summary:
Description: An individual frame scanned for NSFW content
Properties:
|
Name |
Type |
Summary |
|
FrameNumber |
integer(int32)
|
The number of the current frame |
|
TimeStamp |
string
|
The playback time of the current frame |
|
Content |
string(byte)
|
The still frame in PNG format as a byte array |
|
ClassificationResult |
string
|
The NSFW classification of the still frame |
|
Score |
number(double)
|
The NSFW score of the current frame |
Summary:
Description: The result of splitting a video
Properties:
|
Name |
Type |
Summary |
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
|
Videos |
array of (VideoFile)
|
Individual video files resulting from the split operation |
Summary:
Description: A single still frame from a video
Properties:
|
Name |
Type |
Summary |
|
FrameNumber |
integer(int32)
|
The number of the current frame |
|
TimeStamp |
string
|
The playback time of the current frame |
|
Content |
string(byte)
|
The still frame in PNG format as a byte array |
Summary:
Description: The result of converting a video into still frames
Properties:
|
Name |
Type |
Summary |
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
|
TotalFrames |
integer(int32)
|
The total number of frames converted |
|
StillFrames |
array of (StillFrame)
|
Individual still frames from the conversion operation |
Summary:
Description: A video file
Properties:
|
Name |
Type |
Summary |
|
VideoNumber |
integer(int32)
|
Sequence number of the video |
|
Content |
string(byte)
|
The video file as a byte array |