Live Events API

The live event APIs can be used for basic information retrieval about upcoming live events for your account and to modify those events.

/api2/liveevents2/list

Returns a list of LiveEvent2 objects determined by the search criteria.

Request Parameter	Type	Description
limit	integer	Cap the number of items returned, maximum of 100 items.
skip	integer	Skip the first N results. The `skip` and `limit` parameters can be used together for paginated results.
start	integer	The beginning of a time range to search in UTC milliseconds since the epoch. The system will search for events that are scheduled to begin during the specified time range based on the event's expected_start field.
stop	integer	(optional*) Only valid if `start` is also included. Marks the end of a time range to search in UTC milliseconds since the epoch. If `start` is included but `stop` is omitted, it will default to start + 8 hours.
order	string	Sort the results by the given field. Supported fields include: desc, created, lastmod, expected_start, external_id, and operator. Prefix the sort field with a minus sign for descending order (e.g. order='-desc' to retrieve values in reverse alphabetical order)
fields	string	Comma-separated list of fields to return in the event object in the events array.

stop is only valid if start is also included.

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

# Find all events that are scheduled to start on 4 May 2013 ordered by their expected_start time
print(Call('/api2/liveevents2/list', start=1367625600000, stop=1367711999000, order='expected_start', fields='id,expected_start,require_drm,desc'))

{
  "events": [
    {
      "id": "0ba5fb90b3144c06be19645b9efa07eb",
      "expected_start": 1462356000000,
      "require_drm": true,
      "require_studio_drm": true,
      "desc": "Concert of the Year"
    },
    {
      "id": "e0139ec1bd11468f91f0645f07bf875a",
      "expected_start": 1462379400000,
      "require_drm": false,
      "require_studio_drm": false,
      "desc": "Concert Afterparty"
    }
  ],
  "error": 0
}

/api2/liveevents2/get

Retrieves one or more specific live event(s) from your account.

Request Parameter	Type	Description
id	string	Identifies a live event by its system-defined ID.
external_id	string	the live event's external ID
ids	list	a list of live event IDs to be returned as a list of live events
external_ids	list	a list of live event external IDs to be returned as a list of live events
fields	string	Comma-separated list of fields to return in the event object in the events array.

You must specify either id, external_id, ids, or external_ids.

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/get', external_id = 'id1234'))

{
    'events': [{
            'test_players': [{
                    'url': 'https://content.uplynk.com/player/1agvrHaL5Yw7a41fp8crte4g.html',
                    'whitelist': False,
                    'expire': None,
                    'params': '',
                    'url_html5': 'https://content.uplynk.com/player5/1agvrHaL5Yw7a41fp8crte4g.html',
                    'id': 'bg4vrHaL5Yw7aX1f38crt5',
                    'desc': 'bg4vrHaL5Yw7aX1f38crt5'
                }
            ],
            'low_latency': False,
            'pre_slate': None,
            'ad_slate': None,
            'meta': {
                'key2': 'value2',
                'key1': 'value1'
            },
            'autoexpire_hours': None,
            'vod_duration': 0,
            'meta_schema': None,
            'testing_complete': 1572283984502,
            'id': '2h6f7eb5fe4b431294se73ccc1c57e3h',
            'actual_start': 1572283984503,
            'expected_start': None,
            'log': [{
                    'username': 'joe.smith@example.com',
                    'timestamp': 1571096764240,
                    'user_id': 'abcdefghijklmnopqrstuvwxyz123456',
                    'event': 'Event Created'
                }, {
                    'username': 'joe.smith@example.com',
                    'timestamp': 1572283090070,
                    'user_id': 'abcdefghijklmnopqrstuvwxyz123456',
                    'event': 'Event Updated'
                }, {
                    'username': 'joe.smith@example.com',
                    'timestamp': 1572283166682,
                    'user_id': 'abcdefghijklmnopqrstuvwxyz123456',
                    'event': 'Added Slicer'
                }, {
                    'username': 'joe.smith@example.com',
                    'timestamp': 1572283167952,
                    'user_id': 'abcdefghijklmnopqrstuvwxyz123456',
                    'event': 'Event Updated'
                }, {
                    'username': 'joe.smith@example.com',
                    'timestamp': 1572283172537,
                    'user_id': 'abcdefghijklmnopqrstuvwxyz123456',
                    'event': 'Changed slicer to macle02'
                }, {
                    'username': 'joe.smith@example.com',
                    'timestamp': 1572283981165,
                    'user_id': 'abcdefghijklmnopqrstuvwxyz123456',
                    'event': 'Started Test'
                }, {
                    'username': 'joe.smith@example.com',
                    'timestamp': 1572283984503,
                    'user_id': 'abcdefghijklmnopqrstuvwxyz123456',
                    'event': 'Event Started'
                }, {
                    'username': 'joe.smith@example.com',
                    'timestamp': 1572283990753,
                    'user_id': 'abcdefghijklmnopqrstuvwxyz123456',
                    'event': 'Event Marker Set: segment:Random'
                }, {
                    'username': 'joe.smith@example.com',
                    'timestamp': 1572283996878,
                    'user_id': 'abcdefghijklmnopqrstuvwxyz123456',
                    'event': 'Event Marker Set: segment:Random'
                }, {
                    'username': 'joe.smith@example.com',
                    'timestamp': 1572284008236,
                    'user_id': 'abcdefghijklmnopqrstuvwxyz123456',
                    'event': 'Event Ended'
                }, {
                    'username': 'joe.smith@example.com',
                    'timestamp': 1572284089754,
                    'user_id': 'abcdefghijklmnopqrstuvwxyz123456',
                    'event': 'VOD Available'
                }, {
                    'username': 'joe.smith@example.com',
                    'timestamp': 1572284101588,
                    'user_id': 'abcdefghijklmnopqrstuvwxyz123456',
                    'event': 'VOD Available'
                }, {
                    'username': 'joe.smith@example.com',
                    'timestamp': 1572293007973,
                    'user_id': 'abcdefghijklmnopqrstuvwxyz123456',
                    'event': 'Added Metadata'
                }, {
                    'username': 'joe.smith@example.com',
                    'timestamp': 1572293009211,
                    'user_id': 'abcdefghijklmnopqrstuvwxyz123456',
                    'event': 'Event Updated'
                }, {
                    'username': 'joe.smith@example.com',
                    'timestamp': 1572293064203,
                    'user_id': 'abcdefghijklmnopqrstuvwxyz123456',
                    'event': 'Added Metadata'
                }, {
                    'username': 'joe.smith@example.com',
                    'timestamp': 1572293065429,
                    'user_id': 'abcdefghijklmnopqrstuvwxyz123456',
                    'event': 'Event Updated'
                }, {
                    'username': 'joe.smith@example.com',
                    'timestamp': 1572300868917,
                    'user_id': 'abcdefghijklmnopqrstuvwxyz123456',
                    'event': 'VOD Asset Deleted'
                }
            ],
            'markers': [{
                    'tag': 'Singer',
                    'type': 'segment',
                    'ts': 1572283990753
                }, {
                    'tag': 'Dancer',
                    'type': 'segment',
                    'ts': 1572283996878
                }
            ],
            'mid_slate_library': None,
            'state': 'complete',
            'embed_domains': '',
            'testing_start': 1572283981165,
            'vod_autoexpire_hours': None,
            'vod_replayable': False,
            'post_slate': None,
            'require_drm': True,
            'deleted': 0,
            'missing_content_slate': None,
            'operator': '',
            'test_player_url': 'https://content.uplynk.com/player5/1agvrHaL5Yw7a41fp8crte4g.html',
            'expected_stop': None,
            'ad_pods': [],
            'conflicts': [],
            'embed_player_url': 'https://content.uplynk.com/player/58aAu4blGJegRrTceH9AZ3d5.html',
            'desc': 'myliveevent',
            'expected_start_lastmod': 1571096764236,
            'auto_start_stop': False,
            'assets': ['2k9d14c65h2h478e8008a8193d6e4h35'],
            'created': 1571096764236,
            'require_studio_drm': False,
            'slicers': [{
                    'owner': 'abcdefghijklmnopqrstuvwxyz123456',
                    'id': 'slicer10'
                }
            ],
            'is_managed': False,
            'external_id': 'id1234',
            'actual_stop': 1572284008236
        }
    ],
    'error': 0
}

/api2/liveevents2/create

Creates a new live event in your account.

Request Parameter	Type	Description
auto_start_stop	bool	Specify true to allow the event to auto start/stop at the start/stop times set for the event. Default=false
autoexpire_hours	int	The 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
desc	string	A description of the live event
embed_domains	string	Comma-separated list of domain patterns used to restrict embedded players access. For example: 'example.com,*.example.org'
expected_start	int	Timestamp (number of milliseconds since midnight on January 1, 1970) of when the event is expected to start.
expected_stop	int	Timestamp (number of milliseconds since midnight on January 1, 1970) of when the event is expected to stop.
external_id	string	A 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_template	string	Identifies the marker template that will be assigned to the live event configuration by its case-sensitive name.
meta	object	The 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_library	string	ID of the library to be used for mid slate selection. Defaults to the account mid slate library when not set.
operator	string	The ID of the user who is authorized to operate live events in the dashboard on behalf of the owner account.
post_slate	string	Asset ID to loop after the event is completed.
pre_slate	string	Asset ID to loop in pre-event mode.
require_drm	bool	Specify false to disable required tokens. Default=true
require_studio_drm	bool	Specify true to require Studio DRM. Default = false
slicers	string	Set 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 } ]
state	string	The current state of the event. (pre,post,slate,slicing) Default=pre
vod_autoexpire_hours	int	The 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_replayable	bool	If true, the event be a replayable as On Demand video after the event is over. Default=false

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": "richard.roe@example.com",
			"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
}

/api2/liveevents2/update

Modifies a live event in your account.

Request Parameter	Type	Description
ad_pods	list	A list of dictionaries in JSON format. Required fields include: name (string), duration (int), and metas (dict). Example: [{ "name": "Ad Pod 1", "duration": 150, metas: { "key": "value", ... }}] Default value: []
auto_start_stop	bool	Specify true to allow the event to auto start/stop at the start/stop times set for the event. Default=false
autoexpire_hours	int	The 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
desc	string	A description of the live event
embed_domains	string	Comma-separated list of domain patterns used to restrict embedded players access. For example: 'example.com,*.example.org'
expected_start	int	Timestamp (number of milliseconds since midnight on January 1, 1970) of when the event is expected to start.
expected_stop	int	Timestamp (number of milliseconds since midnight on January 1, 1970) of when the event is expected to stop.
external_id	string	A 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.
id	string	Identifies a live event by its system-defined ID.
marker_template	string	Identifies the marker template that will be assigned to the live event configuration by its case-sensitive name.
meta	object	The 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_library	string	ID of the library to be used for mid slate selection. Defaults to the account mid slate library when not set.
operator	string	The ID of the user who is authorized to operate live events in the dashboard on behalf of the owner account.
post_slate	string	Asset ID to loop after the event is completed.
pre_slate	string	Asset ID to loop in pre-event mode.
require_drm	bool	Specify false to disable required tokens. Default=true
require_studio_drm	bool	Specify true to require Studio DRM. Default = false
slicers	string	Set the slicer IDs available for use during this event.
state	string	The current state of the event. (pre,post,slate,slicing) Default=pre
vod_autoexpire_hours	int	The 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_replayable	bool	If true, the event be a replayable as On Demand video after the event is over. Default=false

You must specify either id or external_id.

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/update', id='004870dc7e8044728dbf0ec9c97d0564', desc='New Desc'))

{
	"event": {
		"desc": "New Desc",
		"pre_slate": null,
		"ad_slate": null,
		"ad_pods": [],
		"post_slate": null,
		"meta": {},
		"log": [{
				"username": "richard.roe@example.com",
				"user_id": "060aedf2f12c4d4fba4cd573befc973a",
				"timestamp": 1463781985360,
				"event": "Event Created"
			}, {
				"timestamp": 1463782375482,
				"event": "Switched to slicer example_slicer_01"
			}
		],
		"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
}

Note that external IDs are opaque values to our system so it is up to you to use a convention that ensures uniqueness within your content library. If you assign the same external ID to multiple assets, the system will choose one arbitrarily when you try to access the asset by its external ID.

/api2/liveevents2/delete

Deletes one or more live events from your account.

Request Parameter	Type	Description
id	string	the live event's ID
external_id	string	the live event's external ID
ids	list	A list of IDs of live events to be deleted.
external_ids	list	A list of external IDs of live events to be deleted.

You must specify either id, external_id, ids, or external_ids.

Response Parameter	Type	Description
deleted	list	A list of live events that were deleted. Each item in the list contains id and external_id members.

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/delete', external_ids=['event10115', 'challenge_s01e03']))

{
    "deleted": [
        {
            "external_id": "challenge_s01e03",
            "id": "54e40044a5f84050a483a5ce91cedab1"
        },
        {
            "external_id": "event10115",
            "id": "9c4e00aab263489aa7fd275a0c5cc478"
        }
    ],
    "error": 0
}

/api2/liveevents2/operator/list

Gets the list of other accounts who are authorized to operate live events in the dashboard on behalf of this account. This list will be composed of people who've been granted the "Write" or the "Assigned" permission from within the Account Access Settings page.

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/operator/list'))

{
	"owners": [{
			"id": "f4e3035377f84a31953f475971f5544f",
			"username": "john.doe@example.com"
		}, {
			"id": "7e23d7b5d0ea461181d302396a6fd70d",
			"username": "richard.roe@example.com"
		}
	],
	"error": 0
}

/api2/liveevents2/slate/list

Gets the list of slates which have been designated as slate by putting them in a library, and specifying that library as a pre-, post-, or mid-event slate library from within the Live Event Slates tab of the Slate page.

Request Parameter	Type	Description
slate_type	string	The slate type that you are requesting (pre, mid, post, missing_content, ad).

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/slate/list'))

{
	"desc": "Pre Event Slate",
	"cms_session_fingerprint": "cd610c433836d1cdbae4d8c43bf7abcb5d37055e",
	"id": "2fe75892123a436685aa3739c19fa9d3",
	"assets": [{
			"orig_filename": null,
			"ttml_url": "",
			"lastmod": 1461011640977,
			"require_drm": 0,
			"require_studio_drm": 0,
			"created": 1458256110985,
			"mp4_url": "",
			"autoexpire": 0,
			"slices": 0,
			"job_type": "vod",
			"test_players": [{
					"url": "https://content.uplynk.com/player5/5KaAUVMlh2KnYsR3893R0Esa.html",
					"expire": null,
					"params": "",
					"id": "5KaAUVMlh2KnYsR3893R0E",
					"desc": "5KaAUVMlh2KnYsR3893R0E"
				}
			],
			"libraries": [{
					"id": "2fe75892123a436685aa3739c19fa9d3",
					"desc": "Pre Event Slate"
				}
			],
			"test_player_url": "https://content.uplynk.com/player5/5KaAUVMlh2KnYsR3893R0Esa.html",
			"state": "ready",
			"rays": 7,
			"poster_url": "https://stg-ec-ore-u.uplynk.com/slices/05d/95cf96f52a8c42dbb8601c3e6103a8e5/05d9eba80aa5419e89363250cc972bdb/00000000.jpg",
			"duration": 3.970625,
			"embed_player_url": "https://content.uplynk.com/player5/7fRj7sjUJdxjhA4ZER23mCea.html",
			"external_id": "",
			"id": "05d9eba80aa5419e89363250cc972bdb",
			"thumb_url": "https://stg-ec-ore-u.uplynk.com/slices/05d/95cf96f52a8c42dbb8601c3e6103a8e5/05d9eba80aa5419e89363250cc972bdb/00000000.jpg",
			"desc": "Pre Slate"
		}
	]
}

/api2/liveevents2/ancillary-assets

Retrieves assets associated with a live event.

Request parameters:

Request Parameter	Type	Description
id Required	string	Identifies a live event by its system-defined ID.
since	string	Recently Updated Only Identifies a point-in-time for retrieving assets. The response will only include assets that were created or updated after this point-in-time. Specify a timestamp in Unix time (milliseconds).

Request Parameter

Type

Description

Required

string

Identifies a live event by its system-defined ID.

since

string

Response

Response parameters:

Name	Data Type	Description
assets	List of dictionaries	Contains the assets associated with a live event.
error	Integer	Indicates whether an error occurred. Returns 0 for successful requests.
now	Integer	Indicates the timestamp, in Unix time (milliseconds), at which the request was processed. Use this timestamp in combination with the since request parameter to retrieve assets that have been created or updated since the last request.

Name

Data Type

Description

assets

List of dictionaries

Contains the assets associated with a live event.

error

Integer

Indicates whether an error occurred. Returns 0 for successful requests.

now

Integer

Indicates the timestamp, in Unix time (milliseconds), at which the request was processed.

Use this timestamp in combination with the since request parameter to retrieve assets that have been created or updated since the last request.

assets List

The assets list describes each asset via the following properties:

Name	Data Type	Description
audio_only	Integer	Indicates whether the asset solely consists of audio. Valid values are: 0: Audio and video 1: Audio only
autoexpire	String	Indicates when the asset will be automatically deleted.
break_offsets	List	Indicates the starting point for each ad break inserted into the asset. This starting point is relative to the start of the asset. For example, an offset of 00:10:30 indicates that the ad break will start 10 minutes and 30 seconds into the asset.
clear_dash	Boolean	Indicates whether the asset is unencrypted DASH.
cloudsliced	String	Reserved for future use.
container_type	String	Reserved for future use.
created	Integer	Indicates the timestamp, in Unix time (milliseconds), at which the asset was created.
dash_enabled	Boolean	Indicates whether DASH playback has been enabled on the asset.
dash_url	String	Indicates the asset's DASH playback URL.
default_poster_url	String	Indicates the asset's default poster URL.
deleted	Integer	Returns 1 when the asset has been deleted. Otherwise, it returns 0.
dur	Decimal	Indicates the asset's duration in seconds.
embed_domains	String	Contains the set of domains for which playback through either embed_player_url or embed_html5_player_url is allowed. Returns an empty value when those playback URLs are not restricted to a set of domains.
embed_html5_player_url	String	Indicates the asset's HTML5 playback URL.
embed_player_url	String	Indicates the asset's playback URL.
event_id	String	Indicates the system-defined ID for the live event from which this asset was generated.
event_save	String	Reserved for future use.
event_ver	Integer	Reserved for future use.
event_vod	Boolean	Indicates whether the asset allows VOD playback of a live event. This type of asset was generated upon the completion of a live event.
export_mp4_error	String	Reserved for future use.
export_mp4_job	String	Reserved for future use.
external_id	String	Indicates the asset's external ID.
fairplay_enabled	Boolean	Indicates whether Apple FairPlay Streaming DRM may be applied to the asset.
hd_exported_url	String	Indicates a URL through which you may download the asset's MP4.
hd_exported_urls	Dictionary	Indicates all of the URLs through which you may download the asset's MP4.
hls_url	String	Indicates the asset's HLS playback URL.
id	String	Identifies an asset by its system-defined ID.
is_hd	Integer	Indicates whether the asset is HD quality. Valid values are: 0: HD quality 1: Lower than HD quality
job_type	String	Indicates the source from which the asset was created.
libraries	List	Contains a list of libraries that have been associated with this asset.
meta	Dictionary	Contains the metadata key-value pairs associated with this asset.
mine	Boolean	Indicates whether the current account, as determined by the API key used to authorize this request, owns this asset.
orig_filename	String	Reserved for future use.
poster_url	String	Indicates the asset's poster URL.
read_only	Boolean	Indicates whether the asset is read-only.
require_drm	Integer	Indicates whether this asset's playback URL must be signed. Valid values are: 0: Unsigned. 1: Signed.
require_studio_drm	Integer	Indicates whether Studio DRM is enforced upon playback of this asset. Valid values are: 0: Unenforced. 1: Enforced.
slicer_id	String	Indicates the Live Slicer's ID as defined in the Live Slicer configuration file.
staticm3u8_enabled	Boolean	Reserved for future use.
status_desc	String	Indicates the asset's status.
status_refresh	Boolean	Reserved for future use.
status_state	String	Indicates the asset's state.
test_players	List of dictionaries	Contains a list of players that allow playback of your content without restrictions.
title	String	Indicates an asset's name.
widevine_enabled	Boolean	Indicates whether Google Widevine DRM may be applied to the asset.

test_players List

The test_players list describes each test player via the following properties:

Name	Data Type	Description
desc	String	Indicates the test player's name.
expire	String	Indicates the test player's expiration date in Unix time (milliseconds).
id	String	Indicates the test player's system-defined ID.
params	String	Reserved for future use.
url	String	Indicates the test player's URL.
url_html5	String	Indicates the test player's HTML5 URL.
view	String	Reserved for internal use.
whitelist	Boolean	Indicates whether the test player will be placed on an allowlist.

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/ancillary-assets', id='09bf4be7b5c64475a65bb72660035869'))

{
	'error': 0,
	'assets': [{
			'id': '114b72bc81924049a0bb9fc93199edbc',
			'title': 'Marketing Conferences',
			'mine': True,
			'is_hd': 1,
			'audio_only': 0,
			'hls_url': 'http://content.uplynk.com/114b72bc81924049a0bb9fc93199edbc.m3u8',
			'clear_dash': False,
			'staticm3u8_enabled': False,
			'dash_enabled': False,
			'dash_url': 'This asset is not DASH-enabled',
			'widevine_enabled': False,
			'fairplay_enabled': False,
			'read_only': True,
			'event_vod': False,
			'embed_player_url': 'http://content.uplynk.com/player/6k9C7yAU2pYHjLmV1fcvDkec.html',
			'embed_html5_player_url': 'http://content.uplynk.com/player5/6k9C7yAU2pYHjLmV1fcvDkec.html',
			'embed_domains': '',
			'test_players': [{
					'desc': '60viwrL0VqDSiA9T9UthbE',
					'id': '60viwrL0VqDSiA9T9UthbE',
					'expire': None,
					'params': '',
					'whitelist': False,
					'url': 'http://content.uplynk.com/player/60viwrL0VqDSiA9T9UthbEse.html',
					'url_html5': 'http://content.uplynk.com/player5/60viwrL0VqDSiA9T9UthbEse.html'
				}
			],
			'job_type': 'live',
			'external_id': '',
			'orig_filename': None,
			'created': 1631197970439,
			'require_drm': 1,
			'require_studio_drm': 0,
			'break_offsets': [],
			'libraries': [],
			'autoexpire': '',
			'deleted': 0,
			'dur': 20.224000000000004,
			'status_desc': 'Complete',
			'status_state': 'ready',
			'status_refresh': False,
			'poster_url': 'http://x-default-stgec.uplynk.com/ausw/slices/114/040aedf2f12c4d4fba4cd573befc973a/114b72bc81924049a0bb9fc93199edbc/00000008.jpg',
			'default_poster_url': 'http://x-default-stgec.uplynk.com/ausw/slices/114/040aedf2f12c4d4fba4cd573befc973a/114b72bc81924049a0bb9fc93199edbc/00000008.jpg',
			'container_type': 'event',
			'meta': {},
			'hd_exported_url': None,
			'hd_exported_urls': {},
			'export_mp4_job': None,
			'export_mp4_error': None,
			'cloudsliced': None,
			'event_ver': 2,
			'event_id': '09bf4be7b5c64475a65bb72660035869',
			'event_save': None,
			'slicer_id': 'myslicer1'
		}, {
			'id': 'c4f0ce00c9954858aa4d76b45363ae3a',
			'title': 'Marketing Conferences',
			'mine': True,
			'is_hd': 1,
			'audio_only': 0,
			'hls_url': 'http://content.uplynk.com/c4f0ce00c9954858aa4d76b45363ae3a.m3u8',
			'clear_dash': False,
			'staticm3u8_enabled': False,
			'dash_enabled': False,
			'dash_url': 'This asset is not DASH-enabled',
			'widevine_enabled': False,
			'fairplay_enabled': False,
			'read_only': True,
			'event_vod': False,
			'embed_player_url': 'http://content.uplynk.com/player/6O8slzkL8CvvJ69ju2DQglea.html',
			'embed_html5_player_url': 'http://content.uplynk.com/player5/6O8slzkL8CvvJ69ju2DQglea.html',
			'embed_domains': '',
			'test_players': [{
					'desc': '4bFbS3Q6di2EwjP12v8v5U',
					'id': '4bFbS3Q6di2EwjP12v8v5U',
					'expire': None,
					'params': '',
					'whitelist': False,
					'url': 'http://content.uplynk.com/player/4bFbS3Q6di2EwjP12v8v5Usa.html',
					'url_html5': 'http://content.uplynk.com/player5/4bFbS3Q6di2EwjP12v8v5Usa.html'
				}
			],
			'job_type': 'live',
			'external_id': '',
			'orig_filename': None,
			'created': 1631197953325,
			'require_drm': 1,
			'require_studio_drm': 0,
			'break_offsets': [],
			'libraries': [],
			'autoexpire': '',
			'deleted': 0,
			'dur': 11.52,
			'status_desc': 'Complete',
			'status_state': 'ready',
			'status_refresh': False,
			'poster_url': 'http://x-default-stgec.uplynk.com/ause/slices/c4f/040aedf2f12c4d4fba4cd573befc973a/c4f0ce00c9954858aa4d76b45363ae3a/00000004.jpg',
			'default_poster_url': 'http://x-default-stgec.uplynk.com/ause/slices/c4f/040aedf2f12c4d4fba4cd573befc973a/c4f0ce00c9954858aa4d76b45363ae3a/00000004.jpg',
			'container_type': 'event',
			'meta': {},
			'hd_exported_url': None,
			'hd_exported_urls': {},
			'export_mp4_job': None,
			'export_mp4_error': None,
			'cloudsliced': None,
			'event_ver': 2,
			'event_id': '09bf4be7b5c64475a65bb72660035869',
			'event_save': None,
			'slicer_id': 'myslicer1'
		}
	],
	'now': 1631280951017
}