Create Live Event

/api2/liveevents2/create

Creates a new live event in your account.

Request ParameterTypeDescription
auto_start_stopboolSpecify true to allow the event to auto start/stop at the start/stop times set for the event. Default=false
autoexpire_hoursintThe number of hours after an event's final vod asset is ready that the event's other assets will be deleted. A zero indicates the assets will remain indefinitely. When null, the account's settings are used. Default=null
descstringA description of the live event
embed_domainsstringComma-separated list of domain patterns used to restrict embedded players access. For example: example.com,\*.example.org
expected_startintTimestamp (number of milliseconds since midnight on January 1, 1970) of when the event is expected to start.
expected_stopintTimestamp (number of milliseconds since midnight on January 1, 1970) of when the event is expected to stop.
external_idstringA new external_id for the asset. If you retrieved the asset by external ID, you cannot also update the external ID at the same time.
marker_templatestringIdentifies the marker template that will be assigned to the live event configuration by its case-sensitive name.
metaobjectThe metadata to set on the event. This must be a dictionary in JSON format. If the event has existing meta, any new meta will be merged. To clear all metadata, set to {}.
mid_slate_librarystringID of the library to be used for mid slate selection. Defaults to the account mid slate library when not set.
operatorstringThe ID of the user who is authorized to operate live events in the dashboard on behalf of the owner account.
post_slatestringAsset ID to loop after the event is completed.
pre_slatestringAsset ID to loop in pre-event mode.
require_drmboolSpecify false to disable required tokens. Default=true
require_studio_drmboolSpecify true to require Studio DRM. Default = false
slicersstringSet the slicer IDs available for use during this event. The list should be in the format: [{ "id": Live Slicer ID, "owner": User ID }, { "id": Live Slicer ID, "owner": User ID } ]
statestringThe current state of the event. (pre,post,slate,slicing) Default=pre
vod_autoexpire_hoursintThe number of hours after an event's final vod asset is ready that the final vod asset will be deleted. A zero indicates the asset will remain indefinitely. When null, the account's settings are used. Default=null
vod_replayableboolIf true, the event be a replayable as On Demand video after the event is over. Default=false
ad_break_warningintEnables a dashboard warning when the event has been in ad break for the specified amount of time (in minutes). Specify null or 0 to disable. Default=0

Response: Same as for liveevents2/get

Sample request/response:

The Call() function, which is imported from uplynk_api2_auth module, prepares the message body and digital signature.

from uplynk_api2_auth import Call

print(Call('/api2/liveevents2/create', desc='Really Awesome Live Event'))

{
	"event": {
		"desc": "Really Awesome Live Event",
		"pre_slate": null,
		"ad_slate": null,
		"ad_pods": [],
		"post_slate": null,
		"meta": {},
		"log": [
			"username": "[email protected]",
			"user_id": "060aedf2f12c4d4fba4cd573befc973a",
			"timestamp": 1463781985360,
			"event": "Event Created"
		]
		"operator": "7e23d7b5d0ea461181d302396a6fd70d",
		"id": "004870dc7e8044728dbf0ec9c97d0564",
		"expected_start_lastmod": null,
		"testing_complete": null,
		"deleted": 0,
		"vod_duration": 0,
		"mid_slate_library": null,
		"state": "pre",
		"embed_domains": null,
		"embed_id": "2au2v3okikxpav6cb89pfV",
		"testing_start": null,
		"vod_replayable": false,
		"require_drm": true,
		"require_studio_drm": true,
		"external_id": "id1234",
		"actual_start": null,
		"actual_stop": null,
		"expected_start": null,
		"expected_stop": null,
		"conflicts": [{
				"owner": "f4e3035377f84a31953f475971f5544f",
				"id": "3824837c5ccc4827a890c74aa86372a6"
			}, {
				"owner": "040aedf2f12c4d4fba4cd573befc973a",
				"id": "566f73c8fd9a4528b4864413c512ccc8"
			}
		],
		"auto_start_stop": false,
		"slicers": [{
				"id": "example_slicer_01",
				"owner": "f4e3035377f84a31953f475971f5544f"
			}, {
				"id": "example_slicer_02",
				"owner": "7e23d7b5d0ea461181d302396a6fd70d"
			},
		],
		"autoexpire_hours": null,
		"vod_autoexpire_hours": null
	},
	"error": 0
}