/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).

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.

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 API Auth for V2 APIs (see below), 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
}