support Contact Support | system status System Status
Page Contents

    Ingest Fields Reference

    This topic provides a reference to the request body fields for the Dynamic Ingest API. Also see the API Reference.

    Dynamic Ingest fields

    Video Cloud Ingest Fields
    Field Type Description
    master optional Object

    the video master to be ingested

    master.url optional Url

    URL for the video source; required except for re-transcoding where a digital master has been archived, or you are adding images or text tracks to an existing video

    master.use_archived_master optional Boolean

    For retranscode requests, will use the archived master if set to true; if set to false, you must also include the url for the source video

    master.audio_tracks optional Object

    An audio_tracks object within the master object contains metadata for the audio track included in the video file (if any - this is also referred to as the muxed in audio) - this will include metadata only, without a URL for the audio file, since the audio track is already included in the video file - see Implementing Multiple Audio Tracks Using the APIs for more information

    master.audio_tracks.language optional String

    Language code for the muxed in audio from the subtags in http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry (default can be set for the account by contacting Brightcove Support) Dynamic Delivery only

    master.audio_tracks.variant optional String

    the type of audio track for the muxed in (default can be set for the account by contacting Brightcove Support) - for the muxed in audio, this is usually main Dynamic Delivery only

    Allowed values: "main", "alternate", "commentary", "dub", "descriptive"

    audio_tracks optional Dynamic Delivery only Object[]

    array of audio track objects - see Implementing Multiple Audio Tracks Using the APIs for more information.

    audio_tracks.merge_with_existing optional Boolean

    whether to replace existing audio tracks or add the new ones Dynamic Delivery only

    Default value: false

    audio_tracks.masters optional Object[]

    array of audio track objects Dynamic Delivery only

    audio_tracks.masters.url optional String

    URL for the audio file Dynamic Delivery only

    audio_tracks.masters.language optional String

    Language code for the audio track from the subtags in http://www.iana.org/assignments/language-subtag-registry/language-subtag-registry (default can be set for the account by contacting Brightcove Support) Dynamic Delivery only

    audio_tracks.masters.variant optional String

    the type of audio track (default can be set for the account by contacting Brightcove Support) Dynamic Delivery only

    Allowed values: "main", "alternate", "commentary", "dub", "descriptive"

    profile optional String

    ingest profile to use for transcoding; if absent, the default profile will be used

    text_tracks optional Object[]

    array of text_tracks objects - see Ingesting WebVTT Files (Text Tracks)

    text_tracks.url Url

    URL for a WebVTT file

    text_tracks.srclang String

    ISO 639 2-letter (alpha-2) language code for the text tracks

    text_tracks.kind optional String

    how the vtt file is meant to be used

    Default value: captions

    Allowed values: "captions", "subtitles", "chapters", "metadata"

    text_tracks.label optional String

    user-readable title

    text_tracks.default optional Boolean

    sets the default language for captions/subtitles

    capture-images optional Boolean

    whether poster and thumbnail should be captured during transcoding; defaults to true if the profile has image renditions, false if it does not - see Images and the Dynamic Ingest API for more information

    poster optional Object

    the video poster to be ingested - see Images and the Dynamic Ingest API for more information

    poster.url Url

    URL for the video poster image

    poster.height optional Integer

    pixel height of the image

    poster.width optional Integer

    pixel width of the image

    thumbnail optional Object

    the video thumbnail to be ingested - see Images and the Dynamic Ingest API for more information

    thumbnail.url Url

    URL for the video thumbnail image

    thumbnail.height optional Integer

    pixel height of the image

    thumbnail.width optional Integer

    pixel width of the image

    callbacks optional String[] Array of URLs that notifications should be sent to

     


    Page last updated on 12 Jun 2020