add_live_schedule_to_event

Attach a live schedule (inputs, slate, archive folder, external outputs) to an existing event.

add_live_schedule_to_event

Attach a live schedule (inputs, slate, archive folder, external outputs) to an existing event.

Attach a live schedule to an event created with create_content + update_content. This is the
third write of an event import (run only for rows whose slate resolves on the target): it
wires the primary live input, slate video, archive folder, and external output
profiles
onto the event.

postroll_video is required - a null postroll fails with 409 PostrollVideoAssetId, so the import reuses the resolved slate as the postroll. The other reference
args (preroll/backup/secure-output) may stay null. Each reference field takes the
{id, description} shape; external_output_profiles is a list of those refs (one per
output-profile column). archive_folder is a dict, not a bare string.

The call returns None on success and failure, so never branch on its return

  • verify the write by re-reading get_live_schedule (a separate object,
    not part of get_content).

Safety class: C · API type: admin · Min version: -

📘

Confinement

Class C: configures live infrastructure on a global event (no folder anchor) - non-prod only. Removed when the event is torn down via delete_event.

Signatures

def add_live_schedule_to_event(sdk, event_id, slate_video=None, preroll_video=None,
        postroll_video=None, is_secure_output=None, archive_folder=None,
        primary_live_input=None, backup_live_input=None, primary_livestream_input_url=None,
        backup_livestream_input_url=None, external_output_profiles=None, status=None,
        status_message=None, live_channel=None, override_settings=None,
        output_profile_group=None):
    """Attach a live schedule (inputs/slate/archive/outputs) to an event; returns None."""
    return sdk.add_live_schedule_to_event(event_id, slate_video, preroll_video, postroll_video,
        is_secure_output, archive_folder, primary_live_input, backup_live_input,
        primary_livestream_input_url, backup_livestream_input_url, external_output_profiles,
        status, status_message, live_channel, override_settings, output_profile_group)
export async function addLiveScheduleToEvent(sdk, eventId, slateVideo = null,
        prerollVideo = null, postrollVideo = null, isSecureOutput = null, archiveFolder = null,
        primaryLiveInput = null, backupLiveInput = null, primaryLivestreamInputUrl = null,
        backupLivestreamInputUrl = null, externalOutputProfiles = null, status = null,
        statusMessage = null, liveChannel = null, overrideSettings = null,
        outputProfileGroup = null) {
    // Attach a live schedule (inputs/slate/archive/outputs) to an event; returns null.
    return await sdk.addLiveScheduleToEvent(eventId, slateVideo, prerollVideo, postrollVideo,
        isSecureOutput, archiveFolder, primaryLiveInput, backupLiveInput,
        primaryLivestreamInputUrl, backupLivestreamInputUrl, externalOutputProfiles, status,
        statusMessage, liveChannel, overrideSettings, outputProfileGroup);
}

Parameters

Parameter (Python)Parameter (JS)TypeRequiredNotes
sdksdkNomad_SDKyes
event_ideventIdstryesthe event contentId from create_content (the event's fields are written via update_content)
slate_videoslateVideodict | Nonenoreference shape {id, description}; resolve the slate asset by name
preroll_videoprerollVideodict | Nonenoe.g. null
postroll_videopostrollVideodict | NoneyesREQUIRED whenever a schedule is attached - a null postroll 409s; the import reuses the resolved slate
is_secure_outputisSecureOutputbool | Nonenoe.g. null
archive_folderarchiveFolderdict | Nonenoreference shape {id, description}
primary_live_inputprimaryLiveInputdict | Nonenoreference shape {id, description}; the Primary Input Channel
backup_live_inputbackupLiveInputdict | Nonenoe.g. null
primary_livestream_input_urlprimaryLivestreamInputUrldict | Nonenoe.g. null
backup_livestream_input_urlbackupLivestreamInputUrldict | Nonenoe.g. null
external_output_profilesexternalOutputProfileslist[dict] | Nonenoa LIST of {id, description} refs (one per External Output Profile column)
statusstatusdict | Nonenoe.g. null
status_messagestatusMessagestr | Nonenoe.g. null
live_channelliveChanneldict | Nonenoe.g. null
override_settingsoverrideSettingsbool | Nonenoe.g. null
output_profile_groupoutputProfileGroupdict | Nonenoe.g. null

Returns

None - returns None on success AND failure - the schedule is attached as a side effect. Re-read with get_live_schedule (a SEPARATE object, not in get_content) to verify.

Errors

  • 401 unauthenticated
  • 404 event not found
  • 409 PostrollVideoAssetId if postroll_video is null
  • 422 invalid input/profile reference

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


Did this page help you?