live_entitycontains the information required for Uiza to successfully allocate resources to power the
live_entity's live broadcasting sessions. You can reuse a
live_entityand broadcast multiple live sessions sequentially.
The API allows you to create, delete, and update a
live_entity. The list of your all live entities or any individual
live_entitycan also be retrieved via Live Entity APIs.
idstringThe unique identifier for the live entity.
namestringThe name of your live entity. (limit 100 characters)
descriptionstringDescribes the content of the live entity. Often useful for displaying to viewers. You could update this accordingly to suit different sessions of a single live entity.
ingestobjectContains the information required to access to Uiza's ingest servers. Use the
urlto configure your broadcasting software.
playbackobjectContains the playback URL for different streaming protocols including HLS fMP4 (
hls) and MPEG-dash (
mpd). Use this URL to configure your player to play the live stream.
regionstringThe geographical region where your live streams are broadcasted from. In case your region is not yet supported, try the nearest available one. Here are the regions that Uiza currently supports:
vn-saigon-1Ho Chi Minh City, Vietnam
statusstringOnce the request to create a
live_entityis received, Uiza will allocate resources in the requested
region. While the process may take up to 1 minute, the
init. This will be updated to
readyonce resources are successfully allocated and to
broadcastingduring a broadcasting session.
dvrboolIndicates whether Digital Video Record (DVR) is enabled for the
live_entity. Set to
trueto enable and to
falseto disable this feature.
relayarrayA list of ingesting object contains the information required to access to 3rd ingest servers. Use the
urlto configure your broadcasting destination. Uiza will relay your signal to our server to list of ingest servers in
updated_atstringThe timestamp at which the most recent update to the
live_entityoccurred. This value follows the ISO 8601 standard.