GstWebRTC ICE Transport

https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c
Admin
GstWebRTCICETransport is a component within the GStreamer WebRTC library responsible for managing...
Tokens:1,543
Snippets:18
Trust Score:7.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Implement GstWebRTCICETransport gather_candidates Virtual Method

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c/gstwebrtc-icetransport

This virtual method is responsible for gathering ICE candidates for the transport. Implementations are provided for C, JavaScript, and Python.

```C
gboolean
gather_candidates (GstWebRTCICETransport * transport)
```

```JavaScript
function vfunc_gather_candidates(transport: GstWebRTC.WebRTCICETransport): {
    // javascript implementation of the 'gather_candidates' virtual method
}
```

```Python
def do_gather_candidates (transport):
    #python implementation of the 'gather_candidates' virtual method
```

--------------------------------

### GstWebRTCICETransport New Candidate Method

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c/gstwebrtc-icetransport

This method signals a new ICE candidate for a GstWebRTCICETransport object. It is available in C.

```C
gst_webrtc_ice_transport_new_candidate (GstWebRTCICETransport * ice,
                                        guint stream_id,
                                        GstWebRTCICEComponent component,
                                        const gchar * attr)

Parameters:
  ice: GstWebRTCICETransport*
  stream_id: guint
  component: GstWebRTCICEComponent
  attr: const gchar*
```

--------------------------------

### GstWebRTCICETransportClass C Fields

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c/gstwebrtc-icetransport

Describes the fields within the GstWebRTCICETransportClass structure, which typically holds virtual functions and class-specific data for the C API.

```C
GstWebRTCICETransportClass:
  parent_class: GstObjectClass
  _padding: gpointer *
```

--------------------------------

### Handle GstWebRTCICETransport on-selected-candidate-pair-change Signal

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c/gstwebrtc-icetransport

This signal is emitted when the selected ICE candidate pair changes for a GstWebRTCICETransport instance. It provides callbacks for C, JavaScript, and Python to react to this event.

```C
on_selected_candidate_pair_change_callback (GstWebRTCICETransport * self,
                                            gpointer user_data)
```

```JavaScript
function on_selected_candidate_pair_change_callback(self: GstWebRTC.WebRTCICETransport, user_data: Object): {
    // javascript callback for the 'on-selected-candidate-pair-change' signal
}
```

```Python
def on_selected_candidate_pair_change_callback (self, *user_data):
    #python callback for the 'on-selected-candidate-pair-change' signal
```

--------------------------------

### GstWebRTCICETransport 'state' Property Definition

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c/gstwebrtc-icetransport

Indicates the current ICE connection state of the transport. This property is read-only, with different representations for C, JavaScript/GObject, and Python property access.

```APIDOC
“state” GstWebRTCICEConnectionState *
Flags : Read
```

```APIDOC
“state” GstWebRTC.WebRTCICEConnectionState
Flags : Read
```

```APIDOC
“self.props.state” GstWebRTC.WebRTCICEConnectionState
Flags : Read
```

--------------------------------

### GstWebRTCICETransport Inheritance Hierarchy

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c/gstwebrtc-icetransport

Defines the object inheritance hierarchy for the GstWebRTCICETransport class, showing its lineage from GObject through GstObject in various language bindings.

```C
GObject
    ╰──GInitiallyUnowned
        ╰──GstObject
            ╰──GstWebRTCICETransport
```

```JavaScript
GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──GstWebRTC.WebRTCICETransport
```

```Python
GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──GstWebRTC.WebRTCICETransport
```

--------------------------------

### GstWebRTCICETransport Connection State Change Method

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c/gstwebrtc-icetransport

This method signals a change in the ICE connection state for a GstWebRTCICETransport object. It is available in C, JavaScript, and Python.

```C
gst_webrtc_ice_transport_connection_state_change (GstWebRTCICETransport * ice,
                                                  GstWebRTCICEConnectionState new_state)

Parameters:
  ice: GstWebRTCICETransport*
  new_state: GstWebRTCICEConnectionState
```

```JavaScript
function GstWebRTC.WebRTCICETransport.prototype.connection_state_change(new_state: GstWebRTC.WebRTCICEConnectionState): {
    // javascript wrapper for 'gst_webrtc_ice_transport_connection_state_change'
}

Parameters:
  ice: GstWebRTC.WebRTCICETransport
  new_state: GstWebRTC.WebRTCICEConnectionState
```

```Python
def GstWebRTC.WebRTCICETransport.connection_state_change (self, new_state):
    #python wrapper for 'gst_webrtc_ice_transport_connection_state_change'

Parameters:
  ice: GstWebRTC.WebRTCICETransport
  new_state: GstWebRTC.WebRTCICEConnectionState
```

--------------------------------

### GstWebRTCICETransport 'component' Property Definition

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c/gstwebrtc-icetransport

Defines the ICE component associated with the transport. This property is readable, writable, and construct-only, with different representations for C, JavaScript/GObject, and Python property access.

```APIDOC
“component” GstWebRTCICEComponent *
Flags : Read / Write / Construct Only
```

```APIDOC
“component” GstWebRTC.WebRTCICEComponent
Flags : Read / Write / Construct Only
```

```APIDOC
“self.props.component” GstWebRTC.WebRTCICEComponent
Flags : Read / Write / Construct Only
```

--------------------------------

### GstWebRTCICETransport Properties

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c/gstwebrtc-icetransport

Defines the properties (members) of the GstWebRTCICETransport object, including their types, which represent various aspects of the ICE transport state and configuration.

```APIDOC
GstWebRTCICETransport Members:
  parent: Gst.Object
  role: GstWebRTC.WebRTCICERole
  component: GstWebRTC.WebRTCICEComponent
  state: GstWebRTC.WebRTCICEConnectionState
  gathering_state: GstWebRTC.WebRTCICEGatheringState
  src: Gst.Element
  sink: Gst.Element
  _padding: object[]
```

--------------------------------

### GstWebRTC.WebRTCICETransport: Signal for new ICE candidate

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c/gstwebrtc-icetransport

Callback signal emitted when a new ICE candidate is available. This signal is crucial for exchanging ICE candidates between peers to establish a WebRTC connection.

```c
on_new_candidate_callback (GstWebRTCICETransport * self,
                           gchar * object,
                           gpointer user_data)
```

```javascript
function on_new_candidate_callback(self: GstWebRTC.WebRTCICETransport, object: String, user_data: Object): {
    // javascript callback for the 'on-new-candidate' signal
}
```

```python
def on_new_candidate_callback (self, object, *user_data):
    #python callback for the 'on-new-candidate' signal
```

```apidoc
on_new_candidate_callback (self: GstWebRTC.WebRTCICETransport, object: gchar/String/str, user_data: gpointer/Object/variadic)
Parameters:
  self: GstWebRTC.WebRTCICETransport - No description available
  object: gchar/String/str - No description available
  user_data: gpointer/Object/variadic - No description available
```

--------------------------------

### GstWebRTC.WebRTCICETransport: Add new ICE candidate

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c/gstwebrtc-icetransport

Adds a new ICE candidate to the WebRTC ICE transport. This method is used to provide ICE candidates received from a remote peer, which are essential for establishing a peer-to-peer connection.

```javascript
function GstWebRTC.WebRTCICETransport.prototype.new_candidate(stream_id: Number, component: GstWebRTC.WebRTCICEComponent, attr: String): {
    // javascript wrapper for 'gst_webrtc_ice_transport_new_candidate'
}
```

```python
def GstWebRTC.WebRTCICETransport.new_candidate (self, stream_id, component, attr):
    #python wrapper for 'gst_webrtc_ice_transport_new_candidate'
```

```apidoc
GstWebRTC.WebRTCICETransport.prototype.new_candidate(stream_id: Number/int, component: GstWebRTC.WebRTCICEComponent, attr: String/str)
Parameters:
  ice: GstWebRTC.WebRTCICETransport - No description available
  stream_id: Number/int - No description available
  component: GstWebRTC.WebRTCICEComponent - No description available
  attr: String/str - No description available
```

--------------------------------

### GstWebRTC.WebRTCICETransportClass PyGObject Attributes

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c/gstwebrtc-icetransport

Outlines the attributes available on the GstWebRTC.WebRTCICETransportClass object when accessed via PyGObject (Python) bindings, including their types.

```Python
GstWebRTC.WebRTCICETransportClass:
  parent_class: Gst.ObjectClass
  _padding: [object]
```

--------------------------------

### GstWebRTC.WebRTCICETransportClass GJS Attributes

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c/gstwebrtc-icetransport

Outlines the attributes available on the GstWebRTC.WebRTCICETransportClass object when accessed via GJS (JavaScript) bindings, including their types.

```JavaScript
GstWebRTC.WebRTCICETransportClass:
  parent_class: Gst.ObjectClass
  _padding: [Object]
```

--------------------------------

### GstWebRTCICETransport 'gathering-state' Property Definition

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c/gstwebrtc-icetransport

Indicates the current ICE gathering state of the transport. This property is read-only, with different representations for C, JavaScript/GObject, and Python property access.

```APIDOC
“gathering-state” GstWebRTCICEGatheringState *
Flags : Read
```

```APIDOC
“gathering-state” GstWebRTC.WebRTCICEGatheringState
Flags : Read
```

```APIDOC
“self.props.gathering_state” GstWebRTC.WebRTCICEGatheringState
Flags : Read
```

--------------------------------

### GstWebRTCICETransport C Members

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c/gstwebrtc-icetransport

Details the member variables of the GstWebRTCICETransport object as defined in the C API, including their types and purpose.

```C
GstWebRTCICETransport:
  parent: GstObject
  role: GstWebRTCICERole
  component: GstWebRTCICEComponent
  state: GstWebRTCICEConnectionState
  gathering_state: GstWebRTCICEGatheringState
  src: GstElement *
  sink: GstElement *
  _padding: gpointer *
```

--------------------------------

### GstWebRTCICETransport Gathering State Change Method

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c/gstwebrtc-icetransport

This method signals a change in the ICE gathering state for a GstWebRTCICETransport object. It is available in C, JavaScript, and Python.

```C
gst_webrtc_ice_transport_gathering_state_change (GstWebRTCICETransport * ice,
                                                 GstWebRTCICEGatheringState new_state)

Parameters:
  ice: GstWebRTCICETransport*
  new_state: GstWebRTCICEGatheringState
```

```JavaScript
function GstWebRTC.WebRTCICETransport.prototype.gathering_state_change(new_state: GstWebRTC.WebRTCICEGatheringState): {
    // javascript wrapper for 'gst_webrtc_ice_transport_gathering_state_change'
}

Parameters:
  ice: GstWebRTC.WebRTCICETransport
  new_state: GstWebRTC.WebRTCICEGatheringState
```

```Python
def GstWebRTC.WebRTCICETransport.gathering_state_change (self, new_state):
    #python wrapper for 'gst_webrtc_ice_transport_gathering_state_change'

Parameters:
  ice: GstWebRTC.WebRTCICETransport
  new_state: GstWebRTC.WebRTCICEGatheringState
```

--------------------------------

### GstWebRTC.WebRTCICETransport GJS Members

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c/gstwebrtc-icetransport

Details the member variables of the GstWebRTC.WebRTCICETransport object as defined in the GJS (JavaScript) API, including their types and purpose.

```JavaScript
GstWebRTC.WebRTCICETransport:
  parent: Gst.Object
  role: GstWebRTC.WebRTCICERole
  component: GstWebRTC.WebRTCICEComponent
  state: GstWebRTC.WebRTCICEConnectionState
  gathering_state: GstWebRTC.WebRTCICEGatheringState
  src: Gst.Element
  sink: Gst.Element
  _padding: [Object]
```

--------------------------------

### GstWebRTC.WebRTCICETransport: Handle selected pair change

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-icetransport.html?gi-language=c/gstwebrtc-icetransport

Notifies the ICE transport about a change in the selected ICE candidate pair. This is typically an internal signal or method indicating that the transport has chosen a new pair for communication.

```c
gst_webrtc_ice_transport_selected_pair_change (GstWebRTCICETransport * ice)
```

```javascript
function GstWebRTC.WebRTCICETransport.prototype.selected_pair_change(): {
    // javascript wrapper for 'gst_webrtc_ice_transport_selected_pair_change'
}
```

```python
def GstWebRTC.WebRTCICETransport.selected_pair_change (self):
    #python wrapper for 'gst_webrtc_ice_transport_selected_pair_change'
```

```apidoc
gst_webrtc_ice_transport_selected_pair_change (GstWebRTCICETransport * ice)
Parameters:
  ice: GstWebRTC.WebRTCICETransport - No description available
```
Tokens:
Raw