GStreamer WebRTC

https://gstreamer.freedesktop.org/documentation/webrtclib/webrtc_fwd.html?gi-language=c
Admin
API reference documentation for GStreamer's WebRTC library, providing bindings for C, JavaScript,...
Tokens:3,175
Snippets:42
Trust Score:7.9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Copy ICE Candidate Pair (C)

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

Creates a copy of a GstWebRTCICECandidatePair. Use this when you need a separate instance of the pair.

```c
GstWebRTCICECandidatePair *
gst_webrtc_ice_candidate_pair_copy (GstWebRTCICECandidatePair * pair)
```

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

### Copy ICE Candidate Pair (Python)

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

Python wrapper for copying a GstWebRTCICECandidatePair. This method creates a duplicate of the ICE candidate pair.

```python
def GstWebRTC.WebRTCICECandidatePair.copy (self):
    #python wrapper for 'gst_webrtc_ice_candidate_pair_copy'
```

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

### Free ICE Candidate Pair (JavaScript)

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

JavaScript wrapper for freeing a GstWebRTCICECandidatePair. Use this to release memory associated with the ICE candidate pair.

```javascript
function GstWebRTC.WebRTCICECandidatePair.prototype.free(): {
    // javascript wrapper for 'gst_webrtc_ice_candidate_pair_free'
}
```

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

### Copy ICE Candidate Pair (JavaScript)

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

JavaScript wrapper for copying a GstWebRTCICECandidatePair. This function is used to duplicate an existing ICE candidate pair object.

```javascript
function GstWebRTC.WebRTCICECandidatePair.prototype.copy(): {
    // javascript wrapper for 'gst_webrtc_ice_candidate_pair_copy'
}
```

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

### GstWebRTCSCTPTransport Class Structure (C)

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

Defines the class structure for GstWebRTCSCTPTransport in C.

```c
GObject
    ╰──GInitiallyUnowned
        ╰──GstObject
            ╰──GstWebRTCSCTPTransport
```

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

### GStreamer WebRTC API Export Macro

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

Defines the macro used for exporting symbols from the GStreamer WebRTC library. This is typically used in header files to ensure functions and variables are correctly exported.

```c
#define GST_WEBRTC_API GST_API_EXPORT         /* from config.h */

```

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

### Free ICE Candidate Pair (C)

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

Frees a GstWebRTCICECandidatePair, releasing its resources. This should be called when the pair is no longer needed.

```c
gst_webrtc_ice_candidate_pair_free (GstWebRTCICECandidatePair * pair)
```

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

### Free ICE Candidate Pair (Python)

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

Python wrapper for freeing a GstWebRTCICECandidatePair. This method releases the resources held by the ICE candidate pair object.

```python
def GstWebRTC.WebRTCICECandidatePair.free (self):
    #python wrapper for 'gst_webrtc_ice_candidate_pair_free'
```

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

### gst_webrtc_ice_candidate_pair_copy

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

Copies a GstWebRTCICECandidatePair. This function creates a deep copy of the provided ICE candidate pair.

```APIDOC
## gst_webrtc_ice_candidate_pair_copy

### Description
Copies a GstWebRTCICECandidatePair.

### Method
```c
GstWebRTCICECandidatePair *
gst_webrtc_ice_candidate_pair_copy (GstWebRTCICECandidatePair * pair)
```

### Parameters
#### Path Parameters
- **pair** (GstWebRTCICECandidatePair *) - Required - The GstWebRTCICE

### Returns
- **GstWebRTCICECandidatePair** (transfer: full) - A copy of _pair_

### Since
1.28
```

```APIDOC
## GstWebRTC.WebRTCICECandidatePair.prototype.copy

### Description
JavaScript wrapper for 'gst_webrtc_ice_candidate_pair_copy'.

### Method
```javascript
function GstWebRTC.WebRTCICECandidatePair.prototype.copy(): {
    // javascript wrapper for 'gst_webrtc_ice_candidate_pair_copy'
}
```

### Parameters
#### Path Parameters
- **pair** (GstWebRTC.WebRTCICECandidatePair) - Required - The GstWebRTC.WebRTCICE

### Returns
- **GstWebRTC.WebRTCICECandidatePair** - A copy of _pair_

### Since
1.28
```

```APIDOC
## GstWebRTC.WebRTCICECandidatePair.copy

### Description
Python wrapper for 'gst_webrtc_ice_candidate_pair_copy'.

### Method
```python
def GstWebRTC.WebRTCICECandidatePair.copy (self):
    #python wrapper for 'gst_webrtc_ice_candidate_pair_copy'
```

### Parameters
#### Path Parameters
- **pair** (GstWebRTC.WebRTCICECandidatePair) - Required - The GstWebRTC.WebRTCICE

### Returns
- **GstWebRTC.WebRTCICECandidatePair** - A copy of _pair_

### Since
1.28
```

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

### GstWebRTCICECandidatePair Members

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

Enumeration members for GstWebRTCICECandidatePair, representing local and remote ICE candidates.

```APIDOC
## _GstWebRTCICECandidate_

### Members
__`local`__(GstWebRTCICECandidate *) – 
_No description available_
__`remote`__(GstWebRTCICECandidate *) – 
_No description available_
**Since** : 1.28
```

```APIDOC
## _GstWebRTC.WebRTCICECandidatePair_

### Members
__`local`__(GstWebRTC.WebRTCICECandidate) – 
_No description available_
__`remote`__(GstWebRTC.WebRTCICECandidate) – 
_No description available_
**Since** : 1.28
```

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

### GstWebRTCSCTPTransport Class Structure (JavaScript)

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

Defines the class structure for GstWebRTC.WebRTCSCTPTransport in JavaScript.

```javascript
GObject.Object
    ╰──GObject.InitiallyUnowned
        ╰──Gst.Object
            ╰──GstWebRTC.WebRTCSCTPTransport
```

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

### State Property (C)

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

Represents the state of the GstWebRTCSCTPTransport. This property is read-only.

```c
“state” GstWebRTCSCTPTransportState *
```

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

### Max Channels Property (JavaScript - Internal)

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

Internal representation of the maximum channels property for GstWebRTC.WebRTCSCTPTransport.

```javascript
“self.props.max_channels” int
```

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

### State Property (JavaScript - Internal)

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

Internal representation of the state property for GstWebRTC.WebRTCSCTPTransport.

```javascript
“self.props.state” GstWebRTC.WebRTCSCTPTransportState
```

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

### Max Channels Property (C)

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

Represents the maximum number of channels for GstWebRTCSCTPTransport. This property is read-only.

```c
“max-channels” guint
```

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

### Max Message Size Property (C)

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

Represents the maximum message size for GstWebRTCSCTPTransport. This property is read-only.

```c
“max-message-size” guint64
```

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

### GStreamer WebRTC Error Quark Definition

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

Defines the error quark for the GStreamer WebRTC library. This is used for error reporting and handling within the library. Available since version 1.20.

```c
#define GST_WEBRTC_ERROR gst_webrtc_error_quark ()

```

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

### Transport Property (JavaScript - Internal)

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

Internal representation of the transport property for GstWebRTC.WebRTCSCTPTransport.

```javascript
“self.props.transport” GstWebRTC.WebRTCDTLSTransport
```

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

### gst_webrtc_ice_candidate_pair_free

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

Frees a GstWebRTCICECandidatePair. This is a helper function to release resources associated with an ICE candidate pair.

```APIDOC
## gst_webrtc_ice_candidate_pair_free

### Description
Helper function to free GstWebRTCICECandidatePair.

### Method
```c
gst_webrtc_ice_candidate_pair_free (GstWebRTCICECandidatePair * pair)
```

### Parameters
#### Path Parameters
- **pair** (GstWebRTCICECandidatePair *) - Required - The GstWebRTCICECandidatePair to be free'd

### Since
1.28
```

```APIDOC
## GstWebRTC.WebRTCICECandidatePair.prototype.free

### Description
JavaScript wrapper for 'gst_webrtc_ice_candidate_pair_free'.

### Method
```javascript
function GstWebRTC.WebRTCICECandidatePair.prototype.free(): {
    // javascript wrapper for 'gst_webrtc_ice_candidate_pair_free'
}
```

### Parameters
#### Path Parameters
- **pair** (GstWebRTC.WebRTCICECandidatePair) - Required - The GstWebRTC.WebRTCICECandidatePair to be free'd

### Since
1.28
```

```APIDOC
## GstWebRTC.WebRTCICECandidatePair.free

### Description
Python wrapper for 'gst_webrtc_ice_candidate_pair_free'.

### Method
```python
def GstWebRTC.WebRTCICECandidatePair.free (self):
    #python wrapper for 'gst_webrtc_ice_candidate_pair_free'
```

### Parameters
#### Path Parameters
- **pair** (GstWebRTC.WebRTCICECandidatePair) - Required - The GstWebRTC.WebRTCICECandidatePair to be free'd

### Since
1.28
```

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

### State Property (JavaScript)

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

Represents the state of the GstWebRTC.WebRTCSCTPTransport. This property is read-only.

```javascript
“state” GstWebRTC.WebRTCSCTPTransportState
```

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

### Max Message Size Property (JavaScript - Internal)

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

Internal representation of the maximum message size property for GstWebRTC.WebRTCSCTPTransport.

```javascript
“self.props.max_message_size” int
```

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

### GstWebRTCSCTPTransport Properties

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

Properties of the GstWebRTCSCTPTransport object, including max channels, max message size, state, and transport.

```APIDOC
## _GstWebRTCSCTPTransport_

### Properties
#### _max-channels_
```
“max-channels” guint
```
Flags : Read

#### _max-message-size_
```
“max-message-size” guint64
```
Flags : Read

#### _state_
```
“state” GstWebRTCSCTPTransportState *
```
Flags : Read

#### _transport_
```
“transport” GstWebRTCDTLSTransport *
```
Flags : Read
```

```APIDOC
## GstWebRTC.WebRTCSCTPTransport

### Properties
#### _max-channels_
```
“max-channels” Number
```
Flags : Read

#### _max-message-size_
```
“max-message-size” Number
```
Flags : Read

#### _state_
```
“state” GstWebRTC.WebRTCSCTPTransportState
```
Flags : Read

#### _transport_
```
“transport” GstWebRTC.WebRTCDTLSTransport
```
Flags : Read
```

```APIDOC
## GstWebRTC.WebRTCSCTPTransport

### Properties
#### _max_channels_
```
“self.props.max_channels” int
```
Flags : Read

#### _max_message_size_
```
“self.props.max_message_size” int
```
Flags : Read

#### _state_
```
“self.props.state” GstWebRTC.WebRTCSCTPTransportState
```
Flags : Read

#### _transport_
```
“self.props.transport” GstWebRTC.WebRTCDTLSTransport
```
Flags : Read
```

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

### Max Channels Property (JavaScript)

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

Represents the maximum number of channels for GstWebRTC.WebRTCSCTPTransport. This property is read-only.

```javascript
“max-channels” Number
```

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

### Transport Property (C)

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

Represents the underlying DTLS transport for GstWebRTCSCTPTransport. This property is read-only.

```c
“transport” GstWebRTCDTLSTransport *
```

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

### Max Message Size Property (JavaScript)

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

Represents the maximum message size for GstWebRTC.WebRTCSCTPTransport. This property is read-only.

```javascript
“max-message-size” Number
```

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

### Transport Property (JavaScript)

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

Represents the underlying DTLS transport for GstWebRTC.WebRTCSCTPTransport. This property is read-only.

```javascript
“transport” GstWebRTC.WebRTCDTLSTransport
```
Tokens:
Raw