get_live_inputs

List all live inputs (sources feeding live channels).

List every live input on the deployment. A live input is the ingest source (RTMP/SRT/etc.) that a channel attaches to.

Safety class: A · API type: admin · Min version: —

📘

Confinement

Read-only; safe anywhere. Inputs are account-global, not folder-confined.

Signatures

def get_live_inputs(sdk):
    """Return the live inputs collection (or None)."""
    return sdk.get_live_inputs()

export async function getLiveInputs(sdk) {
    return await sdk.getLiveInputs();
}

Parameters

Returns

dict | None — collection of live input objects; each has id, name, type, status, sources, destinations. See return-shapes.md.

Errors

• 401 unauthenticated
• InvalidAPITypeException if session is not admin

Notes

Real-world usage

• Maps to GET /liveInput; lists the available inputs to attach to a channel (associatedInputs on the channel object references these ids).
• Each input exposes its own status (e.g. Detached, Attached) and statusMessage, separate from the channel status.

Requires an admin session (raises InvalidAPITypeException otherwise).

Real-world usage

• Maps to GET /liveInput; lists the available inputs to attach to a channel (a channel's associatedInputs references these ids).
• Each input has its own status (Detached/Attached, …) and statusMessage, separate from the channel status.

Requires an admin session (raises InvalidAPITypeException otherwise).

See also: Python ↔ JS naming map · Return shapes.