@adcp/client API Reference - v4.19.0
    Preparing search index...

    Interface VideoAsset

    Video asset with URL and technical specifications including audio track properties

    interface VideoAsset {
        url: string;
        width: number;
        height: number;
        duration_ms?: number;
        file_size_bytes?: number;
        container_format?: string;
        video_codec?: string;
        video_bitrate_kbps?: number;
        frame_rate?: string;
        frame_rate_type?: "constant" | "variable";
        scan_type?: "progressive" | "interlaced";
        color_space?: "rec709" | "rec2020" | "rec2100" | "srgb" | "dci_p3";
        hdr_format?: "sdr" | "hdr10" | "hdr10_plus" | "hlg" | "dolby_vision";
        chroma_subsampling?: "4:2:0" | "4:2:2" | "4:4:4";
        video_bit_depth?: 8 | 10 | 12;
        gop_interval_seconds?: number;
        gop_type?: "closed" | "open";
        moov_atom_position?: "start" | "end";
        has_audio?: boolean;
        audio_codec?: string;
        audio_sampling_rate_hz?: number;
        audio_channels?: "mono" | "stereo" | "5.1" | "7.1";
        audio_bit_depth?: 16 | 24 | 32;
        audio_bitrate_kbps?: number;
        audio_loudness_lufs?: number;
        audio_true_peak_dbfs?: number;
        captions_url?: string;
        transcript_url?: string;
        audio_description_url?: string;
        provenance?: Provenance;
    }
    Index

    Properties

    url width height duration_ms? file_size_bytes? container_format? video_codec? video_bitrate_kbps? frame_rate? frame_rate_type? scan_type? color_space? hdr_format? chroma_subsampling? video_bit_depth? gop_interval_seconds? gop_type? moov_atom_position? has_audio? audio_codec? audio_sampling_rate_hz? audio_channels? audio_bit_depth? audio_bitrate_kbps? audio_loudness_lufs? audio_true_peak_dbfs? captions_url? transcript_url? audio_description_url? provenance?

    Properties

    url: string

    URL to the video asset

    width: number

    Width in pixels

    height: number

    Height in pixels

    duration_ms?: number

    Video duration in milliseconds

    file_size_bytes?: number

    File size in bytes

    container_format?: string

    Video container format (mp4, webm, mov, etc.)

    video_codec?: string

    Video codec used (h264, h265, vp9, av1, prores, etc.)

    video_bitrate_kbps?: number

    Video stream bitrate in kilobits per second

    frame_rate?: string

    Frame rate as string to preserve precision (e.g., '23.976', '29.97', '30')

    frame_rate_type?: "constant" | "variable"

    Whether the video uses constant (CFR) or variable (VFR) frame rate

    scan_type?: "progressive" | "interlaced"

    Scan type of the video

    color_space?: "rec709" | "rec2020" | "rec2100" | "srgb" | "dci_p3"

    Color space of the video

    hdr_format?: "sdr" | "hdr10" | "hdr10_plus" | "hlg" | "dolby_vision"

    HDR format if applicable, or 'sdr' for standard dynamic range

    chroma_subsampling?: "4:2:0" | "4:2:2" | "4:4:4"

    Chroma subsampling format

    video_bit_depth?: 8 | 10 | 12

    Video bit depth

    gop_interval_seconds?: number

    GOP/keyframe interval in seconds

    gop_type?: "closed" | "open"

    GOP structure type

    moov_atom_position?: "start" | "end"

    Position of moov atom in MP4 container

    has_audio?: boolean

    Whether the video contains an audio track

    audio_codec?: string

    Audio codec used (aac, aac_lc, he_aac, pcm, mp3, ac3, eac3, etc.)

    audio_sampling_rate_hz?: number

    Audio sampling rate in Hz (e.g., 44100, 48000)

    audio_channels?: "mono" | "stereo" | "5.1" | "7.1"

    Audio channel configuration

    audio_bit_depth?: 16 | 24 | 32

    Audio bit depth

    audio_bitrate_kbps?: number

    Audio bitrate in kilobits per second

    audio_loudness_lufs?: number

    Integrated loudness in LUFS

    audio_true_peak_dbfs?: number

    True peak level in dBFS

    captions_url?: string

    URL to captions file (WebVTT, SRT, etc.)

    transcript_url?: string

    URL to text transcript of the video content

    audio_description_url?: string

    URL to audio description track for visually impaired users

    provenance?: Provenance

    Settings

    Member Visibility

    On This Page

    Properties