Ingestion and Processing API | Indee YourCloud

To initiate a video watermarking using the ingestion processing workflow, a call to the processing API gateway must be made, with the following schema adhered to for the POST body.

A sample POST body that adheres to the expected schema.

    {
        "job_key": "ycj-sdvhwoeho89h3o9ebi",
        "media_source": {
            "media_files": [
                {
                    "file_url": "https://media.customerdomain.org/deep-space.mp4"
                    "tracks": [
                        {
                            "type": "video",
                            "key": "vid-8y2fohoweicu3",
                            "label": null,
                            "language": null
                        },
                        {
                            "type": "audio",
                            "key": "aud-bwic43hioe823",
                            "label": "eng",
                            "language": "English"
                        },
                        {
                            "type": "audio",
                            "key": "aud-oihf839239u39",
                            "label": "spn",
                            "language": "Spanish"
                        }
                    ]
                }
            ]
        },
        "media_destination": {
            "base_path": "deep-space/vid-8y2fohoweicu3",
            "bucket_name": "deep-space-yourcloud-streaming-regional-bucketmedia"
        },
        "status_webhook": "https://api.customerdomain.org/v1/yourcloud/status"
    }

Schema Description

Parameter	Description
job_key	Unique key to identify the processing job being submitted to YourCloud.
media_source -> media_files	Details of the video file which needs to be processed. Detailed description here.
media_destination -> bucket_name	Name of the S3 bucket to be used for the processed output.
media_destination -> base_path	Base folder path in the destination S3 bucket to be used for the processed output.
status_webhook	Callback URL to be used by YourCloud to send updates on the job status. Needs to support the HTTP POST method.

Media Files

The media files while currently setup as an array only allows for a single media file to be processed in this version. One media file is a collection of audio and video tracks. A single MP4 container can include one track of type video and any number of tracks of type audio.

The Processing Helper Lambda validates the media files before taking it further for processing. If not valid, a message will be posted on the webhook provided and the job will be terminated.

Parameter	Description
file_url	URL for the media file. Indee accepts a URL from which a file can be downloaded. This could be another S3 bucket using a presigned URL or an Aspera download URL link.
tracks	Array of all the media tracks included in the media file. Should include exactly one video track and at least one audio track. Details on individual track entry here.

Track Details

Parameter	Description
type	Type of media track. Supported values - video, audio
key	Unique key to identify the media track.
label	Label for the media track. Applicable only for audio tracks.
language	Language for the media track. Applicable only for audio tracks.