Gjsify LogoGjsify Logo

Information for a video format.

record

Hierarchy

  • VideoFormatInfo

Index

Constructors

Properties

bits: number

The number of bits used to pack data items. This can be less than 8 when multiple pixels are stored in a byte. for values > 8 multiple bytes should be read according to the endianness flag before applying the shift and mask.

field
depth: number[]

the depth in bits for each component

field
description: string

use readable description of the format

field

#GstVideoFormatFlags

field

#GstVideoFormat

field
h_sub: number[]

subsampling factor of the height for the component. Use GST_VIDEO_SUB_SCALE to scale a height.

field
n_components: number

the number of components in the video format.

field
n_planes: number

the number of planes for this format. The number of planes can be less than the amount of components when multiple components are packed into one plane.

field
name: string

string representation of the format

field
pack_func: VideoFormatPack

an pack function for this format

field
pack_lines: number

the amount of lines that will be packed

field
pixel_stride: number[]

the pixel stride of each component. This is the amount of bytes to the pixel immediately to the right. When bits < 8, the stride is expressed in bits. For 24-bit RGB, this would be 3 bytes, for example, while it would be 4 bytes for RGBx or ARGB.

field
plane: number[]

the plane number where a component can be found

field
poffset: number[]

the offset in the plane where the first pixel of the components can be found.

field
shift: number[]

the number of bits to shift away to get the component data

field
tile_hs: number

The height of a tile, in bytes, represented as a shift

field
tile_mode: VideoTileMode

The tiling mode

field
tile_ws: number

The width of a tile, in bytes, represented as a shift

field
unpack_format: GstVideo.VideoFormat

the format of the unpacked pixels. This format must have the #GST_VIDEO_FORMAT_FLAG_UNPACK flag set.

field
unpack_func: VideoFormatUnpack

an unpack function for this format

field
w_sub: number[]

subsampling factor of the width for the component. Use GST_VIDEO_SUB_SCALE to scale a width.

field
name: string

Methods

  • component(plane: number): number
  • Fill components with the number of all the components packed in plane p for the format info. A value of -1 in components indicates that no more components are packed in the plane.

    Parameters

    • plane: number

      a plane number

    Returns number

  • extrapolate_stride(plane: number, stride: number): number
  • Extrapolate plane stride from the first stride of an image. This helper is useful to support legacy API were only one stride is supported.

    Parameters

    • plane: number

      a plane number

    • stride: number

      The fist plane stride

    Returns number

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