get_live_input

Retrieve one live input by id (status, sources, destinations).

Retrieve a single live input by id, including its current ingest status.

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

📘

Confinement

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

Signatures

def get_live_input(sdk, live_input_id):
    """Return the live input dict for live_input_id, or None if it does not resolve."""
    return sdk.get_live_input(live_input_id)

export async function getLiveInput(sdk, liveInputId) {
    return await sdk.getLiveInput(liveInputId);
}

Parameters

Returns

dict | None — live input object: id, name, type, status, statusMessage, sources, destinations; None if not found.

Errors

• 401 unauthenticated
• 404 not found -> returns None
• InvalidAPITypeException if session is not admin

Notes

Real-world usage

• Maps to GET /liveInput/{id}. Used to confirm an input is reachable/attached before a channel is started, and to surface statusMessage on failure.
• The input id comes from get_live_inputs or from a channel's associatedInputs.

Requires an admin session (raises InvalidAPITypeException otherwise).

Real-world usage

• Maps to GET /liveInput/{id}. Used to confirm an input is reachable/attached before a channel starts, and to surface statusMessage on failure.
• The liveInputId comes from getLiveInputs or a channel's associatedInputs.

Requires an admin session (raises InvalidAPITypeException otherwise).

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