ILiveEventProvider

The data provider object used for replacing the list of live events.

Details

This provider is used to set/replace all the live events to a whole new set of live events. The new set of live events can be created by calling the add() function multiple times with different lists of live events, and then when the commit() function is finally called, all previous live events will be replaced with the entire set of new live events. If the provider object is destroyed before calling commit(), all changes that are queued up will be lost.

Methods

add()

add(liveEvents): Promise<IAddLiveEventFailure[]>

Add a list of live events to the commit queue.

Parameters

liveEvents

ILiveEvent[]

An array of live event instances to be inserted.

Returns

Promise<IAddLiveEventFailure[]>

A list of live events that failed to be added to the commit queue and the error causing the failure.

Details

This function can be called one or more times to add live event data. Will skip any live events that fail to be inserted and will continue to try to insert the rest of the live events provided, the list of failed live events will be returned. Inserted data will only be committed when the commit() function is called.

Throws

If this function is called after the same LiveEventProvider has already returned an error previously in one of its methods.

Throws

If this function encounters an unrecoverable error such as data store connection issues, etc. Provider should be aborted upon receiving this error.

Throws

StorageLimitError if this function encounters an error due to ingested data exceeding the storage limit. Consult with your Amazon contact if you encounter this error.

---

commit()

commit(version): Promise<void>

Deletes all current live event data and saves the pending live event data added to the commit queue.

Parameters

version

string

A string representing the version of the live events that are being committed. Please refer to the developer guide for more information on how to use this field.

Returns

Promise<void>

Details

This function should be called once after all data has been added to the commit queue using the add() function. When the provider is committed, all preexisting live events will be removed from the data store, and replaced with all of the live events added to this provider object.

Throws

If this function is called after the same LiveEventProvider has already returned an InternalError previously.

Throws

if the data cannot be committed to the LiveTV Providers data store. Provider should be aborted upon receiving this error.

---

Last updated: Sep 30, 2025