API ReferenceGuides
API Reference

Update profile

put
https://api.cloud.telestream.net/flip/3.1/profiles/.json

Updates a given profile in Factory.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Profile ID

Query Params
string
required

ID of a Factory.

Body Params
string
enum

Telestream custom frame rate connversion solution.

Allowed:
string

Specifies an aspect mode for output videos. The following options
are available:

  • preserve
  • constrain
  • letterbox
  • pad
  • fill (crop)
  • stretch
  • center
    Default is "letterbox".
string

A display aspect ratio. By default it is not set.

integer

Audio bitrate (in bits/s)

integer

A number of audio channels. By default it is not set.

string
enum

A channel layout specifies the spatial disposition of the channels
in a multi-channel audio stream.

integer

A number of audio channels per track.

string

Audio codec that will be used by the profile. Available codecs are:
libmp3lame, libvorbis, libfdk_aac, dib_ac3, pcm_s16le,
mp2, ac3, eac3.

string
enum

Specifies an audio container.

Allowed:
string
string

Packet identifier used by MPEG formats.

string

Specifies an audio profile.

integer

The number of samples of audio carried per second.

integer
integer

A number of audio streams.

string
enum

A class of the AVC-Intra video coding.

Allowed:
number

Determines the size of the PulseAudio buffer. By default it is not
set.

string

todo

bumpers
array of strings
bumpers
boolean
string
string

Clip ends at a specific time (timecode).

string

A clip’s duration.

string

Clip starts at a specific offset.

string
enum

One of add (adds captions as a separate streams) or burn (burns
captions on video stream using the first subtitle file). By default
it is not set.

Allowed:
string
enum

Determines a preset that is used by encoders.

boolean
string

Distance (in pixels) from the bottom edge of the screen from which
you want your crop to be done.

string

Width of the cropped image in pixels.

string

Distance (in pixels) from the left edge of the screen from which you
want your crop to be done.

string

Distance (in pixels) from the right edge of the screen from which
you want your crop to be done.

string

Distance (in pixels) from the top edge of the screen from which you
want your crop to be done.

number

Height of the cropped image in pixels.

string
string

One of keep_fps or double_fps. By default it is not set.

string
string
enum
boolean
string

File extension.

number

Null value copy the original fps. By default it is not set.

integer

Evenly spaced number of generated screenshots. By default it is not
set.

string

Thumbnail interval (Frames or seconds).

string

Array of offsets (Frames or seconds).

string

A specified set of constraints that indicate a degree of required
decoder performance for a profile.
Available options are:

  • 1
  • 1b
  • 1.1
  • 1.2
  • 1.3
  • 2
  • 2.1
  • 2.2
  • 3
  • 3.1
  • 3.2
  • 4
  • 4.1
  • 4.2
  • 5
  • 5.1
string
enum

Profiles represent a sub-set of the encoding techniques available in
H.264.

Allowed:
string
enum

Specifies a h264 tuning option.

Allowed:
integer

Height in pixels.

string
string
string
integer

Adds a key frame every N frames. Default value of 250 adds a key frame
every 250 frames.

number
string
integer

A max bitrate tolerance (in bits/s). By default this is not set.

string
boolean

Remove audio from input video file. By default it is set to false.

string

A unique machine-readable name that will identify the profile.
Helpful for filtering encodings by profile.

string

Specify the directory where the output files should be stored. By
default it is not set. More information about this
here.

string
enum
Allowed:
string
string

A name of a preset that a profile will use.
Available options are:

  • aac
  • avc.intra
  • dash.variant
  • dash.variant.audio
  • dash.variant.webvtt
  • dash.variant.ttml
  • dash.variant.playlist
  • dash.variant.nvenc
  • dash.muxer
  • dash.muxer.audio
  • dnxhd
  • h264
  • h264.baseline
  • h264.nvenc.telestream.mov
  • h264.nvenc
  • h265
  • h265.4K
  • hls.muxer
  • hls.muxer.audio
  • hls.variant
  • hls.variant.audio
  • hls.variant.playlist
  • hls.variant.nvenc
  • hls.variant.webvtt
  • hss
  • hss.variant
  • hss.variant.audio
  • hss.variant.playlist
  • imx
  • iphone_and_ipad
  • jpeg
  • m4a
  • mp3
  • mpeg2
  • mpegps
  • mpegts.h264
  • mpegts.mpeg2
  • oga
  • ogg
  • png
  • prores422
  • quick_one_thumbnail
  • thumbnail
  • vorbis
  • webm
  • webm.vp8
  • webm.vp9
  • xdcam
string
integer

Segment duration. Minimum value is 2, maximum is 60.

string
string
string
enum
Allowed:
number

Minimum value is 0, maximum is 4.

number

Minimum value is 0, maximum is 4.

integer

Minimum value is 0, maximum is 2.

boolean
string

If set, timestamps will be added to your videos. By default this is
not set.

string

Human-readable name.

trailers
array of strings
trailers
string
string
boolean

Upscale the video resolution to match your profile. Default is
true.

boolean
string

Pattern utilised to match HLS.Variant presets by name. Default is
hls.*.

integer
string
string

Distance from the bottom of the video frame in pixels or percentage
of video frame height. Works like CSS. Default is 0.

boolean
string

Height of the watermark image in pixels or percentage of video frame
height. Default is no resizing

string

Distance from the left of the video frame in pixels or percentage of
video frame width. Works like CSS. Default is 0.

string

Distance from the right of the video frame in pixels or percentage
of video frame width. Works like CSS. Default is 0.

string

Distance from the top of the video frame in pixels or percentage of
video frame height. Works like CSS. Default is 0.

boolean
string

Url of a watermark image.

string

Width of the watermark image in pixels or percentage of video frame
width. Default is no resizing.

integer

Width in pixels.

string
string
string
boolean

Enable more sensitive pulldown removal algorithm.

boolean

If the images you are converting are composited 29.976, but the
pulldown pattern was not adhered to when performing the composite,
this setting is required to remove combing artifacts. It will also
remove combing artifacts related to very poor 3:2 cadence.

boolean
boolean

Remove chroma noise during the analysis of a video.

boolean

When pulldown is not achieved due to extremely broken cadence, or
other factors like highly mixed content or if chroma noise masks
motion, the pulldown engine may fall back to de-interlacing rather
than removing telecine. If that's a case, a more sensitive pulldown
pattern can be used. This algorithm favors inverse telecine and with
lower thresholds for triggering pulldown identification, will
maximize the number of progressive frames created from the video.

boolean
boolean

Allows 2:2 (PSF) Insertion. Creates a new series of frames which are
based on duplicating the field an interlacing it into top/bottom
field. Maintains a film-look.

boolean

Allows 4:4 Insertion. Repeats each progressive frame twice on output
(motion rate is halved). This setting is used when you want to
convert to high progressive frame rates (i.e. 50p/59.94p/60p) but
want to preserve film qualities (low motion rate, such as 24p).

boolean

2:3 Insertion. inserts a standard 2:3 telecine pattern to 23.976p
video stream to achieve a 29.97i frame rate

boolean

Allows Euro Insertion. For field based interpolation rather than
pixel-based. This is designed for interlaced or progressive integer
frame rate conversions that are being converted to interlaced
outputs. This method is valid for 24p to 50i conversions only.

boolean

Allows Adaptive Insertion. For field-based interpolation rather than
using pixel-based interpolation. This algorithm is designed for both
integer and non-integer frame rate conversion targets - as long as
one of them is a non-integer rate (23.976, 29.97, 59.94, etc). This
creates NTSC-PAL conversions clean of motion artifacts at the
expense of potential slight stutter. Stutter is most noticeable with
material that has smooth and uniform motion.

string
enum

This setting determines how much Tachyon will trust motion vectors
in the creation of new images

Allowed:
string
enum

This option specifies the transition region size between fallback
areas and motion compensated areas. A larger fallback size allows
more blending (feathering) to occur between the regions.

Allowed:
string
enum

This option specifies the size of a motion block.

Allowed:
number
boolean

Enables the trusted metadata framework.

string
enum

Selects the type of audio service. **For 1/0 Voiceover will be used
when Voiceover/Karaoke is selected. For 2/0 and above Karaoke will
be used.

boolean

Applies a 90-degree phase shift to the surround channels; necessary
if the output file is being decoded by a Dolby Surround Pro Logic or
Pro Logic II decoder.

boolean

Attenuates the surround channels by 3 dB before encoding.

boolean

Applies a 120 Hz eighth order lowpass filter to the LFE input prior
to encoding.

string
enum

Allows audio that has passed through an A/D conversion stage to be
marked as such.

Allowed:
string
enum
Allowed:
string
enum

Indicates the level shift applied to the center channel when adding
to the left and right outputs during a downmix to a Lt/Rt output.

string
enum

Indicates the level shift applied to the surround channel when
adding to the left and right outputs during a downmix to a Lt/Rt
output.

Allowed:
string
enum

Indicates the level shift applied to the center channel when adding
to the left and right outputs during a downmix to a Lo/Ro output.

string
enum

Indicates the level shift applied to the surround channel when
adding to the left and right outputs during a downmix to a Lo/Ro
output.

Allowed:
string
enum

Indicates whether the audio stream was encoded using Dolby EX.

Allowed:
string
enum

Dynamic Range Control for Line Mode.

Allowed:
string
enum

Dynamic Range Control for RF Mode.

Allowed:
integer

Represents the volume level of dialog in the audio stream which can
be used by a Dolby Digital decoder. This aids the decoder in
matching volume between program sources. Minimum value is 1, maximum
is 31.

string
enum
Allowed:
integer

Minimum value is 80, maximum is 111.

boolean

Indicates whether the encoded bitstream is copyright protected.

boolean

Indicates whether the encoded bitstream is the master version, or a
copy.

Responses

Updated almost 6 years ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated almost 6 years ago