Create A Live Entity
To start live streaming, you need to create an Live Entity object. Once the request is received, Uiza will allocate resources to serve your live stream.
Last updated
To start live streaming, you need to create an Live Entity object. Once the request is received, Uiza will allocate resources to serve your live stream.
Last updated
POST
https://api.uiza.sh/v1/live_entities
Name | Type | Description |
---|---|---|
Defining your region helps Uiza allocate the resources that are closest to your streamers' locations. This will minimize the risks of network issues. While we are adding more and more regions to our network, here are the currently available regions.
in-bangalore-1
(Bangalore - India)
in-mumbai-1
(Mumbai - India)
sg-singapore-1
(Singapore - Singapore)
vn-saigon-1
(Ho Chi Minh City - Vietnam)
name
string
The live entity name with maximum 100 characters.
region
string
Select an available region in Uiza Network closest to the streamer's location
description
string
Description of the live entity. Useful for displaying to users.
dvr
boolean
Indicates whether Digital Video Recorder (DVR) is enabled for the live_entity
. Set as true
to enable and as false
to disable. The default value is false.
encode
boolean
Indicates whether encoding is enabled for the live_entity
. Set as true
to enable and as false
to disable. The default value is false
, when the encode is true
, it required a preset_id
.
preset_id
string
The identifier of the video_preset
to be applied when encoding your signal.
relay
array
A list of ingest servers to be relayed. Contains url
and key
and name
(optional) in each ingest server.