Jaa


Cloudmersive Video and Media (Preview)

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.

This connector is available in the following products and regions:

Service Class Regions
Logic Apps Standard All Logic Apps regions except the following:
     -   Azure Government regions
     -   Azure China regions
     -   US Department of Defense (DoD)
Power Automate Premium All Power Automate regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Power Apps Premium All Power Apps regions except the following:
     -   US Government (GCC)
     -   US Government (GCC High)
     -   China Cloud operated by 21Vianet
     -   US Department of Defense (DoD)
Contact
Name Cloumdersive Support
URL https://account.cloudmersive.com/contact-support
Email support@cloudmersive.com
Connector Metadata
Publisher Cloudmersive, LLC
Website https://www.cloudmersive.com/nlp-api
Privacy policy https://www.cloudmersive.com/privacy-policy
Categories AI;Content and Files

This 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. You can learn more at the Video and Media Services API page.

Prerequisites

To use the Video and Media connector, you need a Cloudmersive account and API Key. You can sign up for a free account or choose from one of the available paid plans.

How to get credentials?

You can sign up with a Microsoft Account or create a Cloudmersive account. Follow the steps below to get your API Key.

  • Register for a Cloudmersive Account
  • Sign In with your Cloudmersive Account and click on API Keys

Here you can create and see your API key(s) listed on the API Keys page. Simply copy and paste this API Key into the Cloudmersive Video and Media Connector.

Now you are ready to start using the Cloudmersive Video and Media Connector.

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name Type Description Required
API Key (from https://cloudmersive.com) securestring The Api Key for this API True

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Convert Audio File to AAC format

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.

Convert Audio File to M4A format

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.

Convert Audio File to MP3 format

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.

Convert Audio File to WAV format

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.

Convert Video to Animated GIF format

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.

Convert Video to MOV format

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.

Convert Video to MP4 format

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.

Convert Video to PNG Still Frames

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.

Convert Video to WEBM format

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.

Cut a Video to a Shorter Length

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.

Get detailed information about a video or audio file

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.

Resizes a Video Preserving the Original Aspect Ratio

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.

Resizes a Video without Preserving Aspect Ratio

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.

Scan a Video for NSFW content

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.

Split a Video into Two Shorter Videos

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.

Convert Audio File to AAC format

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.

Parameters

Name Key Required Type Description
Input file to perform the operation on
inputFile file

Input file to perform the operation on.

Optional; URL of an audio file being used for conversion
fileUrl string

Optional; URL of an audio file being used for conversion. Use this opt...

Optional; Specify the desired bitrate of the converted audio file
bitRate integer

Optional; Specify the desired bitrate of the converted audio file in k...

Returns

response
binary

Convert Audio File to M4A format

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.

Parameters

Name Key Required Type Description
Input file to perform the operation on
inputFile file

Input file to perform the operation on.

Optional; URL of an audio file being used for conversion
fileUrl string

Optional; URL of an audio file being used for conversion. Use this opt...

Optional; Specify the desired bitrate of the converted audio file
bitRate integer

Optional; Specify the desired bitrate of the converted audio file in k...

Returns

response
binary

Convert Audio File to MP3 format

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.

Parameters

Name Key Required Type Description
Input file to perform the operation on.
inputFile file

Input file to perform the operation on.

Optional; URL of an audio file being used for conversion
fileUrl string

Optional; URL of an audio file being used for conversion. Use this opt...

Optional; Specify the desired bitrate of the converted audio file
bitRate integer

Optional; Specify the desired bitrate of the converted audio file in k...

Returns

response
binary

Convert Audio File to WAV format

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.

Parameters

Name Key Required Type Description
Input file to perform the operation on
inputFile file

Input file to perform the operation on.

Optional; URL of an audio file being used for conversion
fileUrl string

Optional; URL of an audio file being used for conversion. Use this opt...

Optional; Specify the desired sample rate of the converted audio file
sampleRate number

Optional; Specify the desired sample rate of the converted audio file ...

Returns

response
binary

Convert Video to Animated GIF format

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.

Parameters

Name Key Required Type Description
Input file to perform the operation on
inputFile file

Input file to perform the operation on.

Optional; URL of a video file being used for conversion
fileUrl string

Optional; URL of a video file being used for conversion. Use this opti...

Optional; Maximum width of the output video
maxWidth integer

Optional; Maximum width of the output video, up to the original video ...

Optional; Maximum height of the output video
maxHeight integer

Optional; Maximum height of the output video, up to the original video...

Optional; If false, the original video's aspect ratio
preserveAspectRatio boolean

Optional; If false, the original video's aspect ratio will not be pres...

Optional; Specify the frame rate of the output video
frameRate integer

Optional; Specify the frame rate of the output video. Defaults to 24 f...

Optional; Specify the desired starting time of the GIF video in TimeSpan format
startTime date-time

Optional; Specify the desired starting time of the GIF video in TimeSpan format.

Optional; Specify the desired length of the GIF video
timeSpan date-time

Optional; Specify the desired length of the GIF video in TimeSpan form...

Returns

response
binary

Convert Video to MOV format

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.

Parameters

Name Key Required Type Description
Input file to perform the operation on.
inputFile file

Input file to perform the operation on.

Optional; URL of a video file being used for conversion
fileUrl string

Optional; URL of a video file being used for conversion. Use this opti...

Optional; Maximum width of the output video, up to the original video
maxWidth integer

Optional; Maximum width of the output video, up to the original video ...

Optional; Maximum height of the output video, up to the original video
maxHeight integer

Optional; Maximum height of the output video, up to the original video...

Optional; If false, the original video's aspect ratio will not be pres
preserveAspectRatio boolean

Optional; If false, the original video's aspect ratio will not be pres...

Optional; Specify the frame rate of the output video. Defaults to orig
frameRate integer

Optional; Specify the frame rate of the output video. Defaults to orig...

Optional; Specify the quality of the output video
quality integer

Optional; Specify the quality of the output video, where 100 is lossle...

Returns

response
binary

Convert Video to MP4 format

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.

Parameters

Name Key Required Type Description
Input file to perform the operation on
inputFile file

Input file to perform the operation on.

Optional; URL of a video file being used for conversion
fileUrl string

Optional; URL of a video file being used for conversion. Use this opti...

Optional; Maximum width of the output video, up to the original video
maxWidth integer

Optional; Maximum width of the output video, up to the original video ...

Optional; Maximum height of the output video, up to the original video
maxHeight integer

Optional; Maximum height of the output video, up to the original video...

Optional; If false, the original video's aspect ratio
preserveAspectRatio boolean

Optional; If false, the original video's aspect ratio will not be pres...

Optional; Specify the frame rate of the output video
frameRate integer

Optional; Specify the frame rate of the output video. Defaults to orig...

Optional; Specify the quality of the output video
quality integer

Optional; Specify the quality of the output video, where 100 is lossle...

Returns

response
binary

Convert Video to PNG Still Frames

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.

Parameters

Name Key Required Type Description
Input file to perform the operation on.
inputFile file

Input file to perform the operation on.

Optional; URL of a video file being used for conversion
fileUrl string

Optional; URL of a video file being used for conversion. Use this opti...

Optional; Maximum width of the output video
maxWidth integer

Optional; Maximum width of the output video, up to the original video ...

Optional; Maximum height of the output video
maxHeight integer

Optional; Maximum height of the output video, up to the original video...

Optional; How many video frames per second to be returned as PNG image
framesPerSecond number

Optional; How many video frames per second to be returned as PNG image...

Returns

The result of converting a video into still frames

Convert Video to WEBM format

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.

Parameters

Name Key Required Type Description
Input file to perform the operation on
inputFile file

Input file to perform the operation on.

Optional; URL of a video file being used for conversion
fileUrl string

Optional; URL of a video file being used for conversion. Use this opti...

Optional; Maximum width of the output video, up to the original video
maxWidth integer

Optional; Maximum width of the output video, up to the original video ...

Optional; Maximum height of the output video, up to the original video
maxHeight integer

Optional; Maximum height of the output video, up to the original video...

Optional; If false, the original video's aspect ratio
preserveAspectRatio boolean

Optional; If false, the original video's aspect ratio will not be pres...

Optional; Specify the frame rate of the output video
frameRate integer

Optional; Specify the frame rate of the output video. Defaults to orig...

Optional; Specify the quality of the output video
quality integer

Optional; Specify the quality of the output video, where 100 is lossle...

Returns

response
binary

Cut a Video to a Shorter Length

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.

Parameters

Name Key Required Type Description
Input file to perform the operation on
inputFile file

Input file to perform the operation on.

Optional; URL of a video file being used for conversion
fileUrl string

Optional; URL of a video file being used for conversion. Use this opti...

Optional; Specify the desired starting time of the cut video in TimeSpan format
startTime date-time

Optional; Specify the desired starting time of the cut video in TimeSpan format.

Optional; Specify the desired length of the cut video in TimeSpan form
timeSpan date-time

Optional; Specify the desired length of the cut video in TimeSpan form...

Returns

response
binary

Get detailed information about a video or audio file

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.

Parameters

Name Key Required Type Description
Input file to perform the operation on.
inputFile file

Input file to perform the operation on.

Optional; URL of a video file being used for conversion
fileUrl string

Optional; URL of a video file being used for conversion. Use this opti...

Returns

Result of retrieving information about a video or audio file

Resizes a Video Preserving the Original Aspect Ratio

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.

Parameters

Name Key Required Type Description
Input file to perform the operation on
inputFile file

Input file to perform the operation on.

Optional; URL of a video file being used for conversion
fileUrl string

Optional; URL of a video file being used for conversion. Use this opti...

Optional; Maximum width of the output video
maxWidth integer

Optional; Maximum width of the output video, up to the original video ...

Optional; Maximum height of the output video
maxHeight integer

Optional; Maximum height of the output video, up to the original video...

Optional; Specify the frame rate of the output video
frameRate integer

Optional; Specify the frame rate of the output video. Defaults to orig...

Optional; Specify the quality of the output video
quality integer

Optional; Specify the quality of the output video, where 100 is lossle...

Optional; Specify the file extension of the input video
extension string

Optional; Specify the file extension of the input video. This is recom...

Returns

response
binary

Resizes a Video without Preserving Aspect Ratio

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.

Parameters

Name Key Required Type Description
Input file to perform the operation on
inputFile file

Input file to perform the operation on.

Optional; URL of a video file being used for conversion
fileUrl string

Optional; URL of a video file being used for conversion. Use this opti...

Optional; Maximum width of the output video
maxWidth integer

Optional; Maximum width of the output video, up to the original video ...

Optional; Maximum height of the output video
maxHeight integer

Optional; Maximum height of the output video, up to the original video...

Optional; Specify the frame rate of the output video
frameRate integer

Optional; Specify the frame rate of the output video. Defaults to orig...

Optional; Specify the quality of the output video
quality integer

Optional; Specify the quality of the output video, where 100 is lossle...

Optional; Specify the file extension of the input video
extension string

Optional; Specify the file extension of the input video. This is recom...

Returns

response
binary

Scan a Video for NSFW content

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.

Parameters

Name Key Required Type Description
Input file to perform the operation on
inputFile file

Input file to perform the operation on.

Optional; URL of a video file being scanned. Use this option for files
fileUrl string

Optional; URL of a video file being scanned. Use this option for files...

Optional; How many video frames per second to be scanned
framesPerSecond number

Optional; How many video frames per second to be scanned

Returns

The result of scanning a video file for NSFW content

Body
NsfwResult

Split a Video into Two Shorter Videos

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.

Parameters

Name Key Required Type Description
Input file to perform the operation on
inputFile file

Input file to perform the operation on.

Optional; URL of a video file being used for conversion
fileUrl string

Optional; URL of a video file being used for conversion. Use this opti...

Specify the desired time at which to split the video in TimeSpan format
splitTime True date-time

Specify the desired time at which to split the video in TimeSpan format.

Optional; Specify the desired length of the second video in TimeSpan
timeSpan date-time

Optional; Specify the desired length of the second video in TimeSpan f...

Returns

The result of splitting a video

Definitions

MediaInformation

Result of retrieving information about a video or audio file

Name Path Type Description
Successful
Successful boolean

True if the operation was successful, false otherwise

FileFormat
FileFormat string

The file's short format name

FileFormatFull
FileFormatFull string

The file's full format name

ValidFileFormats
ValidFileFormats array of string

A list of the file's valid formats

Width
Width integer

The video's width, if file is a video

Height
Height integer

The video's height, if file is a video

Size
Size integer

The file's size in bytes

BitRate
BitRate integer

The file's bit rate

Duration
Duration double

The file's duration in seconds

StartTime
StartTime double

The file's media start time

SplitVideoResult

The result of splitting a video

Name Path Type Description
Successful
Successful boolean

True if the operation was successful, false otherwise

Videos
Videos array of VideoFile

Individual video files resulting from the split operation

VideoFile

A video file

Name Path Type Description
VideoNumber
VideoNumber integer

Sequence number of the video

Content
Content byte

The video file as a byte array

StillFramesResult

The result of converting a video into still frames

Name Path Type Description
Successful
Successful boolean

True if the operation was successful, false otherwise

TotalFrames
TotalFrames integer

The total number of frames converted

StillFrames
StillFrames array of StillFrame

Individual still frames from the conversion operation

StillFrame

A single still frame from a video

Name Path Type Description
FrameNumber
FrameNumber integer

The number of the current frame

TimeStamp
TimeStamp string

The playback time of the current frame

Content
Content byte

The still frame in PNG format as a byte array

NsfwResult

The result of scanning a video file for NSFW content

Name Path Type Description
Successful
Successful boolean

True if the operation was successful, false otherwise

HighestClassificationResult
HighestClassificationResult string

The highest NSFW classification of the video

HighestScore
HighestScore double

The highest NSFW score out of all frames scanned

TotalRacyFrames
TotalRacyFrames integer

The total number of potentially "racy" frames.

TotalNsfwFrames
TotalNsfwFrames integer

The total number of frames with high probability of NSFW.

TotalFrames
TotalFrames integer

The total number of frames scanned

NsfwScannedFrames
NsfwScannedFrames array of NsfwScannedFrame

The NSFW scanning results for each frame

NsfwScannedFrame

An individual frame scanned for NSFW content

Name Path Type Description
FrameNumber
FrameNumber integer

The number of the current frame

TimeStamp
TimeStamp string

The playback time of the current frame

Content
Content byte

The still frame in PNG format as a byte array

ClassificationResult
ClassificationResult string

The NSFW classification of the still frame

Score
Score double

The NSFW score of the current frame

binary

This is the basic data type 'binary'.