# API Documentation
## Contents
[Parameters](http://docs.streamengine.igolgi.com/books/igolgi-stream-engine/page/api-documentation#bkmrk-parameters)
[Cloud Credentials](http://docs.streamengine.igolgi.com/books/igolgi-stream-engine/page/api-documentation#bkmrk-cloud-credentials)
[Cloud Credentials Input/Output](http://docs.streamengine.igolgi.com/books/igolgi-stream-engine/page/api-documentation#bkmrk-cloud-credentials-in)
[Audio Profiles](http://docs.streamengine.igolgi.com/books/igolgi-stream-engine/page/api-documentation#bkmrk-audio-profiles)
[Video Profiles](http://docs.streamengine.igolgi.com/books/igolgi-stream-engine/page/api-documentation#bkmrk-video-profiles)
[Supported Containers and Codecs](http://docs.streamengine.igolgi.com/books/igolgi-stream-engine/page/api-documentation#bkmrk-supported-containers)
[Creating Jobs](http://docs.streamengine.igolgi.com/books/igolgi-stream-engine/page/creating-curl-jobs)
[ Using the API from within Python](http://docs.streamengine.igolgi.com/books/igolgi-stream-engine/page/code)
[Retrieving a Sent Job](http://docs.streamengine.igolgi.com/books/igolgi-stream-engine/page/creating-curl-jobs#bkmrk-retrieving-a-sent-jo)
### 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
Supported values are aws, oracle, gcloud, http, file-upload, igolgi-store .
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
#### audio\_codec
Audio codec to be used during transcode. Supported values are aac, ac3 or mp2.
Type | Required | Default |
---|
string | No | aac
|
#### audio\_channels
Number of audio channels on the output. Use 2 for stereo and 6 for 5.1. Supported values are 2 or 6.
Type | Required | Default |
---|
string | No | 2 |
#### audio\_bitrate
Output audio bitrate. Supported values are 32, 40, 64, 96, 128, 192, 256, 384, 448 or 768.
Type | Required | Default |
---|
string | No | 256
|
#### primary\_audio\_downmix\_to\_stereo
Downmix primary audio from 5.1 to stereo.
Type | Required | Default |
---|
boolean | No |
|
#### source\_stream
The index of the source stream. Supported values are 1 , 2 , 3 , 4 , 5 , 6 , 7 or 8.
Type | Required | Default |
---|
string | No |
|
#### dolby\_digital\_dialnorm
The dialnorm. Values range from 0 to 31 inclusive. Use 0 for passthrough.
Type | Required | Default |
---|
number | No |
|
###
Video Profiles
#### output
The location, including the file name, where the output is to be sent.
Type | Required | Default |
---|
string | No |
|
#### width
The output width in pixels.
Type | Required | Default |
---|
number | Yes |
|
#### height
The output height in pixels
Type | Required | Default |
---|
number | Yes |
|
#### video\_bitrate\_mode
Output video bitrate mode. Supported values are cbr or vbr.
Type | Required | Default |
---|
string | No |
|
#### video\_bitrate
The video bitrate in kbps.
Type | Required | Default |
---|
number | Yes |
|
#### video\_framerate
The video framerate. Supported values are 1x, 1/2x or 2x.
Type | Required | Default |
---|
string | No | 1x
|
#### audio\_profiles
Type | Required | Default |
---|
string | No |
|
###
Supported Containers and Codecs
- Input Containers: MXF, MPEG2-TS and MP4
- Output Containers: MPEG2-TS, MP4
- Input Codecs: MPEG2, ProRes, XDCAM, H.264, HEVC for video; AC3, MPEG2, AAC for audio
- Output Codecs: MPEG2, H.264 and HEVC for video; Passthrough, AAC-LC and AAC 5.1 for audio, AC3 stereo and 5.1 for audio
###
Creating Jobs
###
Using the API from within Python
###
Retrieving a Sent Job
Job Status: {'job\_id': '4765', 'tcode\_progress': '100', 'state': 'ready', 'tcode\_time': '57.89', 'tcode\_speed': '0.0', 'job\_completed': True, 'xfer\_speed': '337.88', 'xfer\_time': '0.67', 'xfer\_progress': '100'}
Job Config: {'input': 'https://streamengine.igolgi.com/uploads/659d9ac25dc7bf7b1a7c487a971a98e8', 'videoProfiles': \[{'output': 'oci://yzwhip2gci7s/igolgi-public/80d8cc2a\_bdab\_442b\_bc19\_21fe00267a34.mp4', 'width': 0, 'height': 0, 'video\_bitrate': 6000, 'video\_framerate': '1x'}\], 'audioProfiles': \[{'audio\_codec': 'aac', 'audio\_channels': 2, 'audio\_bitrate': 128, 'primary\_audio\_downmix\_to\_stereo': False, 'source\_stream': 1}\], 'output\_container': 'mp4', 'audio\_output\_path': 'oci://yzwhip2gci7s/igolgi-public/96dbafd7\_bf4f\_45a8\_bd06\_627a4684e45b.mp4', 'separate\_audio': True, 'segmented\_output\_hls': False, 'segmented\_output\_dash': False, 'video\_codec': 'hevc', 'ip\_distance': 3, 'gop\_length': 2, 'scte35\_passthough': False, 'scte35\_pid\_remap': -1, 'create\_tar\_file': False, 'audio\_volume': 100, 'h264\_quality': 'good', 'video\_aspect\_ratio': 'rotate\_counterclockwise + invert\_aspect\_ratio', 'rotation\_blackness': 0, 'closed\_captions': False, 'picture\_transform': 'none', 'logo\_url': None}