InputStream

A component for displaying registered media inputs.

Note

To use this component, you need to first register the stream with matching input_id using register input request.

Usage

Register an input from MP4 file with an id example_input:

Register input request

POST: /api/input/example_input/register
Content-Type: application/json

{
  "type": "mp4",
  "path": "https://example.com/video.mp4"
}

Update output with a new scene that is using input example_input:

Update request

POST: /api/output/example_output/update
Content-Type: application/json

{
  "video": {
    "root": {
      "type": "rescaler",
      "child": {
        "type": "input_stream",
        "input_id": "example_input"
      }
    }
  }
}

Example output

Reference

Type definitions

type InputStream = {
  id?: string;
  input_id: string;
}

Properties

id

ID of a component.

• Type: string

---

input_id

ID of an input. It identifies a stream registered using a register input method.

• Type: string