schema

FFprobe XML schema definitions.

Classes:

Name	Description
chapterType	Information about a single chapter.
chaptersType	Container for chapter information.
errorType	Information about an error.
ffprobeType	Root type for FFprobe XML output.
formatType	Information about the media format.
frameSideDataComponentList	Container for frame side data component information.
frameSideDataComponentType	Information about frame side data component.
frameSideDataListType	Container for frame side data information.
frameSideDataPieceList	Container for frame side data piece information.
frameSideDataPieceType	Information about frame side data piece.
frameSideDataTimecodeList	Container for frame side data timecode information.
frameSideDataTimecodeType	Information about frame side data timecode.
frameSideDataType	Information about frame side data.
frameSideDatumType	Individual frame side data item.
frameType	Information about a single frame.
framesType	Container for frame information.
libraryVersionType	Information about a library version.
libraryVersionsType	Container for library version information.
logType	Information about a single log entry.
logsType	Container for log information.
packetSideDataListType	Container for packet side data information.
packetSideDataType	Information about packet side data.
packetSideDatumType	Individual packet side data item.
packetType	Information about a single packet.
packetsAndFramesType	Container for both packet and frame information.
packetsType	Container for packet information.
pixelFormatComponentType	Information about a pixel format component.
pixelFormatComponentsType	Container for pixel format component information.
pixelFormatFlagsType	Information about pixel format flags.
pixelFormatType	Information about a pixel format.
pixelFormatsType	Container for pixel format information.
programType	Information about a single program.
programVersionType	Information about the program version.
programsType	Container for program information.
streamDispositionType	Information about stream disposition flags.
streamType	Information about a single stream.
streamsType	Container for stream information.
subtitleType	Information about a subtitle frame.
tagType	Information about a single tag.
tagsType	Container for tag information.

chapterType dataclass

chapterType(
    *,
    tags: tuple[tagsType, ...] | None = None,
    id: int | None = None,
    time_base: str | None = None,
    start: int | None = None,
    start_time: float | None = None,
    end: int | None = None,
    end_time: float | None = None
)

Information about a single chapter.

chaptersType dataclass

chaptersType(
    *, chapter: tuple[chapterType, ...] | None = None
)

Container for chapter information.

errorType dataclass

errorType(
    *, code: int | None = None, string: str | None = None
)

Information about an error.

ffprobeType dataclass

ffprobeType(
    *,
    program_version: Optional[programVersionType] = None,
    library_versions: Optional[libraryVersionsType] = None,
    pixel_formats: Optional[pixelFormatsType] = None,
    packets: Optional[packetsType] = None,
    frames: Optional[framesType] = None,
    packets_and_frames: Optional[
        packetsAndFramesType
    ] = None,
    programs: Optional[programsType] = None,
    streams: Optional[streamsType] = None,
    chapters: Optional[chaptersType] = None,
    format: Optional[formatType] = None,
    error: Optional[errorType] = None
)

Root type for FFprobe XML output.

formatType dataclass

formatType(
    *,
    tags: Optional[tagsType] = None,
    filename: str | None = None,
    nb_streams: int | None = None,
    nb_programs: int | None = None,
    nb_stream_groups: int | None = None,
    format_name: str | None = None,
    format_long_name: str | None = None,
    start_time: float | None = None,
    duration: float | None = None,
    size: int | None = None,
    bit_rate: int | None = None,
    probe_score: int | None = None
)

Information about the media format.

frameSideDataComponentList dataclass

frameSideDataComponentList(
    *,
    component: (
        tuple[frameSideDataComponentType, ...] | None
    ) = None
)

Container for frame side data component information.

frameSideDataComponentType dataclass

frameSideDataComponentType(
    *,
    pieces: Optional[frameSideDataPieceList] = None,
    side_datum: tuple[frameSideDatumType, ...] | None = None
)

Information about frame side data component.

frameSideDataListType dataclass

frameSideDataListType(
    *,
    side_data: tuple[frameSideDataType, ...] | None = None
)

Container for frame side data information.

frameSideDataPieceList dataclass

frameSideDataPieceList(
    *,
    piece: tuple[frameSideDataPieceType, ...] | None = None
)

Container for frame side data piece information.

frameSideDataPieceType dataclass

frameSideDataPieceType(
    *,
    side_datum: tuple[frameSideDatumType, ...] | None = None
)

Information about frame side data piece.

frameSideDataTimecodeList dataclass

frameSideDataTimecodeList(
    *,
    timecode: (
        tuple[frameSideDataTimecodeType, ...] | None
    ) = None
)

Container for frame side data timecode information.

frameSideDataTimecodeType dataclass

frameSideDataTimecodeType(*, value: str | None = None)

Information about frame side data timecode.

frameSideDataType dataclass

frameSideDataType(
    *,
    timecodes: Optional[frameSideDataTimecodeList] = None,
    components: Optional[frameSideDataComponentList] = None,
    side_datum: (
        tuple[frameSideDatumType, ...] | None
    ) = None,
    side_data_type: str | None = None,
    side_data_size: int | None = None,
    timecode: str | None = None
)

Information about frame side data.

frameSideDatumType dataclass

frameSideDatumType(
    *, key: str | None = None, value: str | None = None
)

Individual frame side data item.

frameType dataclass

frameType(
    *,
    tags: Optional[tagsType] = None,
    logs: Optional[logsType] = None,
    side_data_list: Optional[frameSideDataListType] = None,
    media_type: str | None = None,
    stream_index: int | None = None,
    key_frame: int | None = None,
    pts: int | None = None,
    pts_time: float | None = None,
    pkt_dts: int | None = None,
    pkt_dts_time: float | None = None,
    best_effort_timestamp: int | None = None,
    best_effort_timestamp_time: float | None = None,
    pkt_duration: int | None = None,
    pkt_duration_time: float | None = None,
    duration: int | None = None,
    duration_time: float | None = None,
    pkt_pos: int | None = None,
    pkt_size: int | None = None,
    sample_fmt: str | None = None,
    nb_samples: int | None = None,
    channels: int | None = None,
    channel_layout: str | None = None,
    width: int | None = None,
    height: int | None = None,
    crop_top: int | None = None,
    crop_bottom: int | None = None,
    crop_left: int | None = None,
    crop_right: int | None = None,
    pix_fmt: str | None = None,
    sample_aspect_ratio: str | None = None,
    pict_type: str | None = None,
    coded_picture_number: int | None = None,
    display_picture_number: int | None = None,
    interlaced_frame: int | None = None,
    top_field_first: int | None = None,
    repeat_pict: int | None = None,
    color_range: str | None = None,
    color_space: str | None = None,
    color_primaries: str | None = None,
    color_transfer: str | None = None,
    chroma_location: str | None = None
)

Information about a single frame.

framesType dataclass

framesType(
    *,
    frame: tuple[frameType, ...] | None = None,
    subtitle: tuple[subtitleType, ...] | None = None
)

Container for frame information.

libraryVersionType dataclass

libraryVersionType(
    *,
    name: str | None = None,
    major: int | None = None,
    minor: int | None = None,
    micro: int | None = None,
    version: int | None = None,
    ident: str | None = None
)

Information about a library version.

libraryVersionsType dataclass

libraryVersionsType(
    *,
    library_version: (
        tuple[libraryVersionType, ...] | None
    ) = None
)

Container for library version information.

logType dataclass

logType(
    *,
    context: str | None = None,
    level: int | None = None,
    category: int | None = None,
    parent_context: str | None = None,
    parent_category: int | None = None,
    message: str | None = None
)

Information about a single log entry.

logsType dataclass

logsType(*, log: tuple[logType, ...] | None = None)

Container for log information.

packetSideDataListType dataclass

packetSideDataListType(
    *,
    side_data: tuple[packetSideDataType, ...] | None = None
)

Container for packet side data information.

packetSideDataType dataclass

packetSideDataType(
    *,
    side_datum: (
        tuple[packetSideDatumType, ...] | None
    ) = None,
    type: str | None = None
)

Information about packet side data.

packetSideDatumType dataclass

packetSideDatumType(
    *, key: str | None = None, value: str | None = None
)

Individual packet side data item.

packetType dataclass

packetType(
    *,
    tags: Optional[tagsType] = None,
    side_data_list: Optional[packetSideDataListType] = None,
    codec_type: str | None = None,
    stream_index: int | None = None,
    pts: int | None = None,
    pts_time: float | None = None,
    dts: int | None = None,
    dts_time: float | None = None,
    duration: int | None = None,
    duration_time: float | None = None,
    size: int | None = None,
    pos: int | None = None,
    flags: str | None = None,
    data: str | None = None,
    data_hash: str | None = None
)

Information about a single packet.

packetsAndFramesType dataclass

packetsAndFramesType(
    *,
    packet: tuple[packetType, ...] | None = None,
    frame: tuple[frameType, ...] | None = None,
    subtitle: tuple[subtitleType, ...] | None = None
)

Container for both packet and frame information.

packetsType dataclass

packetsType(
    *, packet: tuple[packetType, ...] | None = None
)

Container for packet information.

pixelFormatComponentType dataclass

pixelFormatComponentType(
    *,
    index: int | None = None,
    bit_depth: int | None = None
)

Information about a pixel format component.

pixelFormatComponentsType dataclass

pixelFormatComponentsType(
    *,
    component: (
        tuple[pixelFormatComponentType, ...] | None
    ) = None
)

Container for pixel format component information.

pixelFormatFlagsType dataclass

pixelFormatFlagsType(
    *,
    big_endian: int | None = None,
    palette: int | None = None,
    bitstream: int | None = None,
    hwaccel: int | None = None,
    planar: int | None = None,
    rgb: int | None = None,
    alpha: int | None = None
)

Information about pixel format flags.

pixelFormatType dataclass

pixelFormatType(
    *,
    flags: Optional[pixelFormatFlagsType] = None,
    components: Optional[pixelFormatComponentsType] = None,
    name: str | None = None,
    nb_components: int | None = None,
    log2_chroma_w: int | None = None,
    log2_chroma_h: int | None = None,
    bits_per_pixel: int | None = None
)

Information about a pixel format.

pixelFormatsType dataclass

pixelFormatsType(
    *,
    pixel_format: tuple[pixelFormatType, ...] | None = None
)

Container for pixel format information.

programType dataclass

programType(
    *,
    tags: Optional[tagsType] = None,
    streams: Optional[streamsType] = None,
    program_id: int | None = None,
    program_num: int | None = None,
    nb_streams: int | None = None,
    pmt_pid: int | None = None,
    pcr_pid: int | None = None
)

Information about a single program.

programVersionType dataclass

programVersionType(
    *,
    version: str | None = None,
    copyright: str | None = None,
    build_date: str | None = None,
    build_time: str | None = None,
    compiler_ident: str | None = None,
    configuration: str | None = None
)

Information about the program version.

programsType dataclass

programsType(
    *, program: tuple[programType, ...] | None = None
)

Container for program information.

streamDispositionType dataclass

streamDispositionType(
    *,
    default: int | None = None,
    dub: int | None = None,
    original: int | None = None,
    comment: int | None = None,
    lyrics: int | None = None,
    karaoke: int | None = None,
    forced: int | None = None,
    hearing_impaired: int | None = None,
    visual_impaired: int | None = None,
    clean_effects: int | None = None,
    attached_pic: int | None = None,
    timed_thumbnails: int | None = None,
    non_diegetic: int | None = None,
    captions: int | None = None,
    descriptions: int | None = None,
    metadata: int | None = None,
    dependent: int | None = None,
    still_image: int | None = None
)

Information about stream disposition flags.

streamType dataclass

streamType(
    *,
    disposition: Optional[streamDispositionType] = None,
    tags: Optional[tagsType] = None,
    side_data_list: Optional[packetSideDataListType] = None,
    index: int | None = None,
    codec_name: str | None = None,
    codec_long_name: str | None = None,
    profile: str | None = None,
    codec_type: str | None = None,
    codec_tag: str | None = None,
    codec_tag_string: str | None = None,
    extradata: str | None = None,
    extradata_size: int | None = None,
    extradata_hash: str | None = None,
    width: int | None = None,
    height: int | None = None,
    coded_width: int | None = None,
    coded_height: int | None = None,
    closed_captions: bool | None = None,
    film_grain: bool | None = None,
    has_b_frames: int | None = None,
    sample_aspect_ratio: str | None = None,
    display_aspect_ratio: str | None = None,
    pix_fmt: str | None = None,
    level: int | None = None,
    color_range: str | None = None,
    color_space: str | None = None,
    color_transfer: str | None = None,
    color_primaries: str | None = None,
    chroma_location: str | None = None,
    field_order: str | None = None,
    refs: int | None = None,
    sample_fmt: str | None = None,
    sample_rate: int | None = None,
    channels: int | None = None,
    channel_layout: str | None = None,
    bits_per_sample: int | None = None,
    initial_padding: int | None = None,
    id: str | None = None,
    r_frame_rate: str | None = None,
    avg_frame_rate: str | None = None,
    time_base: str | None = None,
    start_pts: int | None = None,
    start_time: float | None = None,
    duration_ts: int | None = None,
    duration: float | None = None,
    bit_rate: int | None = None,
    max_bit_rate: int | None = None,
    bits_per_raw_sample: int | None = None,
    nb_frames: int | None = None,
    nb_read_frames: int | None = None,
    nb_read_packets: int | None = None
)

Information about a single stream.

streamsType dataclass

streamsType(
    *, stream: tuple[streamType, ...] | None = None
)

Container for stream information.

subtitleType dataclass

subtitleType(
    *,
    media_type: str | None = None,
    pts: int | None = None,
    pts_time: float | None = None,
    format: int | None = None,
    start_display_time: int | None = None,
    end_display_time: int | None = None,
    num_rects: int | None = None
)

Information about a subtitle frame.

tagType dataclass

tagType(
    *, key: str | None = None, value: str | None = None
)

Information about a single tag.

tagsType dataclass

tagsType(*, tag: tuple[tagType, ...] | None = None)

Container for tag information.