Class Structure

The GstStructure object. Most fields are private.

record

Hierarchy

Structure

Constructors

constructor

new Structure(): Gst.Structure

Returns Gst.Structure

Properties

_gst_reserved

_gst_reserved: object

fields

fields: GLib.Array

name

name: number

parent_refcount

parent_refcount: number

type

type: GType<unknown>

Static name

name: string

Methods

copy

copy(): Gst.Structure

- Defined in @types/Gjs/Gst-0.10.d.ts:6513
Returns Gst.Structure

fixate_field_boolean

fixate_field_boolean(field_name: string, target: boolean): boolean

- Defined in @types/Gjs/Gst-0.10.d.ts:6548
Parameters
- field_name: string
- target: boolean
Returns boolean

fixate_field_nearest_double

fixate_field_nearest_double(field_name: string, target: number): boolean

- Defined in @types/Gjs/Gst-0.10.d.ts:6547
Parameters
- field_name: string
- target: number
Returns boolean

fixate_field_nearest_fraction

fixate_field_nearest_fraction(field_name: string, target_numerator: number, target_denominator: number): boolean

- Defined in @types/Gjs/Gst-0.10.d.ts:6550
Parameters
- field_name: string
- target_numerator: number
- target_denominator: number
Returns boolean

fixate_field_nearest_int

fixate_field_nearest_int(field_name: string, target: number): boolean

- Defined in @types/Gjs/Gst-0.10.d.ts:6546
Parameters
- field_name: string
- target: number
Returns boolean

fixate_field_string

fixate_field_string(field_name: string, target: string): boolean

- Defined in @types/Gjs/Gst-0.10.d.ts:6549
Parameters
- field_name: string
- target: string
Returns boolean

foreach

foreach(func: Gst.StructureForeachFunc, user_data: object): boolean

- Defined in @types/Gjs/Gst-0.10.d.ts:6527
Parameters
- func: Gst.StructureForeachFunc
- user_data: object
Returns boolean

free

free(): void

- Defined in @types/Gjs/Gst-0.10.d.ts:6515
Returns void

get_boolean

get_boolean(fieldname: string): [boolean, boolean]

- Defined in @types/Gjs/Gst-0.10.d.ts:6535
Parameters
- fieldname: string
Returns [boolean, boolean]

get_clock_time

get_clock_time(fieldname: string, value: any): boolean

- Defined in @types/Gjs/Gst-0.10.d.ts:6541
Parameters
- fieldname: string
- value: any
Returns boolean

get_date

get_date(fieldname: string, value: GLib.Date): boolean

- Defined in @types/Gjs/Gst-0.10.d.ts:6540
Parameters
- fieldname: string
- value: GLib.Date
Returns boolean

get_double

get_double(fieldname: string): [boolean, number]

- Defined in @types/Gjs/Gst-0.10.d.ts:6539
Parameters
- fieldname: string
Returns [boolean, number]

get_enum

get_enum(fieldname: string, enumtype: GType<unknown>): [boolean, number]

- Defined in @types/Gjs/Gst-0.10.d.ts:6543
Parameters
- fieldname: string
- enumtype: GType<unknown>
Returns [boolean, number]

get_field_type

get_field_type(fieldname: string): GType<unknown>

- Defined in @types/Gjs/Gst-0.10.d.ts:6526
Parameters
- fieldname: string
Returns GType<unknown>

get_fourcc

get_fourcc(fieldname: string): [boolean, number]

- Defined in @types/Gjs/Gst-0.10.d.ts:6538
Parameters
- fieldname: string
Returns [boolean, number]

get_fraction

get_fraction(fieldname: string): [boolean, number, number]

- Defined in @types/Gjs/Gst-0.10.d.ts:6544
Parameters
- fieldname: string
Returns [boolean, number, number]

get_int

get_int(fieldname: string): [boolean, number]

- Defined in @types/Gjs/Gst-0.10.d.ts:6536
Parameters
- fieldname: string
Returns [boolean, number]

get_name

get_name(): string

- Defined in @types/Gjs/Gst-0.10.d.ts:6516
Returns string

get_name_id

get_name_id(): number

- Defined in @types/Gjs/Gst-0.10.d.ts:6517
Returns number

get_string

get_string(fieldname: string): string

- Defined in @types/Gjs/Gst-0.10.d.ts:6542
Parameters
- fieldname: string
Returns string

get_uint

get_uint(fieldname: string): [boolean, number]

- Defined in @types/Gjs/Gst-0.10.d.ts:6537
Parameters
- fieldname: string
Returns [boolean, number]

get_value

get_value(fieldname: string): any

- Defined in @types/Gjs/Gst-0.10.d.ts:6523
Parameters
- fieldname: string
Returns any

has_field

has_field(fieldname: string): boolean

- Defined in @types/Gjs/Gst-0.10.d.ts:6533
Parameters
- fieldname: string
Returns boolean

has_field_typed

has_field_typed(fieldname: string, type: GType<unknown>): boolean

- Defined in @types/Gjs/Gst-0.10.d.ts:6534
Parameters
- fieldname: string
- type: GType<unknown>
Returns boolean

has_name

has_name(name: string): boolean

- Defined in @types/Gjs/Gst-0.10.d.ts:6518
Parameters
- name: string
Returns boolean

id_get_value

id_get_value(field: number): any

- Defined in @types/Gjs/Gst-0.10.d.ts:6522
Parameters
- field: number
Returns any

id_has_field

id_has_field(field: number): boolean

- Defined in @types/Gjs/Gst-0.10.d.ts:6531
Parameters
- field: number
Returns boolean

id_has_field_typed

id_has_field_typed(field: number, type: GType<unknown>): boolean

- Defined in @types/Gjs/Gst-0.10.d.ts:6532
Parameters
- field: number
- type: GType<unknown>
Returns boolean

id_set_value

id_set_value(field: number, value: any): void

- Defined in @types/Gjs/Gst-0.10.d.ts:6520
Parameters
- field: number
- value: any
Returns void

map_in_place

map_in_place(func: Gst.StructureMapFunc, user_data: object): boolean

- Defined in @types/Gjs/Gst-0.10.d.ts:6528
Parameters
- func: Gst.StructureMapFunc
- user_data: object
Returns boolean

n_fields

n_fields(): number

- Defined in @types/Gjs/Gst-0.10.d.ts:6529
Returns number

nth_field_name

nth_field_name(index: number): string

- Defined in @types/Gjs/Gst-0.10.d.ts:6530
Parameters
- index: number
Returns string

remove_all_fields

remove_all_fields(): void

- Defined in @types/Gjs/Gst-0.10.d.ts:6525
Returns void

remove_field

remove_field(fieldname: string): void

- Defined in @types/Gjs/Gst-0.10.d.ts:6524
Parameters
- fieldname: string
Returns void

set_name

set_name(name: string): void

- Defined in @types/Gjs/Gst-0.10.d.ts:6519
Parameters
- name: string
Returns void

set_parent_refcount

set_parent_refcount(): number

- Defined in @types/Gjs/Gst-0.10.d.ts:6514
Returns number

set_value

set_value(fieldname: string, value: any): void

- Defined in @types/Gjs/Gst-0.10.d.ts:6521
Parameters
- fieldname: string
- value: any
Returns void

to_string

to_string(): string

- Defined in @types/Gjs/Gst-0.10.d.ts:6545
Returns string