EVENTS STATES¶
Event states are core to the system and each Event will often transition through multiple states, depending on functionality of the system.
PRE_LIVE = 0¶
Live Event awaiting stream content.
Returning to PRE_LIVE from an INSTANT_VOD state will remove the existing publishing point.
LIVE_UNPUBLISHED = 1¶
Live Event with stream content and an active publishing point. This state can be used to signal that the Event should only be displayed privately or internally.
LIVE_PUBLISHED = 2¶
Live Event with stream content and an active publishing point. This state can be used to signal that the Event can now be displayed publically or externally.
SUSPENDED = 3¶
Live Event which has previous stream content and an active publishing point, but is currently not streaming live. The stream can be resumed by returning to a LIVE_UNPUBLISHED or LIVE_PUBLISHED state. The resulting stream will not contain any data for the suspended period and will appear seamless to the user.
STOPPED = 4¶
An Event cannot exist in this state as it is equivalent to INSTANT_VOD in regards to stream content.
This state is used to stop a Live Event and will transition to Event to INSTANT_VOD.
INSTANT_VOD = 5¶
Live Event which has completed and is available for on-demand playback. Typically the underlying content is still in a Live format, and required conversion to a full VOD later.
INSTANT_VOD_BACKUP = 6¶
Live Event which has completed and is now backed up to longer term storage. Typically this state occurs prior to conversion to a full VOD.
Only one of INSTANT_VOD_BACKUP or INSTANT_VOD_DELETE will typically exist in a system, as the alternative to backin up the data is to delete it.
INSTANT_VOD_DELETE = 7¶
Live Event which has completed and is now deleted and no longer available.
Only one of INSTANT_VOD_BACKUP or INSTANT_VOD_DELETE will typically exist in a system, as the alternative to backin up the data is to delete it.
PRE_VOD = 8¶
VOD Event which is awaiting stream content.
VOD_INGESTING = 9¶
VOD Event which is currently ingesting stream content.
VOD_PRIVATE = 10¶
VOD Event which has stream content and is only viewable from a protected or private URL.
When transitioning to VOD_PRIVATE the CDN cache should be cleared.
VOD_PUBLIC = 11¶
VOD Event which has stream content and is available via a CDN URL for public viewing.
REMIX_GENERATING = 12¶
Remix Event which has an associated playlist and is in the process of generating.
REMIX_PRIVATE = 13¶
Remix Event where generation has completed and is available privately.
REMIX_PUBLIC = 14¶
Remix Event where generation has compelted and is available publicly.
REMIX_ERROR = 15¶
Remix Event has failed generation.
VOD_ERROR = 16¶
VOD Event has failed ingestion.
ARCHIVER_PRIVATE = 17¶
Archiver Event available privately.
ARCHIVER_PUBLIC = 18¶
Archiver Event available publicly.
COMPOSE_GENERATING = 19¶
Compose Event which has an associated playlist and is in the process of generating.
COMPOSE_PUBLIC = 20¶
Compose Event where generation has completed and is available publicly.
COMPOSE_PRIVATE = 21¶
Compose Event where generation has completed and is available privately.
COMPOSE_WAITING = 22¶
Compose Event where generation has completed but awaiting stream start.
COMPOSE_ERROR = 23¶
Compose Event where generation has failed.
LIVE_STARTING = 24¶
Live Event in the process of starting. Will automatically transition when all encoders are started.
LIVE_STOPPING = 25¶
Live Event in the process of stopping. Will automatically transition when all encoders are stopped.