Gjsify LogoGjsify Logo

Information describing image properties. This information can be filled in from GstCaps with gst_video_info_from_caps(). The information is also used to store the specific video info when mapping a video frame with gst_video_frame_map().

Use the provided macros to access the info in this structure.

record

Hierarchy

  • VideoInfo

Index

Constructors

Properties

chroma_site: VideoChromaSite

a #GstVideoChromaSite.

field
colorimetry: VideoColorimetry

the colorimetry info

field

the format info of the video

field
flags: VideoFlags

additional video flags

field
fps_d: number

the framerate denominator

field
fps_n: number

the framerate numerator

field
height: number

the height of the video

field
interlace_mode: VideoInterlaceMode

the interlace mode

field
offset: number[]

offsets of the planes

field
par_d: number

the pixel-aspect-ratio denominator

field
par_n: number

the pixel-aspect-ratio numerator

field
size: number

the default size of one frame

field
stride: number[]

strides of the planes

field
views: number

the number of views for multiview video

field
width: number

the width of the video

field
name: string

Methods

  • Adjust the offset and stride fields in info so that the padding and stride alignment in align is respected.

    Extra padding will be added to the right side when stride alignment padding is required and align will be updated with the new padding values.

    Parameters

    Returns boolean

  • Extra padding will be added to the right side when stride alignment padding is required and align will be updated with the new padding values.

    This variant of gst_video_info_align() provides the updated size, in bytes, of each video plane after the alignment, including all horizontal and vertical paddings.

    In case of GST_VIDEO_INTERLACE_MODE_ALTERNATE info, the returned sizes are the ones used to hold a single field, not the full frame.

    Parameters

    Returns [boolean, number]

  • convert(src_format: Gst.Format, src_value: number, dest_format: Gst.Format): [boolean, number]
  • Converts among various #GstFormat types. This function handles GST_FORMAT_BYTES, GST_FORMAT_TIME, and GST_FORMAT_DEFAULT. For raw video, GST_FORMAT_DEFAULT corresponds to video frames. This function can be used to handle pad queries of the type GST_QUERY_CONVERT.

    Parameters

    • src_format: Gst.Format

      #GstFormat of the src_value

    • src_value: number

      value to convert

    • dest_format: Gst.Format

      #GstFormat of the dest_value

    Returns [boolean, number]

  • free(): void
  • Set the default info for a video frame of format and width and height.

    Note: This initializes info first, no values are preserved. This function does not set the offsets correctly for interlaced vertically subsampled formats.

    Parameters

    Returns boolean

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method