<?xml version="1.0"?>
<query>
<userid><<id>></userid> <!-- required-->
<userkey><<key>></userkey> <!-- required-->
<action>addMedia</action>
<source>[SourceFile]</source> <!-- required-->
<format> <!-- required -->
<output>[output]</output> <!-- required -->
<video_codec>[VideoCodec]</video_codec>
<ftyp>[mp42|3gp5]</ftyp>
<size>[WxH]</size>
<keep_aspect_ratio>[yes|no]</keep_aspect_ratio>
<set_aspect_ratio>[AspectRatio]</set_aspect_ratio>
<bitrate>[BitRate]</bitrate>
<maxrate>[MaxBitRate]</maxrate>
<minrate>[MinBitRate]</minrate>
<muxrate>[MuxRate]</muxrate>
<cbr>[yes|no]</cbr>
<framerate>[FrameRate|copy]</framerate>
<framerate_upper_threshold>[FrameRateThreshold]</framerate_upper_threshold>
<keyframe>[KeyFramePeriod]</keyframe>
<force_keyframes>[KeyFramePosition]</force_keyframes>
<video_sync>[SyncParam]</video_sync>
<remove_grain>[RemoveGrainFilter]</remove_grain>
<video_only>[yes|no]</video_only>
<dc>[DCPrecision]</dc>
<lmin>[MinLF]</lmin>
<lmax>[MaxLF]</lmax>
<rc_min_vbv_use>[MinRC]</rc_min_vbv_use>
<rc_max_vbv_use>[MaxRC]</rc_max_vbv_use>
<color_range>[ColorRange]</color_range>
<color_primaries>[ColorPrimaries]</color_primaries>
<transfer_characteristics>[TransferCharacteristics]</transfer_characteristics>
<matrix_coefficients>[MatrixCoefficients]</matrix_coefficients>
<scaler>[default|fast_bilinear|bilinear|bicubic|neighbor|area|bicublin|gauss|sinc]</scaler>
<scaler_flags>[ScalerFlags]</scaler_flags>
<video_tag>[Tag]</video_tag>
<mxf_profile>[MXFProfile]</mxf_profile>
<mxf_multiplex_type>[MXFMultiplex]</mxf_multiplex_type>
<scaler_lib>[default|zscale]</scaler_lib>
</format>
</query>
{
"query": {
"userid": "<<id>>", // required
"userkey": "<<key>>", // required
"action": "addMedia", // required
"source": "[SourceFile]", // required
"format": { // required
"output": "[output]", // required
"video_codec": "[VideoCodec]",
"ftyp": "[mp42|3gp5]",
"size": "[WxH]",
"keep_aspect_ratio": "[yes|no]",
"set_aspect_ratio": "[AspectRatio]",
"bitrate": "[BitRate]",
"maxrate": "[MaxBitRate]",
"minrate": "[MinBitRate]",
"muxrate": "[MuxRate]",
"cbr": "[yes|no]",
"framerate": "[FrameRate|copy]",
"framerate_upper_threshold": "[FrameRateThreshold]",
"keyframe": "[KeyFramePeriod]",
"force_keyframes": "[KeyFramePosition]",
"video_sync": "[SyncParam]",
"remove_grain": "[RemoveGrainFilter]",
"video_only": "[yes|no]",
"dc": "[DCPrecision]",
"lmin": "[MinLF]",
"lmax": "[MaxLF]",
"rc_min_vbv_use": "[MinRC]",
"rc_max_vbv_use": "[MaxRC]",
"color_range": "[ColorRange]",
"color_primaries": "[ColorPrimaries]",
"transfer_characteristics": "[TransferCharacteristics]",
"matrix_coefficients": "[MatrixCoefficients]",
"scaler": "[default|fast_bilinear|bilinear|bicubic|neighbor|area|bicublin|gauss|sinc]",
"scaler_flags": "[ScalerFlags]",
"video_tag": "[Tag]",
"mxf_profile": "[MXFProfile]",
"mxf_multiplex_type": "[MXFMultiplex]",
"scaler_lib": "[default|zscale]"
}
}
}
Parameter | Description | Allowed Values | Default Values |
|---|---|---|---|
video_codec | Defines the codec used for your output. | flv: flv, libx264, vp6, beamr4avc, copy | flv: flv |
ftyp | Specifies a pre-defined signature for mp4 outputs using the ftyp format. | mp42,3gp5 | none |
size | Specifies the video frame size. | All: WxH, where W and N are any even integers. | All: None (any size possible) |
keep_aspect_ratio | Specifies whether to maintain aspect ratio of source file. | yes, no | yes |
set_aspect_ratio | Specify aspect ratio (DAR). When defined, the option keep_aspect_ratio will be ignored. The option only works with the following formats: fl9, mp4, m4v, ipod, iphone, ipad, android, ogg, webm, iphone_stream, ipad_stream. | The ratio of width to height specified as:
| none |
bitrate | Specifies the video bitrate. | Nk (where N is any non-zero integer) | All: 512k |
maxrate | Specifies maximum allowed video bitrate. | N or Nk — where N is any non-zero integer | none |
minrate | Specifies minimum allowed video bitrate. | N or Nk — where N is any non-zero integer | none |
muxrate | Set a constant muxrate. | Nk (where N is any non-zero integer) | none |
cbr | Specifies whether to use CBR (Constant bitrate). | yes, no | no |
framerate | Specifies the frame rate. | Any non-zero float or N/M where N and M are non-zero integers | none |
framerate_upper_threshold | If the source frame rate lower then framerate_upper_threshold, then the source frame rate will be used. | Any non-zero float or N/M where N and M are non-zero | none |
keyframe | Defines the keyframe interval, in number of frames. | Positive integer | 300 |
force_keyframes | Specify when to capture keyframes. |
| none |
video_sync | Specify the method for video synchronization. | old — Keep old behavior (for compatibility) | none |
The removegrain filter is a spatial denoiser for progressive video. | 4 integer numbers(from 0 to 23 including) separated with colon. | none | |
video_only | Use only video streams in output | yes, no | no |
dc | Intra DC precision | Positive integer number | none |
lmin | Minimum lagrange factor (VBR) | Positive integer number | none |
lmax | Maximum lagrange factor (VBR) | Positive integer number | none |
rc_min_vbv_use | Minimum Rate Control VBV factor | Positive integer number | none |
rc_max_vbv_use | Maximum Rate Control VBV factor | Positive integer number | none |
color_range | Color range | For cablelabs_mpegts, apple_prores, mxf, and mov output formats: Other output formats: | cablelabs_mpegts, apple_prores, mxf, and mov: 0 |
color_primaries | Color Primaries | For cablelabs_mpegts, apple_prores, mxf, and mov output formats: Other output formats: | cablelabs_mpegts, apple_prores, mxf, and mov: 2 |
color_trc | Color transformation characteristics | • bt709 | none |
transfer_characteristics | Transfer Characteristics | 2 – auto | 2 |
matrix_coefficients | Matrix Coefficients | 2 – auto | 2 |
scaler | Video scaling algorithm | default, fast_bilinear, bilinear, bicubic, neighbor, area, bicublin, gauss, sinc | default |
scaler_flags | Video scaler flags | Scaling flags list. Each flag should start with + or - sign. | none |
video_tag | Video Tag | String | none |
mxf_profile | MXF profile | sony_xdcam, panasonic_p2, dci_2k, dci_4k, as11_dpp | none |
mxf_multiplex_type | MXF multiplex type | xdcam_hd, xdcam_imx, xdcam_dv, xdcam_sxs_hd, xdcam_sxs_imx, xdcam_sxs_dv, xavc_sxs, xavc_mel, p2_dvcpro, p2_avci, p2_avc_ultra | none |
scaler_lib | Scaler library | default, zscale | default |
Remux / track passthrough / copy
Using the 'copy' parameter value will retain all original source settings in the output and ignore any additional parameters. For most codecs, this will result in a remux instead of a decode/encode cycle, passing through the original video stream.
Dolby Audio compatibility
'flv' output with ‘vp6‘ video codec is incompatible with the ‘dolby_audio‘ audio codec.
For size parameter
You can specify only one dimension: either width or height. In this case, set other dimension to 0. (I.e. 640×0). The output will be set to match the same aspect as the source.
For framerate_upper_threshold parameter
If framerate_upper_threshold is specified then the framerate parameter will be ignored.
For muxrate parameter
- <muxrate /> parameter works only for mpeg-ts output format.
- It's not recommended to use along with <bitrate />, <maxrate />, <minrate />, and <bufsize /> parameters as the output may be invalid.
For video_only parameter
<video_only /> parameter works only for mp4 output.
For color_primaries, transfer_characteristics, and matrix_coefficients parameters
<color_primaries />, <transfer_characteristics />, and <matrix_coefficients /> parameters are supported only in mov, cablelabs_mpegts, mxf, and apple_prores output formats.
For video_tag parameter
<video_tag > parameter available only for mxf output format.
For mxf_profile and mxf_multiplex_type parameters
<mxf_profile > and <mxf_multiplex_type > parameters available only for mainconcept_mxf output format.