Uiza Documentation
2020-05-28
2020-05-28
  • Hola! 👋
  • Getting Started
    • Introduction
    • Authentication
    • Errors
    • Quick Starts
      • Live Streaming
      • Video Streaming
    • Pagination
    • Recommended Specifications
    • Postman Collections
    • Sample Streaming Apps
      • NodeJS Live Streaming App
      • Java Live Streaming App
      • Python Live Streaming App
      • How to integrate live streaming into an Android App using Uiza’s Live API
    • Versioning
  • API Reference
    • Live Entities
      • Create A Live Entity
      • Retrieve A Live Entity
      • Update A Live Entity
      • [Deprecated] Update A Live Entity
      • Delete A Live Entity
      • List All Live Entities
      • [Deprecated] Enable Live Entity DVR
      • [Deprecated] Disable Live Entity DVR
      • Reset Ingest Key
    • Live Sessions
      • Retrieve A Live Session
      • List All Live Sessions
    • Video Entities
      • Retrieve A Video Entity
      • Update A Video Entity
      • Publish A Video Entity
      • Delete A Video Entity
      • List All Video Entities
    • Video Presets
      • Create a Video Preset
      • Retrieve a Video Preset
      • Update a Video Preset
      • Delete a Video Preset
      • List all Video Presets
      • Add Profile(s) to Video Preset
      • Remove Profile(s) from Video Preset
    • Video Profiles
      • List All Video Profiles
    • Events
      • Retrieve An Event
      • List All Events
      • Event Types
    • Webhook Endpoints
      • Create Webhook Endpoint
      • Retrieve Webhook Endpoint
      • Update Webhook Endpoint
      • [Deprecated] Update Webhook Endpoint
      • Delete Webhook Endpoint
      • List All Webhook Endpoints
      • [Deprecated] Enable A Webhook Endpoint
      • [Deprecated] Disable A Webhook Endpoint
  • SDK REFERENCE
    • Introduction
    • Android SDK
      • Android Player SDK
      • Android Broadcast SDK
    • iOS SDK
      • iOS Player SDK
      • iOS Broadcast SDK
    • Web Player SDK
  • API UPGRADES
    • Release Notes
    • API Changelog
Powered by GitBook
On this page

Was this helpful?

  1. API Reference
  2. Live Entities

List All Live Entities

Returns a list of existing live entities in descending order by creation date (the most recently created one is on top)

/v1/live_entities

GET https://api.uiza.sh/v1/live_entities

Query Parameters

Name
Type
Description

page_size

number

The maximum number of objects to be returned, between 1 and 20.

page_token

string

The pagination cursor of the result page to be retrieved.

{
  "data": [
    {
      "id": "22013d8a-d5fa-48f0-9a63-1f471ca9e81d",
      "name": "Demo app 1",
      "description": "Demo application for documentation",
      "dvr": true,
      "encode": true,
      "ingest": {
        "url": "rtmp://f45dd07a0e-in.uizadev.io/transcode",
        "key": "live_TB62vHgxSY"
      },
      "playback": {
        "hls": "https://f45dd07a0e.uizadev.io/fmp4/22013d8a-d5fa-48f0-9a63-1f471ca9e81d/master.m3u8"
      },
      "preset": {
        "id": "3693d866-1577-48f4-a97c-6e15765ba0fe",
        "name": "Primary Preset",
        "description": "",
        "profiles": [
          {
            "id": "aaa",
            "name": "360p",
            "segment_duration": 6,
            "orientation": "portrait",
            "video_profile": {
              "video_resolution": "360",
              "video_codec": "h264",
              "video_bitrate": "1024K",
              "video_frame_rate": "30"
            },
            "audio_profile": {
              "audio_channel": "2",
              "audio_codec": "aac",
              "audio_bitrate": "96K",
              "audio_frame_rate": "12"
            }
          }
        ],
        "created_at": "2020-02-28T01:32:31Z",
        "updated_at": "2020-02-29T17:09:15Z"
      },
      "region": "in-mumbai-1",
      "relay": [
        {
          "url": "rtmp://youtu.be/live",
          "key": "Abco1"
        }
      ],
      "status": "ready",
      "created_at": "2020-03-10T03:20:37.202Z",
      "updated_at": "2020-03-10T03:20:37.202Z"
    }
  ],
  "next_page_token": "eyJjcmVhdGVkX2F0IjoxNTc2MDA4NjkxMDAwLCJpZCI6IjAwNzVmZjcyLWE0ODYtNDg0Ni05Y2NjLWY1ZWU4YTA0MmQ0NSJ9",
  "prev_page_token": null
}
{
 "message": "You are unauthorized to access the requested resource. Please verify and resubmit.",
 "error_type": "invalid_request_error"
}
{
 "message": "An unexpected error occurred on Uiza's end.",
 "error_type": "api_error"
}
Sample Request
curl -X GET https://api.uiza.sh/v1/live_entities 
    -H 'Accept: */*' 
    -H 'Authorization: uap-c1ffbff4db954ddcb050c6af0b43ba56-41193b64' 
    -H 'Cache-Control: no-cache' 
    -H 'Connection: keep-alive'
PreviousDelete A Live EntityNext[Deprecated] Enable Live Entity DVR

Last updated 5 years ago

Was this helpful?