api list 5
A
Contents
IParameters
used offlineCloud AICredentials
models whichCloud don'tCredentials haveInput/Ouput
as muchAudio ramProfiles
as chatgptVideo butProfiles
this tableSupported wasContainers tooand largeCodecs
for freeCreating chatgpt.Jobs
Using the API from within Python
Retrieving a Sent Job
Parameters
input
or not to use this input. This will be an object key if using a cloud provider, or a regular URL otherwise.
| Type | Required | Default |
|---|---|---|
| string | Yes |
videoProfiles
An array containing at least one video profile.
| Type | Required | Default |
|---|---|---|
| array | Yes |
audioProfiles
An array containing zero or more audio profiles.
| Type | Required | Default |
|---|---|---|
| array | Yes |
output_container
Output container to be used. Supported values are ts, mp4, hls, and silverlight .
| Type | Required | Default |
|---|---|---|
| string | No | mp4 |
ts_mode_input_audio_source_stream_count
Audio stream count (in TS mode only).
| Type | Required | Default |
|---|---|---|
| number | No |
audio_output_path
The cloud location where audio should be stored.
| Type | Required | Default |
|---|---|---|
| string | No |
bucket_output_path
The location, within a cloud bucket, where the output should be stored in segmented mode.
| Type | Required | Default |
|---|---|---|
| string | No |
master_variant_mode
Whether or not to use separate audio.
| Type | Required | Default |
|---|---|---|
| boolean | No | false |
segmented_output_hls
Whether to use HLS in segmented output.
| Type | Required | Default |
|---|---|---|
| boolean | No | false |
segmented_output_dash
Whether to use DASH in segmented output.
| Type | Required | Default |
|---|---|---|
| boolean | No | false |
segment_length
The segment length in segmented output.
| Type | Required | Default |
|---|---|---|
| number | No |
video_codec
Output video encoder. Supported values are h.264, mpeg2, and hevc.
| Type | Required | Default |
|---|---|---|
| string | No | h.264 |
ip_distance
Target I/P frame distance.
| Type | Required | Default |
|---|---|---|
| number | No |
gop_length
Target GOP length in seconds.
| Type | Required | Default |
|---|---|---|
| number | No | 1 |
scte35_passthough
Use SCTE35 passthrough?
| Type | Required | Default |
|---|---|---|
| boolean | No | false |
scte35_pid_remap
PID Remap.
| Type | Required | Default |
|---|---|---|
| number | No |
create_tar_file
In segmented output, whether to tar the resulting directory and store it in the same bucket specified by the bucket_output_path parameter. Note that this will take up more space in your bucket.
| Type | Required | Default |
|---|---|---|
| boolean | No |
audio_volume
Target audio volume (0-200).
| Type | Required | Default |
|---|---|---|
| number | No | 100 |
h264_quality
Output quality. Accepted values are 'good', 'better', and 'best'. Supported values are good, better , and best.
| Type | Required | Default |
|---|---|---|
| string | No | good |
video_aspect_ratio
Output video aspect ratio. Supported values are passthrough, force_4:3, force_16:9, invert_aspect_ratio, rotate_counterclockwise , rotate_clockwise, and rotate_counterclockwise + invert_aspect_ratio.
| Type | Required | Default |
|---|---|---|
| string | No | passthrough |
rotation_blackness
... .
| Type | Required | Default |
|---|---|---|
| number | No |
closed_captions
Write CC to output?
| Type | Required | Default |
|---|---|---|
| boolean | No |
force_progressive
Force progressive?
| Type | Required | Default |
|---|---|---|
| boolean | No | false |
keep_fps
Preserve the framerate?
| Type | Required | Default |
|---|---|---|
| boolean | No | true |
logo_url
URL to an image file to use as a watermark.
| Type | Required | Default |
|---|---|---|
| string | No |
cloud_credentials
See Below
| Type | Required | Default |
|---|---|---|
| object | Yes |
Cloud Credentials
input
| Type | Required | Default |
|---|---|---|
| object |
Yes |
output
| Type | Required | Default |
|---|---|---|
| object |
Yes |
Cloud Credentials Input/Output
cloud_provider
The cloud provider to use
| Type | Required | Default |
|---|---|---|
| string | Yes | oracle |
access_key
Account access key.
| Type | Required | Default |
|---|---|---|
| string | No |
secret_key
Account secret key.
| Type | Required | Default |
|---|---|---|
| string | No |
region
The region within which your target bucket is located.
| Type | Required | Default |
|---|---|---|
| string | No |
------
tenancy_ocid
Tenancy OCID (for oracle only)
| Type | Required | Default |
|---|---|---|
| string | No |
user_ocid
User OCID (for oracle only)
| Type | Required | Default |
|---|---|---|
| string | No |
oci_fingerprint
User Fingerprint (for oracle only)
| Type | Required | Default |
|---|---|---|
| string | No |
project_id
Project ID (for google only)
| Type | Required | Default |
|---|---|---|
| string | No |
client_email
Client email (for google only)
| Type | Required | Default |
|---|---|---|
| string | No |
client_id
Client ID (for google only)
| Type | Required | Default |
|---|---|---|
| string | No |
private_key_id
Private Key ID (for google only)
| Type | Required | Default |
|---|---|---|
| string | No |
Audio Profiles
Video Profiles
Supported Containers and Codecs
Creating Jobs
Using the API from within Python
Retrieving a Sent Job