@gtkx/ffi 0.11.1 → 0.12.0

package/dist/generated/gst/segment.d.ts

@@ -267,6 +267,19 @@ export declare class Segment extends NativeObject {
      *                is going backward. The `rate` value should never be `0.0`.
      */
     get rate(): number;
+    /**
+     * the playback rate of the segment is set in response to a seek
+     *                event and, without any seek, the value should be `1.0`. This
+     *                value is used by elements that synchronize buffer [running
+     *                times](additional/design/synchronisation.md#running-time) on
+     *                the clock (usually the sink elements), leading to consuming
+     *                buffers faster (for a value `> 1.0`) or slower (for `0.0 <
+     *                value < 1.0`) than normal playback speed. The rate also
+     *                defines the playback direction, meaning that when the value is
+     *                lower than `0.0`, the playback happens in reverse, and the
+     *                [stream-time](additional/design/synchronisation.md#stream-time)
+     *                is going backward. The `rate` value should never be `0.0`.
+     */
     set rate(value: number);
     /**
      * The applied rate is the rate that has been applied to the stream.
@@ -283,6 +296,20 @@ export declare class Segment extends NativeObject {
      *                rate=1.0 and applied_rate=<inputsegment.rate>.
      */
     get appliedRate(): number;
+    /**
+     * The applied rate is the rate that has been applied to the stream.
+     *                The effective/resulting playback rate of a stream is
+     *                `rate * applied_rate`.
+     *                The applied rate can be set by source elements when a server is
+     *                sending the stream with an already modified playback speed
+     *                rate. Filter elements that modify the stream in a way that
+     *                modifies the playback speed should also modify the applied
+     *                rate. For example the #videorate element when its
+     *                #videorate:rate property is set will set the applied rate of
+     *                the segment it pushed downstream. Also #scaletempo applies the
+     *                input segment rate to the stream and outputs a segment with
+     *                rate=1.0 and applied_rate=<inputsegment.rate>.
+     */
     set appliedRate(value: number);
     /** the unit used for all of the segment's values. */
     get format(): Format;
@@ -292,6 +319,11 @@ export declare class Segment extends NativeObject {
      *                rate < 0.0).
      */
     get base(): number;
+    /**
+     * the running time (plus elapsed time, see offset) of the
+     *                segment [start](GstSegment.start) ([stop](GstSegment.stop) if
+     *                rate < 0.0).
+     */
     set base(value: number);
     /**
      * the offset expresses the elapsed time (in buffer timestamps)
@@ -300,6 +332,12 @@ export declare class Segment extends NativeObject {
      *                of the segment at the time of the seek.
      */
     get offset(): number;
+    /**
+     * the offset expresses the elapsed time (in buffer timestamps)
+     *                before a seek with its start (stop if rate < 0.0) seek type
+     *                set to #GST_SEEK_TYPE_NONE, the value is set to the position
+     *                of the segment at the time of the seek.
+     */
     set offset(value: number);
     /**
      * the start time of the segment (in buffer timestamps)
@@ -310,6 +348,14 @@ export declare class Segment extends NativeObject {
      *                time.
      */
     get start(): number;
+    /**
+     * the start time of the segment (in buffer timestamps)
+     *                [(PTS)](GstBuffer.pts), that is the timestamp of the first
+     *                buffer to output inside the segment (last one during
+     *                reverse playback). For example decoders will
+     *                [clip](gst_segment_clip) out the buffers before the start
+     *                time.
+     */
     set start(value: number);
     /**
      * the stop time of the segment (in buffer timestamps)
@@ -319,12 +365,23 @@ export declare class Segment extends NativeObject {
      *                [clip](gst_segment_clip) out buffers after the stop time.
      */
     get stop(): number;
+    /**
+     * the stop time of the segment (in buffer timestamps)
+     *                [(PTS)](GstBuffer.pts), that is the timestamp of the last
+     *                buffer to output inside the segment (first one during
+     *                reverse playback). For example decoders will
+     *                [clip](gst_segment_clip) out buffers after the stop time.
+     */
     set stop(value: number);
     /**
      * the stream time of the segment [start](GstSegment.start)
      *                ([stop](GstSegment.stop) if rate < 0.0).
      */
     get time(): number;
+    /**
+     * the stream time of the segment [start](GstSegment.start)
+     *                ([stop](GstSegment.stop) if rate < 0.0).
+     */
     set time(value: number);
     /**
      * the buffer timestamp position in the segment is supposed to be
@@ -336,6 +393,15 @@ export declare class Segment extends NativeObject {
      *                updating the segment (see [offset](GstSegment.offset)).
      */
     get position(): number;
+    /**
+     * the buffer timestamp position in the segment is supposed to be
+     *                updated by elements such as sources, demuxers or parsers to
+     *                track progress by setting it to the last pushed buffer' end time
+     *                ([timestamp](GstBuffer.pts) + #GstBuffer.duration) for that
+     *                specific segment. The position is used when reconfiguring the
+     *                segment with #gst_segment_do_seek when the seek is only
+     *                updating the segment (see [offset](GstSegment.offset)).
+     */
     set position(value: number);
     /**
      * the duration of the segment is the maximum absolute difference
@@ -346,5 +412,13 @@ export declare class Segment extends NativeObject {
      *                seeking with #GST_SEEK_TYPE_END.
      */
     get duration(): number;
+    /**
+     * the duration of the segment is the maximum absolute difference
+     *                between #GstSegment.start and #GstSegment.stop if stop is not
+     *                set, otherwise it should be the difference between those
+     *                two values. This should be set by elements that know the
+     *                overall stream duration (like demuxers) and will be used when
+     *                seeking with #GST_SEEK_TYPE_END.
+     */
     set duration(value: number);
 }

package/dist/generated/gst/segment.js

@@ -62,9 +62,9 @@ export class Segment extends NativeObject {
      */
     constructor() {
         super();
-        this.id = call("libgstreamer-1.0.so.0", "gst_segment_new", [], {
+        this.handle = call("libgstreamer-1.0.so.0", "gst_segment_new", [], {
             type: "boxed",
-            ownership: "none",
+            ownership: "borrowed",
             innerType: "GstSegment",
             lib: "libgstreamer-1.0.so.0",
             getTypeFn: "gst_segment_get_type",
@@ -90,11 +90,12 @@ export class Segment extends NativeObject {
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
+                    getTypeFn: "gst_segment_get_type",
                 },
-                value: this.id,
+                value: this.handle,
             },
             {
                 type: {
@@ -158,11 +159,12 @@ export class Segment extends NativeObject {
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
+                    getTypeFn: "gst_segment_get_type",
                 },
-                value: this.id,
+                value: this.handle,
             },
         ], {
             type: "boxed",
@@ -179,21 +181,22 @@ export class Segment extends NativeObject {
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
+                    getTypeFn: "gst_segment_get_type",
                 },
-                value: this.id,
+                value: this.handle,
             },
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
                     getTypeFn: "gst_segment_get_type",
                 },
-                value: dest.id,
+                value: dest.handle,
             },
         ], {
             type: "undefined",
@@ -233,11 +236,12 @@ export class Segment extends NativeObject {
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
+                    getTypeFn: "gst_segment_get_type",
                 },
-                value: this.id,
+                value: this.handle,
             },
             {
                 type: {
@@ -314,11 +318,12 @@ export class Segment extends NativeObject {
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
+                    getTypeFn: "gst_segment_get_type",
                 },
-                value: this.id,
+                value: this.handle,
             },
         ], {
             type: "undefined",
@@ -336,11 +341,12 @@ export class Segment extends NativeObject {
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
+                    getTypeFn: "gst_segment_get_type",
                 },
-                value: this.id,
+                value: this.handle,
             },
             {
                 type: {
@@ -363,21 +369,22 @@ export class Segment extends NativeObject {
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
+                    getTypeFn: "gst_segment_get_type",
                 },
-                value: this.id,
+                value: this.handle,
             },
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
                     getTypeFn: "gst_segment_get_type",
                 },
-                value: s1.id,
+                value: s1.handle,
             },
         ], {
             type: "boolean",
@@ -392,11 +399,12 @@ export class Segment extends NativeObject {
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
+                    getTypeFn: "gst_segment_get_type",
                 },
-                value: this.id,
+                value: this.handle,
             },
             {
                 type: {
@@ -427,11 +435,12 @@ export class Segment extends NativeObject {
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
+                    getTypeFn: "gst_segment_get_type",
                 },
-                value: this.id,
+                value: this.handle,
             },
             {
                 type: {
@@ -478,11 +487,12 @@ export class Segment extends NativeObject {
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
+                    getTypeFn: "gst_segment_get_type",
                 },
-                value: this.id,
+                value: this.handle,
             },
             {
                 type: {
@@ -526,11 +536,12 @@ export class Segment extends NativeObject {
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
+                    getTypeFn: "gst_segment_get_type",
                 },
-                value: this.id,
+                value: this.handle,
             },
             {
                 type: {
@@ -576,11 +587,12 @@ export class Segment extends NativeObject {
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
+                    getTypeFn: "gst_segment_get_type",
                 },
-                value: this.id,
+                value: this.handle,
             },
             {
                 type: {
@@ -624,11 +636,12 @@ export class Segment extends NativeObject {
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
+                    getTypeFn: "gst_segment_get_type",
                 },
-                value: this.id,
+                value: this.handle,
             },
             {
                 type: {
@@ -659,11 +672,12 @@ export class Segment extends NativeObject {
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
+                    getTypeFn: "gst_segment_get_type",
                 },
-                value: this.id,
+                value: this.handle,
             },
             {
                 type: {
@@ -703,11 +717,12 @@ export class Segment extends NativeObject {
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
+                    getTypeFn: "gst_segment_get_type",
                 },
-                value: this.id,
+                value: this.handle,
             },
             {
                 type: {
@@ -753,11 +768,12 @@ export class Segment extends NativeObject {
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
+                    getTypeFn: "gst_segment_get_type",
                 },
-                value: this.id,
+                value: this.handle,
             },
             {
                 type: {
@@ -810,11 +826,12 @@ export class Segment extends NativeObject {
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
+                    getTypeFn: "gst_segment_get_type",
                 },
-                value: this.id,
+                value: this.handle,
             },
             {
                 type: {
@@ -860,11 +877,12 @@ export class Segment extends NativeObject {
             {
                 type: {
                     type: "boxed",
-                    ownership: "none",
+                    ownership: "borrowed",
                     innerType: "GstSegment",
                     lib: "libgstreamer-1.0.so.0",
+                    getTypeFn: "gst_segment_get_type",
                 },
-                value: this.id,
+                value: this.handle,
             },
             {
                 type: {
@@ -901,7 +919,7 @@ export class Segment extends NativeObject {
     }
     /** flags for this segment */
     get flags() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 32,
             unsigned: true,
@@ -921,13 +939,26 @@ export class Segment extends NativeObject {
      *                is going backward. The `rate` value should never be `0.0`.
      */
     get rate() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "float",
             size: 64,
         }, 8);
     }
+    /**
+     * the playback rate of the segment is set in response to a seek
+     *                event and, without any seek, the value should be `1.0`. This
+     *                value is used by elements that synchronize buffer [running
+     *                times](additional/design/synchronisation.md#running-time) on
+     *                the clock (usually the sink elements), leading to consuming
+     *                buffers faster (for a value `> 1.0`) or slower (for `0.0 <
+     *                value < 1.0`) than normal playback speed. The rate also
+     *                defines the playback direction, meaning that when the value is
+     *                lower than `0.0`, the playback happens in reverse, and the
+     *                [stream-time](additional/design/synchronisation.md#stream-time)
+     *                is going backward. The `rate` value should never be `0.0`.
+     */
     set rate(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "float",
             size: 64,
         }, 8, value);
@@ -947,20 +978,34 @@ export class Segment extends NativeObject {
      *                rate=1.0 and applied_rate=<inputsegment.rate>.
      */
     get appliedRate() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "float",
             size: 64,
         }, 16);
     }
+    /**
+     * The applied rate is the rate that has been applied to the stream.
+     *                The effective/resulting playback rate of a stream is
+     *                `rate * applied_rate`.
+     *                The applied rate can be set by source elements when a server is
+     *                sending the stream with an already modified playback speed
+     *                rate. Filter elements that modify the stream in a way that
+     *                modifies the playback speed should also modify the applied
+     *                rate. For example the #videorate element when its
+     *                #videorate:rate property is set will set the applied rate of
+     *                the segment it pushed downstream. Also #scaletempo applies the
+     *                input segment rate to the stream and outputs a segment with
+     *                rate=1.0 and applied_rate=<inputsegment.rate>.
+     */
     set appliedRate(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "float",
             size: 64,
         }, 16, value);
     }
     /** the unit used for all of the segment's values. */
     get format() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 32,
             unsigned: false,
@@ -972,14 +1017,19 @@ export class Segment extends NativeObject {
      *                rate < 0.0).
      */
     get base() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 64,
             unsigned: true,
         }, 32);
     }
+    /**
+     * the running time (plus elapsed time, see offset) of the
+     *                segment [start](GstSegment.start) ([stop](GstSegment.stop) if
+     *                rate < 0.0).
+     */
     set base(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 64,
             unsigned: true,
@@ -992,14 +1042,20 @@ export class Segment extends NativeObject {
      *                of the segment at the time of the seek.
      */
     get offset() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 64,
             unsigned: true,
         }, 40);
     }
+    /**
+     * the offset expresses the elapsed time (in buffer timestamps)
+     *                before a seek with its start (stop if rate < 0.0) seek type
+     *                set to #GST_SEEK_TYPE_NONE, the value is set to the position
+     *                of the segment at the time of the seek.
+     */
     set offset(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 64,
             unsigned: true,
@@ -1014,14 +1070,22 @@ export class Segment extends NativeObject {
      *                time.
      */
     get start() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 64,
             unsigned: true,
         }, 48);
     }
+    /**
+     * the start time of the segment (in buffer timestamps)
+     *                [(PTS)](GstBuffer.pts), that is the timestamp of the first
+     *                buffer to output inside the segment (last one during
+     *                reverse playback). For example decoders will
+     *                [clip](gst_segment_clip) out the buffers before the start
+     *                time.
+     */
     set start(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 64,
             unsigned: true,
@@ -1035,14 +1099,21 @@ export class Segment extends NativeObject {
      *                [clip](gst_segment_clip) out buffers after the stop time.
      */
     get stop() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 64,
             unsigned: true,
         }, 56);
     }
+    /**
+     * the stop time of the segment (in buffer timestamps)
+     *                [(PTS)](GstBuffer.pts), that is the timestamp of the last
+     *                buffer to output inside the segment (first one during
+     *                reverse playback). For example decoders will
+     *                [clip](gst_segment_clip) out buffers after the stop time.
+     */
     set stop(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 64,
             unsigned: true,
@@ -1053,14 +1124,18 @@ export class Segment extends NativeObject {
      *                ([stop](GstSegment.stop) if rate < 0.0).
      */
     get time() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 64,
             unsigned: true,
         }, 64);
     }
+    /**
+     * the stream time of the segment [start](GstSegment.start)
+     *                ([stop](GstSegment.stop) if rate < 0.0).
+     */
     set time(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 64,
             unsigned: true,
@@ -1076,14 +1151,23 @@ export class Segment extends NativeObject {
      *                updating the segment (see [offset](GstSegment.offset)).
      */
     get position() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 64,
             unsigned: true,
         }, 72);
     }
+    /**
+     * the buffer timestamp position in the segment is supposed to be
+     *                updated by elements such as sources, demuxers or parsers to
+     *                track progress by setting it to the last pushed buffer' end time
+     *                ([timestamp](GstBuffer.pts) + #GstBuffer.duration) for that
+     *                specific segment. The position is used when reconfiguring the
+     *                segment with #gst_segment_do_seek when the seek is only
+     *                updating the segment (see [offset](GstSegment.offset)).
+     */
     set position(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 64,
             unsigned: true,
@@ -1098,14 +1182,22 @@ export class Segment extends NativeObject {
      *                seeking with #GST_SEEK_TYPE_END.
      */
     get duration() {
-        return read(this.id, {
+        return read(this.handle, {
             type: "int",
             size: 64,
             unsigned: true,
         }, 80);
     }
+    /**
+     * the duration of the segment is the maximum absolute difference
+     *                between #GstSegment.start and #GstSegment.stop if stop is not
+     *                set, otherwise it should be the difference between those
+     *                two values. This should be set by elements that know the
+     *                overall stream duration (like demuxers) and will be used when
+     *                seeking with #GST_SEEK_TYPE_END.
+     */
     set duration(value) {
-        write(this.id, {
+        write(this.handle, {
             type: "int",
             size: 64,
             unsigned: true,