Skip to main content

Event Resources

Synopsis

An event is a single or recurring occurrence scheduled to be streamed (i.e., live), recorded or both. As of Version 2.5, an HMP session is associated with an event. Live events can be simple single source streams or the broadcast of multiple sources simultaneously (sessions). Scheduled events can be shared with authenticated and/or non-authenticated users throughout an enterprise network. The events API is used to list, create, and edit events on the system.

Event Parameters

Property

JSON Type

Property Type

Description

id

UUID

Required

Event ID

title

String

Optional

Session title

moduleId

UUID

Ignored

Session ID

moduleStringRequired"session"

startTime

Number

Required

Timestamp in seconds when event triggers (or first occurrence if type is weekly-recurring)

duration

Number

Optional

Duration in seconds

type

String

Required

"one-time" or "weekly-recurring"

typeDataObjectRequired when type="weekly-recurring"Includes a days array for list of days of the week for the event

command

String

Required

"set-live" or "record"

parameters

Object

Required when command="set-live"

Parameters used with the command. For example, for command="set-live", a record parameter can be passed to indicate whether to record the session as well as set it live.

activeBooleanRequiredWhether the event is available.


JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.