Skip to main content

Get content metadata

GET 

/bv/playback/v1/contents

Fetches metadata associated with a specific content using the provided playback token for authorization.


  • Returns a 401/Unauthenticated if the playback token is not valid.
  • Returns a 404/NotFound if the requested content metadata is not found.

Request

Header Parameters

    authorization string

    This API should be invoked with playback token.

Responses

A successful response.

Schema
    id uuid

    Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    Output only. The unique id of resource (live/vod).

    title string

    Output only. The title of resource (live/vod).

    is_ended boolean

    Output only. The field indicating the live event is ended or not.

    player_setting object

    Output only. The settings for the player.

    template string

    Possible values: [TEMPLATE_STANDALONE, TEMPLATE_EMBEDDED]

    Output only. The template of the player.

    features object[]

    Output only. The features provided by player.

  • Array [
  • name string

    Possible values: [FEATURE_NAME_PSE, FEATURE_NAME_ULL]

  • ]
  • share object

    Output only. The share links provided by player.

    url string
    show_iframe_tag boolean
    description string

    Output only. The description that will be displayed in the player.

    color string

    Output only. The color of the player.

    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.

    watermark object

    Output only. The watermark information of the player.

    position string

    Possible values: [POSITION_BOTTOM_RIGHT, POSITION_BOTTOM_MIDDLE, POSITION_BOTTOM_LEFT, POSITION_CENTER_RIGHT, POSITION_CENTER_LEFT, POSITION_TOP_RIGHT, POSITION_TOP_MIDDLE, POSITION_TOP_LEFT, POSITION_RANDOM, POSITION_CUSTOM]

    image_url string
    text string
    size float
    offset object
    x int32required

    Required. The x-axis position of the watermark. Represented as a percentage of the image width. The range of values that can be set is from 1 to 100.

    y int32required

    Required. The y-axis position of the watermark. Represented as a percentage of the image height. The range of values that can be set is from 1 to 100.

    tenant_id string

    Output only. The unique id of tenant.

    playable boolean

    Output only. The field indicating the resource is in playable state or not.

    type string

    Possible values: [RESOURCE_TYPE_LIVE_EVENT, RESOURCE_TYPE_LIVE_EVENT_RECORDING, RESOURCE_TYPE_VOD_EVENT, RESOURCE_TYPE_AUDIO_EVENT]

    Output only. The type of resource.

    assoc_resource_id string

    Output only. The associate resource id, including vod_encoding id, it's used for later analytics.

    assoc_resource_type string

    Possible values: [RESOURCE_TYPE_VOD_ENCODING]

    Output only. The associate resource type. It is used for later analytics.

    last_watched_position int64

    Output only. The last watched position, in seconds. The API caller can use this field to resume the playback from the last watched position.

Loading...