@girs/farstream-0.2 0.2.0-3.2.4 → 0.2.0-3.2.6

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/farstream-0.2)
 
 
-GJS TypeScript type definitions for Farstream-0.2, generated from library version 0.2.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.4.
+GJS TypeScript type definitions for Farstream-0.2, generated from library version 0.2.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.6.
 
 
 ## Install
@@ -81,6 +81,19 @@ Now you have also type support for this, too:
 const Farstream = imports.gi.Farstream;
 ```
 
+
+### ESM vs. CommonJS
+
+GJS supports two different import syntaxes. The new modern ESM syntax and the old global imports syntax.
+
+In TypeScript projects for GJS and GNOME Shell extensions, you have the flexibility to use `ESM` syntax and then decide the import syntax for your bundled file. If your bundler is configured to use `CommonJS`, it will convert to the GJS-specific global imports syntax, like `const moduleName = imports.gi[moduleName]`. This is different from the traditional `require` syntax seen in Node.js. The global imports syntax is chosen because it aligns with the CommonJS format supported by NPM, which is used for the generated type definitions and this package.
+
+On the other hand, if you configure your bundler to use ESM, it will retain the ESM import syntax. It's crucial to ensure that your bundler is set up to correctly translate and bundle these imports into either CommonJS or ESM format, depending on your project's requirements.
+
+This approach is particularly important due to the `@girs` types, which include both `*.cjs `files, using the GJS global imports syntax, and `*.js` files, which utilize the ESM syntax. By appropriately setting up your bundler, you can control which syntax—CommonJS or ESM—is used in your project. The choice of CommonJS in this context is also due to the similarity between the GJS-specific global imports and CommonJS syntax, allowing for easier management and bundling in these specific types of projects.
+
+Since GNOME Shell 45, you should only use ESM, even for GNOME Shell extensions. Before that, extensions had to use the global import syntax, unlike normal GJS applications, where ESM has been available for some time.
+
 ### Bundle
 
 Depending on your project configuration, it is recommended to use a bundler like [esbuild](https://esbuild.github.io/). You can find examples using different bundlers [here](https://github.com/gjsify/ts-for-gir/tree/main/examples).

package/farstream-0.2-ambient.d.ts

@@ -1,9 +1,12 @@
 
-
 declare module 'gi://Farstream?version=0.2' {
     import Farstream02 from '@girs/farstream-0.2';
     export default Farstream02;
 }
 
+declare module 'gi://Farstream' {
+    import Farstream02 from '@girs/farstream-0.2';
+    export default Farstream02;
+}
 
 

package/farstream-0.2-import.d.ts

@@ -1,5 +1,4 @@
 
-
 import Farstream02 from '@girs/farstream-0.2';
 
 declare global {

package/farstream-0.2.d.cts

@@ -856,6 +856,11 @@ export module Session {
          * Sets the IP ToS field (and if possible the IPv6 TCLASS field
          */
         tos?: number | null
+        /**
+         * The media-type of the session. This is either Audio, Video or both.
+         * This is a constructor parameter that cannot be changed.
+         */
+        mediaType?: MediaType | null
     }
 
 }
@@ -870,12 +875,24 @@ export interface Session {
      * accepted those caps as input.
      */
     readonly allowed_sink_caps: Gst.Caps
+    /**
+     * These are the #GstCaps that can be fed into the session,
+     * they are used to filter the codecs to only those that can
+     * accepted those caps as input.
+     */
+    readonly allowedSinkCaps: Gst.Caps
     /**
      * These are the #GstCaps that the session can produce,
      * they are used to filter the codecs to only those that can
      * accepted those caps as output.
      */
     readonly allowed_src_caps: Gst.Caps
+    /**
+     * These are the #GstCaps that the session can produce,
+     * they are used to filter the codecs to only those that can
+     * accepted those caps as output.
+     */
+    readonly allowedSrcCaps: Gst.Caps
     /**
      * This is the current preferences list for the local codecs. It is
      * set by the user to specify the codec options and priorities. The user may
@@ -889,6 +906,19 @@ export interface Session {
      * dynamically assigned payload type.
      */
     readonly codec_preferences: Codec[]
+    /**
+     * This is the current preferences list for the local codecs. It is
+     * set by the user to specify the codec options and priorities. The user may
+     * change its value with fs_session_set_codec_preferences() at any time
+     * during a session. It is a #GList of #FsCodec.
+     * The user must free this codec list using fs_codec_list_destroy() when done.
+     * 
+     * The payload type may be a valid dynamic PT (96-127), %FS_CODEC_ID_DISABLE
+     * or %FS_CODEC_ID_ANY. If the encoding name is "reserve-pt", then the
+     * payload type of the codec will be "reserved" and not be used by any
+     * dynamically assigned payload type.
+     */
+    readonly codecPreferences: Codec[]
     /**
      * This is the list of codecs used for this session. It will include the
      * codecs and payload type used to receive media on this session. It will
@@ -928,6 +958,25 @@ export interface Session {
      * fs_codec_list_destroy() when done.
      */
     readonly codecs_without_config: Codec[]
+    /**
+     * This is the same list of codecs as #FsSession:codecs without
+     * the configuration information that describes the data sent. It is suitable
+     * for configurations where a list of codecs is shared by many senders.
+     * If one is using codecs such as Theora, Vorbis or H.264 that require
+     * such information to be transmitted, the configuration data should be
+     * included in the stream and retransmitted regularly.
+     * 
+     * It may change when the codec preferences are set, when codecs are set
+     * on a #FsStream in this session, when a #FsStream is destroyed or
+     * asynchronously when new config data is discovered.
+     * 
+     * The "farstream-codecs-changed" message will be emitted whenever the value
+     * of this property changes.
+     * 
+     * It is a #GList of #FsCodec. User must free this codec list using
+     * fs_codec_list_destroy() when done.
+     */
+    readonly codecsWithoutConfig: Codec[]
     /**
      * The #FsConference parent of this session. This property is a
      * construct param and is read-only.
@@ -942,10 +991,23 @@ export interface Session {
      * the value of this property changes.
      */
     readonly current_send_codec: Codec
+    /**
+     * Indicates the currently active send codec. A user can change the active
+     * send codec by calling fs_session_set_send_codec(). The send codec could
+     * also be automatically changed by Farstream. This property is an
+     * #FsCodec. User must free the codec using fs_codec_destroy() when done.
+     * The "farstream-send-codec-changed" message is emitted on the bus when
+     * the value of this property changes.
+     */
+    readonly currentSendCodec: Codec
     /**
      * Retrieves previously set encryption parameters
      */
     readonly encryption_parameters: Gst.Structure
+    /**
+     * Retrieves previously set encryption parameters
+     */
+    readonly encryptionParameters: Gst.Structure
     /**
      * The ID of the session, the first number of the pads linked to this session
      * will be this id
@@ -956,11 +1018,21 @@ export interface Session {
      * This is a constructor parameter that cannot be changed.
      */
     readonly media_type: MediaType
+    /**
+     * The media-type of the session. This is either Audio, Video or both.
+     * This is a constructor parameter that cannot be changed.
+     */
+    readonly mediaType: MediaType
     /**
      * The Gstreamer sink pad that must be used to send media data on this
      * session. User must unref this GstPad when done with it.
      */
     readonly sink_pad: Gst.Pad
+    /**
+     * The Gstreamer sink pad that must be used to send media data on this
+     * session. User must unref this GstPad when done with it.
+     */
+    readonly sinkPad: Gst.Pad
     /**
      * Sets the IP ToS field (and if possible the IPv6 TCLASS field
      */
@@ -1370,10 +1442,25 @@ export interface Stream {
      * will come to it is different.
      */
     readonly current_recv_codecs: Codec[]
+    /**
+     * This is the list of codecs that have been received by this stream.
+     * The user must free the list if fs_codec_list_destroy().
+     * The "farstream-recv-codecs-changed" message is send on the #GstBus
+     * when the value of this property changes.
+     * It is normally emitted right after #FsStream::src-pad-added
+     * only if that codec was not previously received in this stream, but it can
+     * also be emitted if the pad already exists, but the source material that
+     * will come to it is different.
+     */
+    readonly currentRecvCodecs: Codec[]
     /**
      * Retrieves previously set decryption parameters
      */
     readonly decryption_parameters: Gst.Structure
+    /**
+     * Retrieves previously set decryption parameters
+     */
+    readonly decryptionParameters: Gst.Structure
     /**
      * The direction of the stream. This property is set initially as a parameter
      * to the fs_session_new_stream() function. It can be changed later if
@@ -1388,6 +1475,14 @@ export interface Stream {
      * It is a #GList of #FsCodec.
      */
     readonly negotiated_codecs: Codec[]
+    /**
+     * This is the list of negotiatied codecs, it is the same list as the list
+     * of #FsCodec from the parent #FsSession, except that the codec config data
+     * has been replaced with the data from the remote codecs for this stream.
+     * This is the list of #FsCodec used to receive data from this stream.
+     * It is a #GList of #FsCodec.
+     */
+    readonly negotiatedCodecs: Codec[]
     /**
      * The #FsParticipant for this stream. This property is a construct param and
      * is read-only construction.
@@ -1399,6 +1494,12 @@ export interface Stream {
      * (generally through external signaling). It is a #GList of #FsCodec.
      */
     readonly remote_codecs: Codec[]
+    /**
+     * This is the list of remote codecs for this stream. They must be set by the
+     * user as soon as they are known using fs_stream_set_remote_codecs()
+     * (generally through external signaling). It is a #GList of #FsCodec.
+     */
+    readonly remoteCodecs: Codec[]
     /**
      * The #FsSession for this stream. This property is a construct param and
      * is read-only construction.
@@ -1742,6 +1843,12 @@ export module StreamTransmitter {
          * A network source #GstElement to be used by the #FsSession
          */
         sending?: boolean | null
+        /**
+         * This tells the stream transmitter to associate incoming data with this
+         * based on the source without looking at the content if possible.
+         */
+        associateOnSource?: boolean | null
+        preferredLocalCandidates?: any | null
     }
 
 }
@@ -1755,7 +1862,13 @@ export interface StreamTransmitter {
      * based on the source without looking at the content if possible.
      */
     readonly associate_on_source: boolean
+    /**
+     * This tells the stream transmitter to associate incoming data with this
+     * based on the source without looking at the content if possible.
+     */
+    readonly associateOnSource: boolean
     readonly preferred_local_candidates: any
+    readonly preferredLocalCandidates: any
     /**
      * A network source #GstElement to be used by the #FsSession
      */
@@ -1920,6 +2033,11 @@ export module Transmitter {
          * Sets the IP ToS field (and if possible the IPv6 TCLASS field
          */
         tos?: number | null
+        /**
+         * Apply current stream time to buffers or provide buffers without
+         * timestamps. Must be set before creating a stream transmitter.
+         */
+        doTimestamp?: boolean | null
     }
 
 }
@@ -1937,6 +2055,11 @@ export interface Transmitter {
      * timestamps. Must be set before creating a stream transmitter.
      */
     do_timestamp: boolean
+    /**
+     * Apply current stream time to buffers or provide buffers without
+     * timestamps. Must be set before creating a stream transmitter.
+     */
+    doTimestamp: boolean
     /**
      * A network source #GstElement to be used by the #FsSession
      * These element's sink must have async=FALSE
@@ -1946,6 +2069,15 @@ export interface Transmitter {
      * These pads MUST be static pads.
      */
     readonly gst_sink: Gst.Element
+    /**
+     * A network source #GstElement to be used by the #FsSession
+     * These element's sink must have async=FALSE
+     * This element MUST provide a pad named "sink_\%u" per component.
+     * These pads number must start at 1 (the \%u corresponds to the component
+     * number).
+     * These pads MUST be static pads.
+     */
+    readonly gstSink: Gst.Element
     /**
      * A network source #GstElement to be used by the #FsSession
      * This element MUST provide a source pad named "src_%u" per component.
@@ -1954,6 +2086,14 @@ export interface Transmitter {
      * These pads MUST be static pads.
      */
     readonly gst_src: Gst.Element
+    /**
+     * A network source #GstElement to be used by the #FsSession
+     * This element MUST provide a source pad named "src_%u" per component.
+     * These pads number must start at 1 (the %u corresponds to the component
+     * number).
+     * These pads MUST be static pads.
+     */
+    readonly gstSrc: Gst.Element
     /**
      * Sets the IP ToS field (and if possible the IPv6 TCLASS field
      */

package/farstream-0.2.d.ts

@@ -858,6 +858,11 @@ module Session {
          * Sets the IP ToS field (and if possible the IPv6 TCLASS field
          */
         tos?: number | null
+        /**
+         * The media-type of the session. This is either Audio, Video or both.
+         * This is a constructor parameter that cannot be changed.
+         */
+        mediaType?: MediaType | null
     }
 
 }
@@ -872,12 +877,24 @@ interface Session {
      * accepted those caps as input.
      */
     readonly allowed_sink_caps: Gst.Caps
+    /**
+     * These are the #GstCaps that can be fed into the session,
+     * they are used to filter the codecs to only those that can
+     * accepted those caps as input.
+     */
+    readonly allowedSinkCaps: Gst.Caps
     /**
      * These are the #GstCaps that the session can produce,
      * they are used to filter the codecs to only those that can
      * accepted those caps as output.
      */
     readonly allowed_src_caps: Gst.Caps
+    /**
+     * These are the #GstCaps that the session can produce,
+     * they are used to filter the codecs to only those that can
+     * accepted those caps as output.
+     */
+    readonly allowedSrcCaps: Gst.Caps
     /**
      * This is the current preferences list for the local codecs. It is
      * set by the user to specify the codec options and priorities. The user may
@@ -891,6 +908,19 @@ interface Session {
      * dynamically assigned payload type.
      */
     readonly codec_preferences: Codec[]
+    /**
+     * This is the current preferences list for the local codecs. It is
+     * set by the user to specify the codec options and priorities. The user may
+     * change its value with fs_session_set_codec_preferences() at any time
+     * during a session. It is a #GList of #FsCodec.
+     * The user must free this codec list using fs_codec_list_destroy() when done.
+     * 
+     * The payload type may be a valid dynamic PT (96-127), %FS_CODEC_ID_DISABLE
+     * or %FS_CODEC_ID_ANY. If the encoding name is "reserve-pt", then the
+     * payload type of the codec will be "reserved" and not be used by any
+     * dynamically assigned payload type.
+     */
+    readonly codecPreferences: Codec[]
     /**
      * This is the list of codecs used for this session. It will include the
      * codecs and payload type used to receive media on this session. It will
@@ -930,6 +960,25 @@ interface Session {
      * fs_codec_list_destroy() when done.
      */
     readonly codecs_without_config: Codec[]
+    /**
+     * This is the same list of codecs as #FsSession:codecs without
+     * the configuration information that describes the data sent. It is suitable
+     * for configurations where a list of codecs is shared by many senders.
+     * If one is using codecs such as Theora, Vorbis or H.264 that require
+     * such information to be transmitted, the configuration data should be
+     * included in the stream and retransmitted regularly.
+     * 
+     * It may change when the codec preferences are set, when codecs are set
+     * on a #FsStream in this session, when a #FsStream is destroyed or
+     * asynchronously when new config data is discovered.
+     * 
+     * The "farstream-codecs-changed" message will be emitted whenever the value
+     * of this property changes.
+     * 
+     * It is a #GList of #FsCodec. User must free this codec list using
+     * fs_codec_list_destroy() when done.
+     */
+    readonly codecsWithoutConfig: Codec[]
     /**
      * The #FsConference parent of this session. This property is a
      * construct param and is read-only.
@@ -944,10 +993,23 @@ interface Session {
      * the value of this property changes.
      */
     readonly current_send_codec: Codec
+    /**
+     * Indicates the currently active send codec. A user can change the active
+     * send codec by calling fs_session_set_send_codec(). The send codec could
+     * also be automatically changed by Farstream. This property is an
+     * #FsCodec. User must free the codec using fs_codec_destroy() when done.
+     * The "farstream-send-codec-changed" message is emitted on the bus when
+     * the value of this property changes.
+     */
+    readonly currentSendCodec: Codec
     /**
      * Retrieves previously set encryption parameters
      */
     readonly encryption_parameters: Gst.Structure
+    /**
+     * Retrieves previously set encryption parameters
+     */
+    readonly encryptionParameters: Gst.Structure
     /**
      * The ID of the session, the first number of the pads linked to this session
      * will be this id
@@ -958,11 +1020,21 @@ interface Session {
      * This is a constructor parameter that cannot be changed.
      */
     readonly media_type: MediaType
+    /**
+     * The media-type of the session. This is either Audio, Video or both.
+     * This is a constructor parameter that cannot be changed.
+     */
+    readonly mediaType: MediaType
     /**
      * The Gstreamer sink pad that must be used to send media data on this
      * session. User must unref this GstPad when done with it.
      */
     readonly sink_pad: Gst.Pad
+    /**
+     * The Gstreamer sink pad that must be used to send media data on this
+     * session. User must unref this GstPad when done with it.
+     */
+    readonly sinkPad: Gst.Pad
     /**
      * Sets the IP ToS field (and if possible the IPv6 TCLASS field
      */
@@ -1372,10 +1444,25 @@ interface Stream {
      * will come to it is different.
      */
     readonly current_recv_codecs: Codec[]
+    /**
+     * This is the list of codecs that have been received by this stream.
+     * The user must free the list if fs_codec_list_destroy().
+     * The "farstream-recv-codecs-changed" message is send on the #GstBus
+     * when the value of this property changes.
+     * It is normally emitted right after #FsStream::src-pad-added
+     * only if that codec was not previously received in this stream, but it can
+     * also be emitted if the pad already exists, but the source material that
+     * will come to it is different.
+     */
+    readonly currentRecvCodecs: Codec[]
     /**
      * Retrieves previously set decryption parameters
      */
     readonly decryption_parameters: Gst.Structure
+    /**
+     * Retrieves previously set decryption parameters
+     */
+    readonly decryptionParameters: Gst.Structure
     /**
      * The direction of the stream. This property is set initially as a parameter
      * to the fs_session_new_stream() function. It can be changed later if
@@ -1390,6 +1477,14 @@ interface Stream {
      * It is a #GList of #FsCodec.
      */
     readonly negotiated_codecs: Codec[]
+    /**
+     * This is the list of negotiatied codecs, it is the same list as the list
+     * of #FsCodec from the parent #FsSession, except that the codec config data
+     * has been replaced with the data from the remote codecs for this stream.
+     * This is the list of #FsCodec used to receive data from this stream.
+     * It is a #GList of #FsCodec.
+     */
+    readonly negotiatedCodecs: Codec[]
     /**
      * The #FsParticipant for this stream. This property is a construct param and
      * is read-only construction.
@@ -1401,6 +1496,12 @@ interface Stream {
      * (generally through external signaling). It is a #GList of #FsCodec.
      */
     readonly remote_codecs: Codec[]
+    /**
+     * This is the list of remote codecs for this stream. They must be set by the
+     * user as soon as they are known using fs_stream_set_remote_codecs()
+     * (generally through external signaling). It is a #GList of #FsCodec.
+     */
+    readonly remoteCodecs: Codec[]
     /**
      * The #FsSession for this stream. This property is a construct param and
      * is read-only construction.
@@ -1744,6 +1845,12 @@ module StreamTransmitter {
          * A network source #GstElement to be used by the #FsSession
          */
         sending?: boolean | null
+        /**
+         * This tells the stream transmitter to associate incoming data with this
+         * based on the source without looking at the content if possible.
+         */
+        associateOnSource?: boolean | null
+        preferredLocalCandidates?: any | null
     }
 
 }
@@ -1757,7 +1864,13 @@ interface StreamTransmitter {
      * based on the source without looking at the content if possible.
      */
     readonly associate_on_source: boolean
+    /**
+     * This tells the stream transmitter to associate incoming data with this
+     * based on the source without looking at the content if possible.
+     */
+    readonly associateOnSource: boolean
     readonly preferred_local_candidates: any
+    readonly preferredLocalCandidates: any
     /**
      * A network source #GstElement to be used by the #FsSession
      */
@@ -1922,6 +2035,11 @@ module Transmitter {
          * Sets the IP ToS field (and if possible the IPv6 TCLASS field
          */
         tos?: number | null
+        /**
+         * Apply current stream time to buffers or provide buffers without
+         * timestamps. Must be set before creating a stream transmitter.
+         */
+        doTimestamp?: boolean | null
     }
 
 }
@@ -1939,6 +2057,11 @@ interface Transmitter {
      * timestamps. Must be set before creating a stream transmitter.
      */
     do_timestamp: boolean
+    /**
+     * Apply current stream time to buffers or provide buffers without
+     * timestamps. Must be set before creating a stream transmitter.
+     */
+    doTimestamp: boolean
     /**
      * A network source #GstElement to be used by the #FsSession
      * These element's sink must have async=FALSE
@@ -1948,6 +2071,15 @@ interface Transmitter {
      * These pads MUST be static pads.
      */
     readonly gst_sink: Gst.Element
+    /**
+     * A network source #GstElement to be used by the #FsSession
+     * These element's sink must have async=FALSE
+     * This element MUST provide a pad named "sink_\%u" per component.
+     * These pads number must start at 1 (the \%u corresponds to the component
+     * number).
+     * These pads MUST be static pads.
+     */
+    readonly gstSink: Gst.Element
     /**
      * A network source #GstElement to be used by the #FsSession
      * This element MUST provide a source pad named "src_%u" per component.
@@ -1956,6 +2088,14 @@ interface Transmitter {
      * These pads MUST be static pads.
      */
     readonly gst_src: Gst.Element
+    /**
+     * A network source #GstElement to be used by the #FsSession
+     * This element MUST provide a source pad named "src_%u" per component.
+     * These pads number must start at 1 (the %u corresponds to the component
+     * number).
+     * These pads MUST be static pads.
+     */
+    readonly gstSrc: Gst.Element
     /**
      * Sets the IP ToS field (and if possible the IPv6 TCLASS field
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@girs/farstream-0.2",
-  "version": "0.2.0-3.2.4",
+  "version": "0.2.0-3.2.6",
   "description": "GJS TypeScript type definitions for Farstream-0.2, generated from library version 0.2.0",
   "type": "module",
   "module": "farstream-0.2.js",
@@ -25,11 +25,11 @@
     "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit farstream-0.2.d.cts"
   },
   "dependencies": {
-    "@girs/gjs": "^3.2.4",
-    "@girs/glib-2.0": "^2.78.0-3.2.4",
-    "@girs/gmodule-2.0": "^2.0.0-3.2.4",
-    "@girs/gobject-2.0": "^2.78.0-3.2.4",
-    "@girs/gst-1.0": "^1.23.0-3.2.4"
+    "@girs/gjs": "^3.2.6",
+    "@girs/glib-2.0": "^2.78.0-3.2.6",
+    "@girs/gmodule-2.0": "^2.0.0-3.2.6",
+    "@girs/gobject-2.0": "^2.78.0-3.2.6",
+    "@girs/gst-1.0": "^1.23.0-3.2.6"
   },
   "devDependencies": {
     "typescript": "*"