Search
Preparing search index...
The search index is not available
Modfy.video Contributing Documentation
Options
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Menu
Globals
"features/src/compressionFeature"
CompressionFeature
Class CompressionFeature
Hierarchy
FFmpegFeature
CompressionFeature
Implements
FFmpegInterface
Index
Constructors
constructor
Properties
Component
Store
File
Store
Video
Store
configuration
display
ffmpeg
Commands
ffmpeg
Input
Command
threads
Methods
change
File
Extension
file
Input
Type
get
Current
File
image
Input
Type
parse
Configuration
runFFmpeg
setFFmpeg
Commands
setFFmpeg
Input
Command
set
File
Config
set
Progress
update
Display
update
Progress
Object literals
common
Input
Types
file
Config
input
File
output
File
progress
Bar
Constructors
constructor
new
Compression
Feature
(
configuration
:
CompressionConfig
)
:
CompressionFeature
Parameters
configuration:
CompressionConfig
Returns
CompressionFeature
Properties
Component
Store
Component
Store
:
ComponentStore
= ComponentStore
File
Store
File
Store
:
FileStore
= FileStore
Video
Store
Video
Store
:
VideoStore
= VideoStore
configuration
configuration
:
CompressionConfig
display
display
:
boolean
= false
ffmpeg
Commands
ffmpeg
Commands
:
string
ffmpeg
Input
Command
ffmpeg
Input
Command
:
string
= ""
threads
threads
:
number
Methods
change
File
Extension
change
File
Extension
(
newExtension
:
string
)
:
void
Parameters
newExtension:
string
Returns
void
file
Input
Type
file
Input
Type
(
fileName
:
string
)
:
void
Parameters
fileName:
string
Returns
void
get
Current
File
get
Current
File
(
)
:
{
name
:
string
;
type
:
FileTypes
}
Returns
{
name
:
string
;
type
:
FileTypes
}
name
:
string
type
:
FileTypes
image
Input
Type
image
Input
Type
(
frameRate
:
number
, ext
:
string
)
:
void
Parameters
frameRate:
number
ext:
string
Returns
void
parse
Configuration
parse
Configuration
(
)
:
{
compressionValue
:
number
}
Returns
{
compressionValue
:
number
}
compression
Value
:
number
runFFmpeg
runFFmpeg
(
)
:
Promise
<
CustomFileType
>
Returns
Promise
<
CustomFileType
>
setFFmpeg
Commands
setFFmpeg
Commands
(
command
:
string
)
:
void
Parameters
command:
string
Returns
void
setFFmpeg
Input
Command
setFFmpeg
Input
Command
(
)
:
void
Returns
void
set
File
Config
set
File
Config
(
)
:
void
Returns
void
set
Progress
set
Progress
(
)
:
void
Returns
void
update
Display
update
Display
(
displayType
:
boolean
, type
:
string
)
:
void
Parameters
displayType:
boolean
type:
string
Returns
void
update
Progress
update
Progress
(
)
:
void
Returns
void
Object literals
common
Input
Types
common
Input
Types
:
object
default
default
:
(Anonymous function)
= this.setFFmpegInputCommand
file
Read
file
Read
:
(Anonymous function)
= this.fileInputType
images
images
:
(Anonymous function)
= this.imageInputType
file
Config
file
Config
:
object
primary
Type
primary
Type
:
string
= "video"
types
types
:
{
name
:
string
;
number
:
object
}
[]
= [{ name: 'video', number: { min: 1, max: -1 } }]
input
File
input
File
:
object
name
name
:
string
= ""
type
type
:
"video"
= "video"
output
File
output
File
:
object
name
name
:
string
= ""
type
type
:
"video"
= "video"
progress
Bar
progress
Bar
:
object
color
color
:
string
= "#0d6efd"
name
name
:
string
= "Processing...."
Get
Started
Quick
Start
Project
Structure
Contributing
Guidelines
Contributing
Codecs
Formats
Workflows
Features
Clui UI
Components
Core
Globals
"features/src/compression
Feature"
Compression
Feature
constructor
Component
Store
File
Store
Video
Store
configuration
display
ffmpeg
Commands
ffmpeg
Input
Command
threads
change
File
Extension
file
Input
Type
get
Current
File
image
Input
Type
parse
Configuration
runFFmpeg
setFFmpeg
Commands
setFFmpeg
Input
Command
set
File
Config
set
Progress
update
Display
update
Progress
common
Input
Types
file
Config
input
File
output
File
progress
Bar
Compression
Config
Compression
Ui
Generated using
TypeDoc