A list of bitrates to test. By default a list of bitrates between 150 kbit/s to 9000 kbit/s.
Path to a JSON-file that defines how the reference should be encoded. When using AWS, this is a MediaConvert configuration.
For local pipelines, this is key-value pairs that will be passed as command line arguments to FFmpeg.
For inline pipeline definition, this should be key-value pairs
See an example for AWS at examples/encoding-profile.json
.
The method to use when analyzing the videos. Either bruteForce
or walkTheHull
. By default bruteForce
. NOTE: walkTheHull
is not implemented at the moment.
A list of VMAF-models to use in evaluation. This can be HD, MobileHD and UHD. HD by default.
This will name the folder in which to put the files.
Path to a YAML-file that defines the pipeline, or an inline local pipeline configuration. See examples/pipeline.yml
for an example AWS-pipeline.
Values that will be substituted into the encoding options. Currently only supported for local pipeline
Path to the reference video to analyze. Normally a local path, but when using AWS, this can also be an S3-URI.
A list of resolutions to test. By default it will test all resolutions in the example ABR-ladder provided by Apple in the HLS Authoring Spec.
Skip transcode if outfile allready exists
Skip transcode and run analysis only, files are assumed to be allready present
Creates a analysis job according to a job description.
An object that describes the job to create.
Returns the VMAF-values from a JSON-file or a directory of JSON-files. Can be used on both local paths as well as S3-URIs.
The path to the file or directory. Can be a local path or a S3-URI.
A list of objects with filename and VMAF-scores.
Loads a pipeline from a YAML file and an encoding profile from a JSON file.
The local path to the pipeline YAML.
The local path to the encoding profile JSON. If left undefined, the encoding profile will be set to an empty object.
A pipeline that can be used to transcode or analyze videos with.
Loads a pipeline and an encoding profile from a JSON object.
The object containing the pipeline data.
A pipeline that can be used to transcode or analyze videos with.
Converts from a QualityAnalysisModel-enum to a readable string.
The model to convert.
A readable string of the model name.
Converts from a string to a QualityAnalysisModel-enum.
The string to convert. Can be either "HD", "PhoneHD", or "UHD".
A QualityAnalysisModel-enum depending on the input string.
Suggests an optimal ABR-ladder from a directory of VMAF-files. Only supports loading from S3 at the moment.
URI to the directory with VMAF-files.
Optional function to filter values from the analysis.
If true, return optimal resolutions for all bitrates.
Returns the optimal ladder.
Generated using TypeDoc
Describes a ABR-analysis job and can be used to create jobs using the createJob()-function.