Skip to main content

MP4

An input type that allows the compositor to read static MP4 files.

Mp4 files can contain video and audio tracks encoded with various codecs. This input type supports mp4 video tracks encoded with h264 and audio tracks encoded with AAC.

If the file contains multiple video or audio tracks, the first audio track and the first video track will be used and the other ones will be ignored.

Usage​

To use MP4 Input you must register it first. You can do it by sending a request like this:

Example request
POST: /api/input/:input_id/register
Content-Type: application/json
{
  "type": "mp4"
  "url": "https://url.to.file.mp4"
}

See HTTP Routes documentation to learn more about managing inputs.

Mp4Input​

type Mp4Input = {
  url?: string;
  path?: string;
  loop?: bool;
  required?: bool;
  offset_ms?: f64;
}

Input stream from MP4 file. Exactly one of url and path has to be defined.

Properties​

  • url - URL of the MP4 file.
  • path - Path to the MP4 file.
  • loop - (default=false) If input should be played in the loop. Added in v0.4.0
  • required - (default=false) If input is required and frames are not processed on time, then LiveCompositor will delay producing output frames.
  • offset_ms - Offset in milliseconds relative to the pipeline start (start request). If offset is not defined then stream is synchronized based on the first frames delivery time.