Flags

Details

class GstVideo.NavigationModifierType(value)

Bases: GObject.GFlags

Flags to indicate the state of modifier keys and mouse buttons in events.

Typical modifier keys are Shift, Control, Meta, Super, Hyper, Alt, Compose, Apple, CapsLock or ShiftLock.

New in version 1.22.

NONE = 0
SHIFT_MASK = 1

the Shift key.

BUTTON3_MASK = 1024

the third mouse button (usually the mouse wheel button or middle button).

MOD5_MASK = 128

the seventh modifier key

HYPER_MASK = 134217728

the Hyper modifier

MOD2_MASK = 16

the fourth modifier key

LOCK_MASK = 2
BUTTON4_MASK = 2048

the fourth mouse button (typically the “Back” button).

BUTTON1_MASK = 256

the first mouse button (usually the left button).

META_MASK = 268435456

the Meta modifier

MOD3_MASK = 32

the fifth modifier key

CONTROL_MASK = 4

the Control key.

BUTTON5_MASK = 4096

the fifth mouse button (typically the “forward” button).

MASK = 469770239

A mask covering all entries in #GdkModifierType.

BUTTON2_MASK = 512

the second mouse button (usually the right button).

MOD4_MASK = 64

the sixth modifier key

SUPER_MASK = 67108864

the Super modifier

MOD1_MASK = 8

the third modifier key

class GstVideo.VideoBufferFlags(value)

Bases: GObject.GFlags

Additional video buffer flags. These flags can potentially be used on any buffers carrying closed caption data, or video data - even encoded data.

Note that these are only valid for Gst.Caps of type: video/… and caption/… They can conflict with other extended buffer flags.

INTERLACED = 1048576

If the Gst.Buffer is interlaced. In mixed interlace-mode, this flags specifies if the frame is interlaced or progressive.

TOP_FIELD = 10485760

The video frame has the top field only. This is the same as GstVideo.VideoBufferFlags.TFF | GstVideo.VideoBufferFlags.ONEFIELD Use GST_VIDEO_BUFFER_IS_TOP_FIELD() to check for this flag.

New in version 1.16.

MULTIPLE_VIEW = 16777216

The Gst.Buffer contains one or more specific views, such as left or right eye view. This flags is set on any buffer that contains non-mono content - even for streams that contain only a single viewpoint. In mixed mono / non-mono streams, the absence of the flag marks mono buffers.

TFF = 2097152

If the Gst.Buffer is interlaced, then the first field in the video frame is the top field. If unset, the bottom field is first.

LAST = 268435456

Offset to define more flags

FIRST_IN_BUNDLE = 33554432

When conveying stereo/multiview content with frame-by-frame methods, this flag marks the first buffer in a bundle of frames that belong together.

RFF = 4194304

If the Gst.Buffer is interlaced, then the first field (as defined by the GstVideo.VideoBufferFlags.TFF flag setting) is repeated.

MARKER = 512

The Gst.Buffer contains the end of a video field or frame boundary such as the last subframe or packet

New in version 1.18.

BOTTOM_FIELD = 8388608

The video frame has the bottom field only. This is the same as GstVideo.VideoBufferFlags.ONEFIELD (GstVideo.VideoBufferFlags.TFF flag unset) Use GST_VIDEO_BUFFER_IS_BOTTOM_FIELD() to check for this flag.

New in version 1.16.

ONEFIELD = 8388608

If the Gst.Buffer is interlaced, then only the first field (as defined by the GstVideo.VideoBufferFlags.TFF flag setting) is to be displayed

New in version 1.16.

class GstVideo.VideoChromaFlags(value)

Bases: GObject.GFlags

Extra flags that influence the result from gst_video_chroma_resample_new().

NONE = 0

no flags

INTERLACED = 1

the input is interlaced

class GstVideo.VideoChromaSite(value)

Bases: GObject.GFlags

Various Chroma sitings.

UNKNOWN = 0

unknown cositing

JPEG = 1

jpeg style cositing, also for mpeg1 and mjpeg

NONE = 1

no cositing

DV = 14

DV style cositing

H_COSITED = 2

chroma is horizontally cosited

MPEG2 = 2

mpeg2 style cositing

V_COSITED = 4

chroma is vertically cosited

COSITED = 6

chroma samples cosited with luma samples

ALT_LINE = 8

choma samples are sited on alternate lines

class GstVideo.VideoCodecFrameFlags(value)

Bases: GObject.GFlags

Flags for GstVideo.VideoCodecFrame

DECODE_ONLY = 1

is the frame only meant to be decoded

CORRUPTED = 16

The buffer data is corrupted.

New in version 1.20.

SYNC_POINT = 2

is the frame a synchronization point (keyframe)

FORCE_KEYFRAME = 4

should the output frame be made a keyframe

FORCE_KEYFRAME_HEADERS = 8

should the encoder output stream headers

class GstVideo.VideoDecoderRequestSyncPointFlags(value)

Bases: GObject.GFlags

Flags to be used in combination with GstVideo.VideoDecoder.request_sync_point(). See the function documentation for more details.

New in version 1.20.

DISCARD_INPUT = 1

discard all following input until the next sync point.

CORRUPT_OUTPUT = 2

discard all following output until the next sync point.

class GstVideo.VideoDitherFlags(value)

Bases: GObject.GFlags

Extra flags that influence the result from gst_video_chroma_resample_new().

NONE = 0

no flags

INTERLACED = 1

the input is interlaced

QUANTIZE = 2

quantize values in addition to adding dither.

class GstVideo.VideoFlags(value)

Bases: GObject.GFlags

Extra video flags

NONE = 0

no flags

VARIABLE_FPS = 1

a variable fps is selected, fps_n and fps_d denote the maximum fps of the video

PREMULTIPLIED_ALPHA = 2

Each color has been scaled by the alpha value.

class GstVideo.VideoFormatFlags(value)

Bases: GObject.GFlags

The different video flags that a format info can have.

YUV = 1

The video format is YUV, components are numbered 0=Y, 1=U, 2=V.

UNPACK = 128

This format can be used in a GstVideo.VideoFormatUnpack and GstVideo.VideoFormatPack function.

LE = 16

The video format has data stored in little endianness.

RGB = 2

The video format is RGB, components are numbered 0=R, 1=G, 2=B.

TILED = 256

The format is tiled, there is tiling information in the last plane.

PALETTE = 32

The video format has a palette. The palette is stored in the second plane and indexes are stored in the first plane.

GRAY = 4

The video is gray, there is one gray component with index 0.

SUBTILES = 512

The tile size varies per plane according to the subsampling.

New in version 1.22.

COMPLEX = 64

The video format has a complex layout that can’t be described with the usual information in the GstVideo.VideoFormatInfo.

ALPHA = 8

The video format has an alpha components with the number 3.

class GstVideo.VideoFrameFlags(value)

Bases: GObject.GFlags

Extra video frame flags

NONE = 0

no flags

INTERLACED = 1

The video frame is interlaced. In mixed interlace-mode, this flag specifies if the frame is interlaced or progressive.

TOP_FIELD = 10

The video frame has the top field only. This is the same as GstVideo.VideoFrameFlags.TFF | GstVideo.VideoFrameFlags.ONEFIELD

New in version 1.16.

MULTIPLE_VIEW = 16

The video contains one or more non-mono views

TFF = 2

The video frame has the top field first

FIRST_IN_BUNDLE = 32

The video frame is the first in a set of corresponding views provided as sequential frames.

RFF = 4

The video frame has the repeat flag

BOTTOM_FIELD = 8

The video frame has the bottom field only. This is the same as GstVideo.VideoFrameFlags.ONEFIELD (GstVideo.VideoFrameFlags.TFF flag unset)

New in version 1.16.

ONEFIELD = 8

The video frame has one field

class GstVideo.VideoFrameMapFlags(value)

Bases: GObject.GFlags

Additional mapping flags for GstVideo.VideoFrame.map().

New in version 1.6.

LAST = 16777216

Offset to define more flags

NO_REF = 65536

Don’t take another reference of the buffer and store it in the GstVideo.VideoFrame. This makes sure that the buffer stays writable while the frame is mapped, but requires that the buffer reference stays valid until the frame is unmapped again.

class GstVideo.VideoMultiviewFlags(value)

Bases: GObject.GFlags

GstVideo.VideoMultiviewFlags are used to indicate extra properties of a stereo/multiview stream beyond the frame layout and buffer mapping that is conveyed in the GstVideo.VideoMultiviewMode.

NONE = 0

No flags

RIGHT_VIEW_FIRST = 1

For stereo streams, the normal arrangement of left and right views is reversed.

RIGHT_FLOPPED = 16

The right view is horizontally mirrored.

HALF_ASPECT = 16384

For frame-packed multiview modes, indicates that the individual views have been encoded with half the true width or height and should be scaled back up for display. This flag is used for overriding input layout interpretation by adjusting pixel-aspect-ratio. For side-by-side, column interleaved or checkerboard packings, the pixel width will be doubled. For row interleaved and top-bottom encodings, pixel height will be doubled.

LEFT_FLIPPED = 2

The left view is vertically mirrored.

MIXED_MONO = 32768

The video stream contains both mono and multiview portions, signalled on each buffer by the absence or presence of the GstVideo.VideoBufferFlags.MULTIPLE_VIEW buffer flag.

LEFT_FLOPPED = 4

The left view is horizontally mirrored.

RIGHT_FLIPPED = 8

The right view is vertically mirrored.

class GstVideo.VideoOverlayFormatFlags(value)

Bases: GObject.GFlags

Overlay format flags.

NONE = 0

no flags

PREMULTIPLIED_ALPHA = 1

RGB are premultiplied by A/255.

GLOBAL_ALPHA = 2

a global-alpha value != 1 is set.

class GstVideo.VideoPackFlags(value)

Bases: GObject.GFlags

The different flags that can be used when packing and unpacking.

NONE = 0

No flag

TRUNCATE_RANGE = 1

When the source has a smaller depth than the target format, set the least significant bits of the target to 0. This is likely slightly faster but less accurate. When this flag is not specified, the most significant bits of the source are duplicated in the least significant bits of the destination.

INTERLACED = 2

The source is interlaced. The unpacked format will be interlaced as well with each line containing information from alternating fields.

New in version 1.2.

class GstVideo.VideoResamplerFlags(value)

Bases: GObject.GFlags

Different resampler flags.

New in version 1.6.

NONE = 0

no flags

HALF_TAPS = 1

when no taps are given, half the number of calculated taps. This can be used when making scalers for the different fields of an interlaced picture.

New in version 1.10.

class GstVideo.VideoScalerFlags(value)

Bases: GObject.GFlags

Different scale flags.

NONE = 0

no flags

INTERLACED = 1

Set up a scaler for interlaced content

class GstVideo.VideoTimeCodeFlags(value)

Bases: GObject.GFlags

Flags related to the time code information. For drop frame, only 30000/1001 and 60000/1001 frame rates are supported.

New in version 1.10.

NONE = 0

No flags

DROP_FRAME = 1

Whether we have drop frame rate

INTERLACED = 2

Whether we have interlaced video