跳到主要内容

List AODs

GET 

/bv/cms/v1/aods

Lists AOD resources.

Request

Query Parameters

    current_page int32

    Input only. Indicates the current page to show. Default: 1

    items_per_page int32

    Input only. Indicates the number of items to show per page. Default: 10.

    filter.name string

    Filter by the name of AOD

    filter.status string

    Possible values: [AOD_STATUS_CREATED, AOD_STATUS_INGESTED, AOD_STATUS_QUEUED, AOD_STATUS_ENCODED, AOD_STATUS_DEPLOYED, AOD_STATUS_SUCCEEDED, AOD_STATUS_FAILED, AOD_STATUS_CANCELLED, AOD_STATUS_DELETED]

    Filter by the status of AOD

    • AOD_STATUS_CREATED: AOD_STATUS_CREATED Indicates AOD job accepted.
    • AOD_STATUS_INGESTED: AOD_STATUS_INGESTED Indicates source file has been ingested to BlendVision One Service.
    • AOD_STATUS_QUEUED: AOD_STATUS_QUEUED Indicates AOD job is currently being encoded.
    • AOD_STATUS_ENCODED: AOD_STATUS_ENCODED Indicates AOD job is encoded.
    • AOD_STATUS_DEPLOYED: AOD_STATUS_DEPLOYED Indicates the streaming resource of AOD job has been public.
    • AOD_STATUS_SUCCEEDED: AOD_STATUS_SUCCEEDED Indicates AOD job is finished.
    • AOD_STATUS_FAILED: AOD_STATUS_FAILED Indicates AOD job is failed.
    • AOD_STATUS_CANCELLED: AOD_STATUS_CANCELLED Indicates AOD job is cancelled.
    • AOD_STATUS_DELETED: AOD_STATUS_DELETED Indicates AOD job is deleted.
    filter.subtitle_formats string[]

    Possible values: [SUBTITLE_FORMAT_SRT, SUBTITLE_FORMAT_VTT]

    Filter by the subtitle type of AOD

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

A successful response.

Schema
    aods object[]
  • Array [
  • id string

    Output only. The unique id of AOD resource.

    name string

    Output only. The name of AOD resource.

    source object

    Output only. Indicate the source file that you want to encode.

    type string

    Possible values: [SOURCE_TYPE_LIBRARY, SOURCE_TYPE_CLOUD_STORAGE]

    Indicates the Source type, should match the following library or cloud_storage setting.

    library object

    Indicates the source file is from BlendVision One library.

    video object

    Indicates the video source file.

    id string

    The unique id of the library video file.

    subtitles object[]

    Indicates the subtitle source files.

  • Array [
  • id string

    The unique id of the library subtitle file.

    name string

    The name of the subtitle file.

    code string

    The language code of the subtitle. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

    display string

    The display name of the subtitle file.

  • ]
  • stt_subtitles object[]

    Indicates auto-gen subtitles.

  • Array [
  • track_no string

    The number of audio track.

    lang_code string

    The language code of the subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

    display string

    The display name of the subtitle file.

  • ]
  • cloud_storage object

    Indicates the source file is from the customer's own configured cloud storage, it's not supported for AOD.

    id Indicates the unique id of cloud storage (string)
    file_path string

    Indicates the relative path of the video source file.

    subtitles object[]

    Indicates the subtitle source files.

  • Array [
  • id string

    The unique id of the library subtitle file.

    name string

    The name of the subtitle file.

    code string

    The language code of the subtitle. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

    display string

    The display name of the subtitle file.

  • ]
  • stt_subtitles object[]

    Indicates auto-gen subtitles.

  • Array [
  • track_no string

    The number of audio track.

    lang_code string

    The language code of the subtitle file. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

    display string

    The display name of the subtitle file.

  • ]
  • profile_set object

    Output only. Indicate the profile set that defines the encoding settings.

    id string
    name string
    protocols - PROTOCOL_HLS: HTTP Live Streaming - PROTOCOL_DASH: Dynamic Adaptive Streaming over HTTP - PROTOCOL_WHEP: WebRTC-HTTP Egress Protocol - PROTOCOL_PROGRESSIVE: Progressive download (string)[]

    Possible values: [PROTOCOL_HLS, PROTOCOL_DASH, PROTOCOL_WHEP, PROTOCOL_PROGRESSIVE]

    smart_abr boolean
    profiles object[]
  • Array [
  • id string
    name string
    bitrate int64
    codec - AUDIO_CODEC_AAC: AUDIO_CODEC_AAC Indicates audio codec aac - AUDIO_CODEC_AC3: AUDIO_CODEC_AC3 Indicates audio codec ac3 - AUDIO_CODEC_MP3: AUDIO_CODEC_MP3 Indicates audio codec mp3 (string)

    Possible values: [AUDIO_CODEC_AAC, AUDIO_CODEC_AC3, AUDIO_CODEC_MP3]

  • ]
  • codec - AUDIO_CODEC_AAC: AUDIO_CODEC_AAC Indicates audio codec aac - AUDIO_CODEC_AC3: AUDIO_CODEC_AC3 Indicates audio codec ac3 - AUDIO_CODEC_MP3: AUDIO_CODEC_MP3 Indicates audio codec mp3 (string)

    Possible values: [AUDIO_CODEC_AAC, AUDIO_CODEC_AC3, AUDIO_CODEC_MP3]

    stream object[]

    Output Only. Indicate the streaming resource of the AOD.

  • Array [
  • manifests object[]

    Indicates the manifest resources.

  • Array [
  • protocol - PROTOCOL_HLS: HTTP Live Streaming - PROTOCOL_DASH: Dynamic Adaptive Streaming over HTTP - PROTOCOL_WHEP: WebRTC-HTTP Egress Protocol - PROTOCOL_PROGRESSIVE: Progressive download (string)

    Possible values: [PROTOCOL_HLS, PROTOCOL_DASH, PROTOCOL_WHEP, PROTOCOL_PROGRESSIVE]

    Indicates the streaming protocol of manifest.

    uris object[]

    Indicates the uri array of manifest.

  • Array [
  • resolutions object[]

    The resolution of the manifest.

  • Array [
  • height int64

    The video resolution height.

    width int64

    The video resolution width.

  • ]
  • uri string

    The streaming uri of the manifest.

  • ]
  • ]
  • thumbnail object

    Indicates the thumbnail resource.

    uri string

    Thumbnail seeking uri.

  • ]
  • status string

    Possible values: [AOD_STATUS_CREATED, AOD_STATUS_INGESTED, AOD_STATUS_QUEUED, AOD_STATUS_ENCODED, AOD_STATUS_DEPLOYED, AOD_STATUS_SUCCEEDED, AOD_STATUS_FAILED, AOD_STATUS_CANCELLED, AOD_STATUS_DELETED]

    Output Only. Indicate the current status of the AOD.

    previous_status string

    Possible values: [AOD_STATUS_CREATED, AOD_STATUS_INGESTED, AOD_STATUS_QUEUED, AOD_STATUS_ENCODED, AOD_STATUS_DEPLOYED, AOD_STATUS_SUCCEEDED, AOD_STATUS_FAILED, AOD_STATUS_CANCELLED, AOD_STATUS_DELETED]

    Output only. Indicate the previous status of the AOD.

    source_file_info object

    Output only. Indicate the source file information of the AOD.

    file_name string

    The file name of source file.

    size int64

    The size of source file.

    bitrate int64

    The bitrate of source file.

    duration float

    The duration of source file.

    video object

    The video information of source file.

    codec Video codec (string)

    Possible values: [VIDEO_CODEC_H264, VIDEO_CODEC_H265]

    height int32

    The display height of video.

    width int32

    The display width of video.

    bitrate int64

    The bitrate of video.

    frame_rate string

    The frame rate of video.

    interlace boolean

    The interlace of video.

    aspect_ratio - DISPLAY_ASPECT_RATIO_SOURCE: DISPLAY_ASPECT_RATIO_SOURCE Indicates follow source file. - DISPLAY_ASPECT_RATIO_1_1: DISPLAY_ASPECT_RATIO_1_1 Indicates 1:1 - DISPLAY_ASPECT_RATIO_3_2: DISPLAY_ASPECT_RATIO_3_2 Indicates 3:2 - DISPLAY_ASPECT_RATIO_4_3: DISPLAY_ASPECT_RATIO_4_3 Indicates 4:3 - DISPLAY_ASPECT_RATIO_5_4: DISPLAY_ASPECT_RATIO_5_4 Indicates 5:4 - DISPLAY_ASPECT_RATIO_16_9: DISPLAY_ASPECT_RATIO_16_9 Indicates 16:9 - DISPLAY_ASPECT_RATIO_16_10: DISPLAY_ASPECT_RATIO_16_10 Indicates 16:10 - DISPLAY_ASPECT_RATIO_17_9: DISPLAY_ASPECT_RATIO_17_9 Indicates 17:9 - DISPLAY_ASPECT_RATIO_21_9: DISPLAY_ASPECT_RATIO_21_9 Indicates 21:9 - DISPLAY_ASPECT_RATIO_32_9: DISPLAY_ASPECT_RATIO_32_9 Indicates 32:9 (string)

    Possible values: [DISPLAY_ASPECT_RATIO_SOURCE, DISPLAY_ASPECT_RATIO_1_1, DISPLAY_ASPECT_RATIO_3_2, DISPLAY_ASPECT_RATIO_4_3, DISPLAY_ASPECT_RATIO_5_4, DISPLAY_ASPECT_RATIO_16_9, DISPLAY_ASPECT_RATIO_16_10, DISPLAY_ASPECT_RATIO_17_9, DISPLAY_ASPECT_RATIO_21_9, DISPLAY_ASPECT_RATIO_32_9]

    The display aspect ratio of video.

    audios object[]

    The audio information of source file.

  • Array [
  • codec - AUDIO_CODEC_AAC: AUDIO_CODEC_AAC Indicates audio codec aac - AUDIO_CODEC_AC3: AUDIO_CODEC_AC3 Indicates audio codec ac3 - AUDIO_CODEC_MP3: AUDIO_CODEC_MP3 Indicates audio codec mp3 (string)

    Possible values: [AUDIO_CODEC_AAC, AUDIO_CODEC_AC3, AUDIO_CODEC_MP3]

    lang string
    bitrate int64
    sample_rate int64
  • ]
  • security object

    Output Only. Indicate the security setting of the AOD.

    privacy objectrequired

    Required. Specify the content visibility.

    type stringrequired

    Possible values: [SECURITY_PRIVACY_TYPE_PUBLIC, SECURITY_PRIVACY_TYPE_TOKEN]

    • SECURITY_PRIVACY_TYPE_PUBLIC: The viewers can access the content without any restriction.
    • SECURITY_PRIVACY_TYPE_TOKEN: The viewers can access the content with tokens or redeem codes.
    token object

    Optional. Required if type is SECURITY_PRIVACY_TYPE_TOKEN.

    device_limit int32

    Optional. The limit of the concurrent devices for a token or a redeem code. Default: 0 (Unlimited). Maximum: 1000.

    watermark object

    Optional. Add watermarks to the player when playing the content, it's not supported for AOD.

    enabled booleanrequired

    Required. Enable watermark.

    type stringrequired

    Possible values: [WATERMARK_TYPE_IMAGE, WATERMARK_TYPE_USER_ID]

    Required. Indicates the type of watermark.

    position stringrequired

    Possible values: [WATERMARK_POSITION_BOTTOM_RIGHT, WATERMARK_POSITION_BOTTOM_MIDDLE, WATERMARK_POSITION_BOTTOM_LEFT, WATERMARK_POSITION_CENTER_RIGHT, WATERMARK_POSITION_CENTER_LEFT, WATERMARK_POSITION_TOP_RIGHT, WATERMARK_POSITION_TOP_MIDDLE, WATERMARK_POSITION_TOP_LEFT, WATERMARK_POSITION_RANDOM, WATERMARK_POSITION_CUSTOM]

    Required. The position of the watermark.

    image object

    Optional. Required if type is WATERMARK_TYPE_IMAGE.

    library_id stringrequired

    Required. The library id of the image.

    url string

    Output only. The URL of the image.

    name string

    Output only. The Name of the image.

    size floatrequired

    Required. The size of the watermark. The range of values that can be set is from 1 to 50.

    offset object

    Optional. Required if type is WATERMARK_POSITION_CUSTOM.

    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.

    domain_control object

    Optional. Specify the domains that will be allowed to embed the iframe.

    enabled boolean

    Optional. Enable domain control.

    domains string[]

    Optional. The list of domains that will be allowed to embed the iframe.

    protection object

    Optional. Immutable. The content encryption.

    type Optional. Indicates the type of protection (string)

    Possible values: [PROTECTION_TYPE_DRM]

    • PROTECTION_TYPE_DRM: The content will protected by DRM.
    geo_control string[]

    Immutable. Specify the alpha-2 codes (See: https://www.iban.com/country-codes) to restrict access to the content by geo locations. Allow all regions when empty.

    subtitles object[]

    Output Only. The AOD subtitles.

  • Array [
  • id string

    The unique id of subtitle.

    track_no string

    The number of audio track.

    lang_code string

    The language code of the subtitle. The format is ISO639-1+ISO-3166-1 (e.g., en-US).

    display string

    The display name of the subtitle.

    status string

    Possible values: [SUBTITLE_STATUS_GENERATING, SUBTITLE_STATUS_SUCCEED, SUBTITLE_STATUS_FAILED, SUBTITLE_STATUS_NOT_FOUND]

    The status of subtitle.

    subtitle_file_info object

    The information of subtitle.

    file object
    id string

    Output only. The unique id of the file.

    type string

    Possible values: [FILE_TYPE_VIDEO, FILE_TYPE_IMAGE, FILE_TYPE_SUBTITLE, FILE_TYPE_DOCUMENT, FILE_TYPE_WEB_LINK, FILE_TYPE_AUDIO]

    Input only. The type of the file.

    name string

    Input only. The name of the file.

    size int64

    Input only. The size of the file in bytes.

    uri string

    Output only. The uri of the file.

    source stringrequired

    Possible values: [FILE_SOURCE_LIVE_EVENT, FILE_SOURCE_UPLOAD_IN_LIBRARY, FILE_SOURCE_ADD_VOD, FILE_SOURCE_CLOUD_STORAGE_AWS, FILE_SOURCE_STT, FILE_SOURCE_ADD_AOD, FILE_SOURCE_AISK, FILE_SOURCE_GOOGLE_DRIVE]

    Required. The source of the file, only for display.

    attrs object
    property name* string
    has_subtitle Output Only. Indicate the video has subtitle or not when the file type is `FILE_TYPE_VIDEO` (boolean)
    subtitles object[]
  • Array [
  • id string

    The unique id of the subtitle.

    library_id string

    The unique id of the library subtitle file.

    name string

    The name of the subtitle file.

    code string

    The language code of the subtitle file. Follow RFC 5646 (shortest ISO 639 code).

    display string

    The display name of the subtitle file.

  • ]
  • status string

    Possible values: [FILE_STATUS_SUCCEED, FILE_STATUS_PROGRESSING, FILE_STATUS_FAILED]

    Output Only. The file status.

    permission object
    default_access_role stringrequired

    Possible values: [ACCESS_ROLE_DENY, ACCESS_ROLE_SUPER_EDITOR, ACCESS_ROLE_EDITOR, ACCESS_ROLE_VIEWER]

    assignments object[]
  • Array [
  • id stringrequired

    Required. Output Only. if the assigned_type is ASSIGNED_TYPE_USER, the id is user id. if the assigned_type is ASSIGNED_TYPE_GROUP, the id is group id.

    email string

    Output Only. It will return if the assigned_type matches ASSIGNED_TYPE_USER.

    name string

    Output Only. The name of user or group.

    assigned_type Required. Output Only. It indicates the assigned type is user or group. It is not accept the `ASSIGNED_TYPE_OWNER` (string)required

    Possible values: [ASSIGNED_TYPE_USER, ASSIGNED_TYPE_GROUP]

    access_role Required. Output Only. It indicates access role. It is not accept the `ACCESS_ROLE_DENY` (string)required

    Possible values: [ACCESS_ROLE_DENY, ACCESS_ROLE_SUPER_EDITOR, ACCESS_ROLE_EDITOR, ACCESS_ROLE_VIEWER]

  • ]
  • created_at date-time

    Output only.

    updated_at date-time

    Output only.

    contents object[]
  • Array [
  • index int32
    start_at string
    end_at string
    words string[]
  • ]
  • source_type string

    Possible values: [SUBTITLE_SOURCE_TYPE_LOCAL, SUBTITLE_SOURCE_TYPE_STT]

    The source type of subtitle.

    created_at date-time

    Output only.

    updated_at date-time

    Output only.

  • ]
  • schedule object

    Output Only. Indicate the schedule setting of the AOD.

    enable booleanrequired

    Enable VOD viewing schedule or not.

    start_time date-timerequired

    VOD viewing start time. Users can only watch the VOD within the specified start time and end time.

    end_time date-timerequired

    VOD viewing end time. Users can only watch the VOD within the specified start time and end time.

    cover_image object

    Output Only. Indicate the cover image of the AOD.

    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.

    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)
  • ]
  • showroom object

    Output Only. Indicate the showroom setting of the AOD.

    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.

  • ]
  • org_id string

    Output Only. The organization ID that the encoding belongs to.

    player_setting object

    Optional. The setting of player.

    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.

  • ]
  • created_at date-time

    Output Only. Indicate the created time of the AOD.

    updated_at date-time

    Output Only. Indicate the latest update time of the AOD.

  • ]
  • pagination object
    total_items int32

    Output only. The total numbers of the list in the current pagination.

    items_per_page int32

    Output only. The number of items per page in the current pagination.

    current_page int32

    Output only. The current page in the current pagination.

Loading...