get_live_operator

Retrieve one live operator by its channel id (run-time status + controls).

get_live_operator

Retrieve one live operator by its channel id (run-time status + controls).

Retrieve a single live operator by its channel id. Use this to read run-time status before issuing operator actions (start/stop segment, broadcast).

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

📘

Confinement

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

Signatures

def get_live_operator(sdk, live_operator_id):
    """Return the live operator dict for live_operator_id (the channel id), or None."""
    return sdk.get_live_operator(live_operator_id)
export async function getLiveOperator(sdk, liveOperatorId) {
    return await sdk.getLiveOperator(liveOperatorId);
}

Parameters

Parameter (Python)Parameter (JS)TypeRequiredNotes
sdksdkNomad_SDKyesadmin-apiType client
live_operator_idliveOperatorIdstryessame id as the live channel

Returns

dict | None — operator object: channel configuration, status, metadata; 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 /admin/liveOperator/{id}; returns the channel's live status and the segment/broadcast controls.
  • live_operator_id is the live channel id (the operator is the channel's run-time facet), so reuse the id from get_live_channels.

Requires an admin session (raises InvalidAPITypeException otherwise).

Real-world usage

  • Maps to GET /admin/liveOperator/{id}; returns the channel's live status and the segment/broadcast controls.
  • liveOperatorId is the live channel id (the operator is the channel's run-time facet) — reuse the id from getLiveChannels.

Requires an admin session (raises InvalidAPITypeException otherwise).

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