Live Events

Live Events

The Live Events API allows you to create and manage live events.

Key Differences with this API

properties.encoding.keyFrameInterval bounds are 1-10s, not 0.5-20s. This has little impact in practice, but API calls may fail if the value is out of bounds.

get List Live Events /api/v1/projects/{project_name}/media/liveEvents get Retrieve a live event /api/v1/projects/{project_name}/media/liveEvents/{event_name} put Create a live event /api/v1/projects/{project_name}/media/liveEvents/{event_name} patch Update a Live Event /api/v1/projects/{project_name}/media/liveEvents/{event_name} del Delete a Live Event /api/v1/projects/{project_name}/media/liveEvents/{event_name} post Allocate a Live Event /api/v1/projects/{project_name}/media/liveEvents/{event_name}/allocate get Get resource state /api/v1/projects/{project_name}/media/liveEvents/{event_name}/liveOutputs/{output_name}/state post Reset a Live Event /api/v1/projects/{project_name}/media/liveEvents/{event_name}/reset post Start a Live Event /api/v1/projects/{project_name}/media/liveEvents/{event_name}/start get Get resource state /api/v1/projects/{project_name}/media/liveEvents/{event_name}/state post Stop a Live Event /api/v1/projects/{project_name}/media/liveEvents/{event_name}/stop