Skip to main content

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​

Body

required
    resource_id string

    Required. The uuid of the resource includes live, VOD, and AOD.

    resource_type string

    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​

A successful response.

Schema
    config object
    license_key string

    Output only. The license key of the player.

    status Output only. The Status of the resource (string)

    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
    model object

    Optional. The model of showroom preferences.

    libraries object[]

    Optional. The library assets that is used by the model.

  • Array [
    • id stringrequired

    Required. The library id of the asset.

    name string

    Output only. The library name of the asset.

    url string

    Output only. The URL of the asset.

  • ]
    • interaction object
    poll_enabled boolean

    Output only. The field indicating the poll is enabled or not.

    chatroom object

    Output only. The setting of chatroom.

    enabled boolean

    Optional. This field indicating the chatroom is enabled or not.

    theme string

    Possible values: [CHATROOM_THEME_LIGHT, CHATROOM_THEME_DARK]

    Optional. Required when enabled = true.

    event_id string

    Output only. The id which is bound to the interaction.

    cover_image object
    cover_image_url string

    Output only. The cover image url of the player.

    default_image_url string

    Output only. The default cover image url of the player, it is used to display in the unexpected case.

    player_setting object
    setting object

    Output Only. The model of player preferences.

    id string

    Output only. The resource identifier of player setting.

    name string

    Output only. The name of player setting.

    description string

    Output Only. The decription of player setting.

    libraries object[]

    Output Only. The library assets that are used in the setting.

  • Array [
    • id string

    Output Only. The library id of the asset.

    name string

    Output only. The library name of the asset.

    url string

    Output only. The URL of the asset.

  • ]
    • chapter_setting object
    enable boolean

    Output only. Enable chapter.

    chapters object[]

    Output only.

  • Array [
    • title string

    Output only. The title of chapter.

    timestamp int64

    Output only. The time of chatper.

  • ]
    • metadata object
    short_description string

    The short description of the resource.

    long_description string

    The long description of the resource.

    labels object[]

    The labels of the resource.

  • Array [
    • name The label name (string)
  • ]
    • end_screen object
    model object

    Optional. The model of end screen preferences.

    libraries object[]

    Optional. The library assets that is used by the model.

  • Array [
    • id stringrequired

    Required. The library id of the asset.

    name string

    Output only. The library name of the asset.

    url string

    Output only. The URL of the asset.

  • ]
    • vods object[]

    Optional. The vod assets that is used by the model.

  • Array [
    • id stringrequired

    Required. The VOD id.

    cover_image object

    Output only. The vod cover image.

    type stringrequired

    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.

    url string

    Output only. The URL of the cover image.

    name string

    Output only. The name of the cover image.

    size int64

    Output only. The size of the cover image.

    customize object

    Optional. Required if type is COVER_IMAGE_TYPE_CUSTOMIZE.

    library_id stringrequired

    Required. The library id of the cover image.

    url string

    Output only. The URL of the cover image.

    name string

    Output only. The name of the cover image.

    size int64

    Output only. The size of the cover image.

    updated_at date-time

    Output only. The timestamp of the cover image that was updated.

  • ]
    • auto_tagging object
    aggregated_tags object[]
  • Array [
    • name string

    The name of the tag.

    count int32

    The count of the tag.

  • ]
    • clips object[]
  • Array [
    • start_time object

    A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

    value string

    The decimal value, as a string.

    The string representation consists of an optional sign, + (U+002B) or - (U+002D), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent.

    The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand.

    The exponent consists of the character e (U+0065) or E (U+0045) followed by one or more decimal digits.

    Services should normalize decimal values before storing them by:

    • Removing an explicitly-provided + sign (+2.5 -> 2.5).
    • Replacing a zero-length integer value with 0 (.5 -> 0.5).
    • Coercing the exponent character to lower-case (2.5E8 -> 2.5e8).
    • Removing an explicitly-provided zero exponent (2.5e0 -> 2.5).

    Services may perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: 2.5e-1 <-> 0.25). Additionally, services may preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so.

    Note that only the . character is supported to divide the integer and the fraction; , should not be supported regardless of locale. Additionally, thousand separators should not be supported. If a service does support them, values must be normalized.

    The ENBF grammar is:

    DecimalString =
      [Sign] Significand [Exponent];

    Sign = '+' | '-';

    Significand =
      Digits ['.'] [Digits] | [Digits] '.' Digits;

    Exponent = ('e' | 'E') [Sign] Digits;

    Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' };

    Services should clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values.

    Services may choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and should round the value to fit the supported scale. Alternatively, the service may error with 400 Bad Request (INVALID_ARGUMENT in gRPC) if precision would be lost.

    Services should error with 400 Bad Request (INVALID_ARGUMENT in gRPC) if the service receives a value outside of the supported range.

    end_time object

    A representation of a decimal value, such as 2.5. Clients may convert values into language-native decimal formats, such as Java's BigDecimal or Python's decimal.Decimal.

    value string

    The decimal value, as a string.

    The string representation consists of an optional sign, + (U+002B) or - (U+002D), followed by a sequence of zero or more decimal digits ("the integer"), optionally followed by a fraction, optionally followed by an exponent.

    The fraction consists of a decimal point followed by zero or more decimal digits. The string must contain at least one digit in either the integer or the fraction. The number formed by the sign, the integer and the fraction is referred to as the significand.

    The exponent consists of the character e (U+0065) or E (U+0045) followed by one or more decimal digits.

    Services should normalize decimal values before storing them by:

    • Removing an explicitly-provided + sign (+2.5 -> 2.5).
    • Replacing a zero-length integer value with 0 (.5 -> 0.5).
    • Coercing the exponent character to lower-case (2.5E8 -> 2.5e8).
    • Removing an explicitly-provided zero exponent (2.5e0 -> 2.5).

    Services may perform additional normalization based on its own needs and the internal decimal implementation selected, such as shifting the decimal point and exponent value together (example: 2.5e-1 <-> 0.25). Additionally, services may preserve trailing zeroes in the fraction to indicate increased precision, but are not required to do so.

    Note that only the . character is supported to divide the integer and the fraction; , should not be supported regardless of locale. Additionally, thousand separators should not be supported. If a service does support them, values must be normalized.

    The ENBF grammar is:

    DecimalString =
      [Sign] Significand [Exponent];

    Sign = '+' | '-';

    Significand =
      Digits ['.'] [Digits] | [Digits] '.' Digits;

    Exponent = ('e' | 'E') [Sign] Digits;

    Digits = { '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9' };

    Services should clearly document the range of supported values, the maximum supported precision (total number of digits), and, if applicable, the scale (number of digits after the decimal point), as well as how it behaves when receiving out-of-bounds values.

    Services may choose to accept values passed as input even when the value has a higher precision or scale than the service supports, and should round the value to fit the supported scale. Alternatively, the service may error with 400 Bad Request (INVALID_ARGUMENT in gRPC) if precision would be lost.

    Services should error with 400 Bad Request (INVALID_ARGUMENT in gRPC) if the service receives a value outside of the supported range.

    title string

    Output only. The title of the clip.

    description string

    Output only. The description of the clip.

    tags object[]

    Output only. The tags of the clip.

  • Array [
    • name string

    The name of the tag.

  • ]
    • thumbnail_uri string

    Output only. The thumbnail uri of the clip.

  • ]
Loading...