@girs/farstream-0.1 0.1.0-3.2.5 → 0.1.0-3.2.7

package/README.md

@@ -5,7 +5,7 @@
 ![downloads/week](https://img.shields.io/npm/dw/@girs/farstream-0.1)
 
 
-GJS TypeScript type definitions for Farstream-0.1, generated from library version 0.1.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.5.
+GJS TypeScript type definitions for Farstream-0.1, generated from library version 0.1.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v3.2.7.
 
 
 ## Install

package/farstream-0.1.d.cts

@@ -123,10 +123,10 @@ export enum StreamDirection {
     RECV,
     BOTH,
 }
-export const CODEC_FORMAT: string | null
+export const CODEC_FORMAT: string
 export const CODEC_ID_ANY: number
 export const CODEC_ID_DISABLE: number
-export const RTP_HEADER_EXTENSION_FORMAT: string | null
+export const RTP_HEADER_EXTENSION_FORMAT: string
 /**
  * Copies a GList of #FsCandidate and its contents
  * @param candidate_list A GList of #FsCandidate
@@ -593,6 +593,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
     }
 
 }
@@ -614,6 +619,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
@@ -653,6 +671,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.
@@ -667,6 +704,15 @@ 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
     /**
      * The ID of the session, the first number of the pads linked to this session
      * will be this id
@@ -677,11 +723,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
      */
@@ -1030,6 +1086,17 @@ 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[]
     /**
      * 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
@@ -1044,6 +1111,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.
@@ -1055,6 +1130,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.
@@ -1361,6 +1442,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
     }
 
 }
@@ -1374,7 +1461,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
      */
@@ -1562,6 +1655,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\%d" per component.
+     * These pads number must start at 1 (the \%d 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%d" per component.
@@ -1570,6 +1672,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%d" per component.
+     * These pads number must start at 1 (the %d 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.1.d.ts

@@ -125,10 +125,10 @@ enum StreamDirection {
     RECV,
     BOTH,
 }
-const CODEC_FORMAT: string | null
+const CODEC_FORMAT: string
 const CODEC_ID_ANY: number
 const CODEC_ID_DISABLE: number
-const RTP_HEADER_EXTENSION_FORMAT: string | null
+const RTP_HEADER_EXTENSION_FORMAT: string
 /**
  * Copies a GList of #FsCandidate and its contents
  * @param candidate_list A GList of #FsCandidate
@@ -595,6 +595,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
     }
 
 }
@@ -616,6 +621,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
@@ -655,6 +673,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.
@@ -669,6 +706,15 @@ 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
     /**
      * The ID of the session, the first number of the pads linked to this session
      * will be this id
@@ -679,11 +725,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
      */
@@ -1032,6 +1088,17 @@ 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[]
     /**
      * 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
@@ -1046,6 +1113,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.
@@ -1057,6 +1132,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.
@@ -1363,6 +1444,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
     }
 
 }
@@ -1376,7 +1463,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
      */
@@ -1564,6 +1657,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\%d" per component.
+     * These pads number must start at 1 (the \%d 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%d" per component.
@@ -1572,6 +1674,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%d" per component.
+     * These pads number must start at 1 (the %d 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.1",
-  "version": "0.1.0-3.2.5",
+  "version": "0.1.0-3.2.7",
   "description": "GJS TypeScript type definitions for Farstream-0.1, generated from library version 0.1.0",
   "type": "module",
   "module": "farstream-0.1.js",
@@ -25,12 +25,12 @@
     "test:cjs": "NODE_OPTIONS=--max_old_space_size=9216 tsc --noEmit farstream-0.1.d.cts"
   },
   "dependencies": {
-    "@girs/gjs": "^3.2.5",
-    "@girs/glib-2.0": "^2.78.0-3.2.5",
-    "@girs/gmodule-2.0": "^2.0.0-3.2.5",
-    "@girs/gobject-2.0": "^2.78.0-3.2.5",
-    "@girs/gst-0.10": "^0.10.29-3.2.5",
-    "@girs/libxml2-2.0": "^2.0.0-3.2.5"
+    "@girs/gjs": "^3.2.7",
+    "@girs/glib-2.0": "^2.78.0-3.2.7",
+    "@girs/gmodule-2.0": "^2.0.0-3.2.7",
+    "@girs/gobject-2.0": "^2.78.0-3.2.7",
+    "@girs/gst-0.10": "^0.10.29-3.2.7",
+    "@girs/libxml2-2.0": "^2.0.0-3.2.7"
   },
   "devDependencies": {
     "typescript": "*"