Get the setting of live pool in this org.

GET 
/bv/configuration/v1/live-pool

This API is used to get live pool setting of this org.

---

It'll return a 404/Not Found error if any requested resource is not found.

Request

Header Parameters

x-bv-org-id stringrequired

To invoke this API using api_token, you need to set the x-bv-org-id header to specify the organization for which you want to perform the action.

Responses

200

A successful response.

application/json

Schema

Schema

id string

The uuid of the organization.

live_pools object[]
The live pools.
Array [
activated_at objectrequired
time stringrequired
Required. The time of day. The format is "HH:MM:SS" like "15:04:05". The time should be in the range of "00:00:00" to "24:00:00".
deactivated_at objectrequired
time stringrequired
Required. The time of day. The format is "HH:MM:SS" like "15:04:05". The time should be in the range of "00:00:00" to "24:00:00".
min int64
Optional. The minimum number of live streams that should be available in the live pool. Default value: 0. The value should be less than or equal to max.
max int64
Optional. The maximum number of live streams that can be created in the live pool. Default value: 0. The value should be greater than or equal to min.
config objectrequired
Required. The live streams with the config will be provided by the live pool.
override object
Optional. The config of lives in the live pool will be overrided.
profiles object[]
Optional. The profiles of the lives. If not set, it will use the default profiles by resolution.
Array [
video_codec object
codec string
height int64
width int64
bitrate int64
audio_codec object
codec string
bitrate int64
]
resolution - LIVE_RESOLUTION_HD: 720p resolution (1280 * 720 pixels) - LIVE_RESOLUTION_FHD: 1080p resolution (1920 * 1080 pixels) - LIVE_RESOLUTION_4K: 4K resolution (3840 * 2160 pixels) (string)
Possible values: [LIVE_RESOLUTION_HD, LIVE_RESOLUTION_FHD, LIVE_RESOLUTION_4K]
Optional. Required if remux_only is false. The live resolution.
drm_enabled boolean
Optional. Whether the drm is enabled. Default value: false.
geo_control string[]
Optional. Restrict regions to access. If leave empty, it will allow all regions.
ull_enabled boolean
Optional. Whether the ull is enabled. Default value: false.
delivery_disabled boolean
Optional. Disable deploying CDN delivery. Default value: false.
remux_only boolean
Optional. Whether the live pool is remux only. Default value: false.
notification_config object
Optional. The notification config of the live pool.
is_enabled boolean
Optional. Whether the notification is enabled. Default value: false.
available_streams_notify_threshold int64
Optional. The threshold for triggering a notification if the count of available live streams in the pool falls below this value. Default value: 0.
notification_settings object[]
Optional. The notification setting.
Array [
id string
The id of the notification setting.
type string
Possible values: [NOTIFICATION_TYPE_EMAIL]
The type of the notification.
email_setting object
The email setting of the notification.
email_recipients string[]
Optional. The email addresses to receive alert notifications. If no recipients are specified, email will be sent to the organization owner.
]
]
state object

The live pool state.

in_use_count int64

Total number of live streams currently in use from this pool.

available_count int64

Number of live streams available in the pool for future use.

Example (from schema)

{
  "id": "string",
  "live_pools": [
    {
      "activated_at": {
        "time": "string"
      },
      "deactivated_at": {
        "time": "string"
      },
      "min": 0,
      "max": 0,
      "config": {
        "override": {
          "profiles": [
            {
              "video_codec": {
                "codec": "string",
                "height": 0,
                "width": 0,
                "bitrate": 0
              },
              "audio_codec": {
                "codec": "string",
                "bitrate": 0
              }
            }
          ]
        },
        "resolution": "LIVE_RESOLUTION_HD",
        "drm_enabled": true,
        "geo_control": [
          "string"
        ],
        "ull_enabled": true,
        "delivery_disabled": true,
        "remux_only": true
      },
      "notification_config": {
        "is_enabled": true,
        "available_streams_notify_threshold": 0,
        "notification_settings": [
          {
            "id": "string",
            "type": "NOTIFICATION_TYPE_EMAIL",
            "email_setting": {
              "email_recipients": [
                "string"
              ]
            }
          }
        ]
      }
    }
  ],
  "state": {
    "in_use_count": 0,
    "available_count": 0
  }
}

400

A bad request response. The code is 3 means got an invalid argument. There are more HTTP status code mappings listed on here and gRPC code on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

401

A unauthenticated response. The header authorization was missing or unidentified.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

403

A forbidden response. It means that the provided authorization did not have enough permission to access the resource or the API.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

500

A server error response. There are more HTTP status code mappings listed on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...