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. Video Presets

Create a Video Preset

A live entity and video entity is encoded by attaching a preset. Once a preset is attached to the entity, Uiza will encode the entity according to the profiles in the preset.

/v1/video_presets

POST https://api.uiza.sh/v1/video_presets

Request Body

Name
Type
Description

name

string

The name of the video preset.

description

string

Describes the content of the video preset. Useful to describe the profiles in the preset and talk about use cases.

profile_ids

string

The identifier of the video profiles to be added to this preset. You can add multiple profile ids separated by ,

{
    "id": "2823437c-cd5f-4565-821a-93c55bea0107",
    "name": "thinhtran",
    "description": "Made by developer",
    "is_default": false,
    "profiles": [
        {
            "id": "9c1a5300-6281-11ea-883b-028fc5698662",
            "name": "720p H264 30fps High Latency Portrait",
            "segment_duration": 10,
            "orientation": "portrait",
            "video_profile": {
                "video_resolution": "720",
                "video_codec": "H264",
                "video_bitrate": "1500K",
                "video_frame_rate": "30"
            },
            "audio_profile": {
                "audio_channel": "2",
                "audio_codec": "AAC",
                "audio_bitrate": "128K",
                "audio_frame_rate": "1"
            }
        }
    ],
    "created_at": "2020-03-12T09:34:41Z",
    "updated_at": "2020-03-12T09:34:41Z"
}
{
 "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 --location --request POST 'https://api.uiza.sh/v1/video_presets' \
--header 'Authorization: uap-a1c559e57f5846d39ec50b2df062caf8-b1cef5b6' \
--data-raw '{
	"name": "Best preset for iPhone",
	"description": "Made by developer",
	"profile_ids": "abe71abb-6281-11ea-883b-028fc5698662,735299b7-5988-11ea-883b-028fc5698662"
}'
PreviousVideo PresetsNextRetrieve a Video Preset

Last updated 5 years ago

Was this helpful?