Get configs by resource information
POST/bv/playback/v1/resources/configs:resource-info
This api is used to retrieve the configuration information for the resource.
- It'll return a
404
/NotFound
error if any requested resource is not found.
Request
- application/json
Body
required
Required. The uuid of the resource includes live, VOD, and AOD.
Possible values: [RESOURCE_TYPE_LIVE
, RESOURCE_TYPE_VOD
, RESOURCE_TYPE_LIVE_EVENT
, RESOURCE_TYPE_LIVE_EVENT_RECORDING
, RESOURCE_TYPE_VOD_EVENT
, RESOURCE_TYPE_AUDIO_EVENT
, RESOURCE_TYPE_VOD_ENCODING
]
Required. The type of the resource.
Responses
- 200
- 400
- 401
- 403
- 500
- default
A successful response.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
- Array [
- ]
config object
Output only. The license key of the player.
Possible values: [RESOURCE_STATUS_LIVE_SCHEDULED
, RESOURCE_STATUS_LIVE
, RESOURCE_STATUS_VOD_SCHEDULED
, RESOURCE_STATUS_VOD
, RESOURCE_STATUS_END
, RESOURCE_STATUS_LIVE_PREVIEW
]
showroom object
Optional. The model of showroom preferences.
libraries object[]
Optional. The library assets that is used by the model.
Required. The library id of the asset.
Output only. The library name of the asset.
Output only. The URL of the asset.
interaction object
Output only. The field indicating the poll is enabled or not.
chatroom object
Output only. The setting of chatroom.
Optional. This field indicating the chatroom is enabled or not.
Possible values: [CHATROOM_THEME_LIGHT
, CHATROOM_THEME_DARK
]
Optional. Required when enabled
= true.
Output only. The id which is bound to the interaction.
cover_image object
Output only. The cover image url of the player.
Output only. The default cover image url of the player, it is used to display in the unexpected case.
player_setting object
Output Only. The model of player preferences.
Output only. The resource identifier of player setting.
Output only. The name of player setting.
Output Only. The decription of player setting.
libraries object[]
Output Only. The library assets that are used in the setting.
Output Only. The library id of the asset.
Output only. The library name of the asset.
Output only. The URL of the asset.
chapter_setting object
Output only. Enable chapter.
chapters object[]
Output only.
Output only. The title of chapter.
Output only. The time of chatper.
metadata object
The short description of the resource.
The long description of the resource.
labels object[]
The labels of the resource.
end_screen object
Optional. The model of end screen preferences.
libraries object[]
Optional. The library assets that is used by the model.
Required. The library id of the asset.
Output only. The library name of the asset.
Output only. The URL of the asset.
vods object[]
Optional. The vod assets that is used by the model.
Required. The VOD id.
cover_image object
Output only. The vod cover image.
Possible values: [COVER_IMAGE_TYPE_AUTO
, COVER_IMAGE_TYPE_CUSTOMIZE
]
Required. Indicates the cover image type.
auto object
Output only. Indicates the cover images which are generated automatically. It will be empty which represents the black screen when the content type is live.
Output only. The URL of the cover image.
Output only. The name of the cover image.
Output only. The size of the cover image.
customize object
Optional. Required if type
is COVER_IMAGE_TYPE_CUSTOMIZE
.
Required. The library id of the cover image.
Output only. The URL of the cover image.
Output only. The name of the cover image.
Output only. The size of the cover image.
Output only. The timestamp of the cover image that was updated.
{
"config": {
"license_key": "string",
"status": "RESOURCE_STATUS_LIVE_SCHEDULED",
"showroom": {
"model": {},
"libraries": [
{
"id": "string",
"name": "string",
"url": "string"
}
]
},
"interaction": {
"poll_enabled": true,
"chatroom": {
"enabled": true,
"theme": "CHATROOM_THEME_LIGHT"
},
"event_id": "string"
},
"cover_image": {
"cover_image_url": "string",
"default_image_url": "string"
},
"player_setting": {
"setting": {},
"id": "string",
"name": "string",
"description": "string",
"libraries": [
{
"id": "string",
"name": "string",
"url": "string"
}
]
},
"chapter_setting": {
"enable": true,
"chapters": [
{
"title": "string",
"timestamp": "string"
}
]
},
"metadata": {
"short_description": "string",
"long_description": "string",
"labels": [
{
"name": "string"
}
]
},
"end_screen": {
"model": {},
"libraries": [
{
"id": "string",
"name": "string",
"url": "string"
}
],
"vods": [
{
"id": "string",
"cover_image": {
"type": "COVER_IMAGE_TYPE_AUTO",
"auto": {
"url": "string",
"name": "string",
"size": "string"
},
"customize": {
"library_id": "string",
"url": "string",
"name": "string",
"size": "string"
},
"updated_at": "2024-05-15T03:16:03.271Z"
}
}
]
}
}
}
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
- Example (from schema)
Schema
- Array [
- 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.)
- ]
details object[]
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:
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.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A unauthenticated response.
The header authorization
was missing or unidentified.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- 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.)
- ]
details object[]
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:
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.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A forbidden response.
It means that the provided authorization
did not have enough permission to access the resource or the API.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- 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.)
- ]
details object[]
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:
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.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A server error response. There are more HTTP status code mappings listed on here.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- 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.)
- ]
details object[]
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:
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.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- 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.)
- ]
details object[]
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:
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.
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}