GStreamer WebRTC Data Channel

https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-datachannel.html?gi-language=c
Admin
GStreamer WebRTC Data Channel is an API within the GStreamer framework for managing WebRTC Data...
Tokens:3,532
Snippets:42
Trust Score:7.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### GstWebRTCICEStream

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

This object represents a GstWebRTCICEStream, which manages specific ICE streams within a WebRTC connection. It is a component of the ICE framework, facilitating the setup of individual media or data flows.

```APIDOC
GstWebRTCICEStream
  - GstWebRTCICEStream object
```

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

### Handle GstWebRTCDataChannel Close Signal

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

Defines the callback for the 'on-close' signal, which is emitted when the GstWebRTCDataChannel is closed. This allows applications to react to channel closure. A C callback example is provided.

```C
on_close_callback (GstWebRTCDataChannel * self,
                   gpointer user_data)
```

```APIDOC
on_close_callback (C API):
  Parameters:
    self: No description available
    user_data: No description available
  Flags: Run Last
```

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

### Handle GstWebRTCDataChannel Open Signal (Multi-language)

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

Provides callbacks in C, JavaScript, and Python for the 'on-open' signal, which is emitted when the GstWebRTCDataChannel successfully opens and is ready for communication.

```C
on_open_callback (GstWebRTCDataChannel * self,
                  gpointer user_data)
```

```JavaScript
function on_open_callback(self: GstWebRTC.WebRTCDataChannel, user_data: Object): {
    // javascript callback for the 'on-open' signal
}
```

```Python
def on_open_callback (self, *user_data):
    #python callback for the 'on-open' signal
```

```APIDOC
Parameters:
  self: GstWebRTC.WebRTCDataChannel (Python/JS), GstWebRTCDataChannel * (C) - No description available
  user_data: variadic (Python), Object (JS), gpointer (C) - No description available
Flags: Run Last
```

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

### webrtc

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

This subpage provides general documentation and overview for the GStreamer WebRTC library. It serves as a central point for understanding the overall WebRTC integration within GStreamer.

```APIDOC
webrtc
```

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

### GstWebRTCICE

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

This is the base class for WebRTC ICE (Interactive Connectivity Establishment) handling within GStreamer. It provides fundamental functionalities for discovering and establishing peer-to-peer connections, navigating NATs and firewalls.

```APIDOC
GstWebRTCICE
  - Base class WebRTC ICE handling
```

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

### GstWebRTC.WebRTCDataChannel: ready-state Property

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

The current state of the data channel. This property is read-only.

```GObject/C
“ready-state” GstWebRTCDataChannelState *
Flags : Read
```

```JavaScript
“ready-state” GstWebRTC.WebRTCDataChannelState
Flags : Read
```

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

### GstWebRTCDataChannel Class Definition

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

Defines the GstWebRTCDataChannel class, including its inheritance from GObject, and notes its availability since GStreamer 1.18.

```APIDOC
GstWebRTCDataChannel
  Inherits: GObject
  Since: 1.18

GstWebRTC.WebRTCDataChannel
  Inherits: GObject.Object
  Since: 1.18
```

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

### GstWebRTC.WebRTCDataChannelState ready_state Property

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

Describes the current state of the WebRTC data channel. This property indicates whether the channel is connecting, open, closing, or closed, and is read-only.

```APIDOC
ready_state (GstWebRTC.WebRTCDataChannelState)
  Description: The current state of the WebRTC data channel.
  Flags: Read
```

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

### Handle GstWebRTCDataChannel Binary Message Signal (Python)

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

Provides a Python callback for the 'on-message-data' signal, which is emitted when binary data is received on the GstWebRTCDataChannel. The `data` parameter contains the received GBytes object.

```Python
def on_message_data_callback (self, data, *user_data):
    #python callback for the 'on-message-data' signal
```

```APIDOC
Parameters:
  self: GstWebRTC.WebRTCDataChannel - No description available
  data: GBytes (not introspectable) - a GBytes (not introspectable) of the data received
  user_data: variadic - No description available
Flags: Run Last
```

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

### Handle GstWebRTCDataChannel String Message Signal (Multi-language)

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

Provides callbacks in C, JavaScript, and Python for the 'on-message-string' signal, which is emitted when string data is received on the GstWebRTCDataChannel. The `data` parameter contains the received string.

```C
on_message_string_callback (GstWebRTCDataChannel * self,
                            gchar * data,
                            gpointer user_data)
```

```JavaScript
function on_message_string_callback(self: GstWebRTC.WebRTCDataChannel, data: String, user_data: Object): {
    // javascript callback for the 'on-message-string' signal
}
```

```Python
def on_message_string_callback (self, data, *user_data):
    #python callback for the 'on-message-string' signal
```

```APIDOC
Parameters:
  self: GstWebRTC.WebRTCDataChannel (Python/JS), GstWebRTCDataChannel * (C) - No description available
  data: str (Python), String (JS), gchar * (C) - the data received as a string
  user_data: variadic (Python), Object (JS), gpointer (C) - No description available
Flags: Run Last
```

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

### GstWebRTC Enumerations

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

This subpage provides a list of enumerations used within the GStreamer WebRTC library. These enumerations define various states, types, and options for WebRTC components, aiding in consistent API usage.

```APIDOC
GstWebRTC Enumerations
```

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

### Emit GstWebRTCDataChannel Close Action Signal (C)

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

Demonstrates how to programmatically emit the 'close' action signal on a GstWebRTCDataChannel to initiate the closing process of the data channel.

```C
g_signal_emit_by_name (self, "close", user_data);
```

```APIDOC
Description: Close the data channel
Parameters:
  self: GstWebRTCDataChannel * - No description available
  user_data: gpointer - No description available
Flags: Run Last, Action
```

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

### Send Binary Data over GstWebRTCDataChannel

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

This function sends binary data as a data message over the specified GstWebRTCDataChannel. It supports C, JavaScript, and Python bindings. The function returns TRUE if the channel is open and the data could be queued for sending. An optional GError can be provided for error handling in C.

```C
gboolean
gst_webrtc_data_channel_send_data_full (GstWebRTCDataChannel * channel,
                                        GBytes * data,
                                        GError ** error)
```

```APIDOC
Method: gst_webrtc_data_channel_send_data_full
Parameters:
  channel: GstWebRTCDataChannel - a GstWebRTCDataChannel
  data: GBytes (nullable) - a GBytes or NULL
  error: GError (nullable) - location to a GError or NULL
Returns: gboolean - TRUE if channel is open and data could be queued
Since: 1.22
```

```JavaScript
function GstWebRTC.WebRTCDataChannel.prototype.send_data_full(data: GBytes (not introspectable)): {
    // javascript wrapper for 'gst_webrtc_data_channel_send_data_full'
}
```

```APIDOC
Method: GstWebRTC.WebRTCDataChannel.prototype.send_data_full
Parameters:
  channel: GstWebRTC.WebRTCDataChannel - a GstWebRTC.WebRTCDataChannel
  data: GBytes (not introspectable) - a GBytes (not introspectable) or null
Returns: Number - TRUE if channel is open and data could be queued
Since: 1.22
```

```Python
@raises(GLib.GError)
def GstWebRTC.WebRTCDataChannel.send_data_full (self, data):
    #python wrapper for 'gst_webrtc_data_channel_send_data_full'
```

```APIDOC
Method: GstWebRTC.WebRTCDataChannel.send_data_full
Parameters:
  channel: GstWebRTC.WebRTCDataChannel - a GstWebRTC.WebRTCDataChannel
  data: GBytes (not introspectable) - a GBytes (not introspectable) or None
Returns: bool - TRUE if channel is open and data could be queued
Since: 1.22
```

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

### Handle GstWebRTCDataChannel Buffered Amount Low Signal

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

Defines callbacks for the 'on-buffered-amount-low' signal, which is emitted when the amount of data buffered for sending on a GstWebRTCDataChannel falls below a threshold. This signal can be used to resume sending data. Callbacks are provided for C, JavaScript, and Python.

```C
on_buffered_amount_low_callback (GstWebRTCDataChannel * self,
                                 gpointer user_data)
```

```JavaScript
function on_buffered_amount_low_callback(self: GstWebRTC.WebRTCDataChannel, user_data: Object): {
    // javascript callback for the 'on-buffered-amount-low' signal
}
```

```Python
def on_buffered_amount_low_callback (self, *user_data):
    #python callback for the 'on-buffered-amount-low' signal
```

```APIDOC
on-buffered-amount-low Signal Callbacks:

on_buffered_amount_low_callback (C API):
  Parameters:
    self: No description available
    user_data: No description available
  Flags: Run Last

on_buffered_amount_low_callback (JavaScript API):
  Parameters:
    self (GstWebRTC.WebRTCDataChannel): No description available
    user_data (Object): No description available
  Flags: Run Last

on_buffered_amount_low_callback (Python API):
  Parameters:
    self (GstWebRTC.WebRTCDataChannel): No description available
    user_data (variadic): No description available
  Flags: Run Last
```

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

### Send String Message on GstWebRTCDataChannel

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

Provides methods to send a string message over a GstWebRTCDataChannel. The function attempts to queue the data if the channel is open, returning a boolean indicating success. This functionality is available in C, JavaScript, and Python.

```C
gboolean
gst_webrtc_data_channel_send_string_full (GstWebRTCDataChannel * channel,
                                          const gchar * str,
                                          GError ** error)
```

```JavaScript
function GstWebRTC.WebRTCDataChannel.prototype.send_string_full(str: String): {
    // javascript wrapper for 'gst_webrtc_data_channel_send_string_full'
}
```

```Python
@raises(GLib.GError)
def GstWebRTC.WebRTCDataChannel.send_string_full (self, str):
    #python wrapper for 'gst_webrtc_data_channel_send_string_full'
```

```APIDOC
gst_webrtc_data_channel_send_string_full (C API):
  Parameters:
    channel: a GstWebRTCDataChannel
    str (nullable): a string or NULL
    error: No description available
  Returns:
    TRUE if channel is open and data could be queued
  Since: 1.22

GstWebRTC.WebRTCDataChannel.prototype.send_string_full (JavaScript API):
  Parameters:
    channel (GstWebRTC.WebRTCDataChannel): a GstWebRTC.WebRTCDataChannel
    str (String): a string or null
  Returns (Number):
    TRUE if channel is open and data could be queued
  Since: 1.22

GstWebRTC.WebRTCDataChannel.send_string_full (Python API):
  Parameters:
    channel (GstWebRTC.WebRTCDataChannel): a GstWebRTC.WebRTCDataChannel
    str (str): a string or None
  Returns (bool):
    TRUE if channel is open and data could be queued
  Since: 1.22
```

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

### GstWebRTC.WebRTCDataChannel: ordered Property

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

Indicates whether messages are guaranteed to be delivered in order. This property is readable, writable, and can be set only during construction.

```GObject/C
“ordered” gboolean
Flags : Read
/ Write
/ Construct Only
```

```JavaScript
“ordered” Number
Flags : Read
/ Write
/ Construct Only
```

```Python
“self.props.ordered” bool
Flags : Read
/ Write
/ Construct Only
```

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

### Send Data over GstWebRTCDataChannel Method

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

Provides methods to send binary data over a WebRTC data channel. This functionality is deprecated since GStreamer 1.22, recommending `gst_webrtc_data_channel_send_data_full()` instead.

```C
gst_webrtc_data_channel_send_data (GstWebRTCDataChannel * channel,
                                   GBytes * data)

Parameters:
  channel: GstWebRTCDataChannel - A GstWebRTCDataChannel instance.
  data: GBytes (nullable) - The data to send, or NULL.

Deprecated: 1.22: Use gst_webrtc_data_channel_send_data_full() instead.
```

```JavaScript
function GstWebRTC.WebRTCDataChannel.prototype.send_data(data: GBytes (not introspectable)): {
    // javascript wrapper for 'gst_webrtc_data_channel_send_data'
}

Parameters:
  channel: GstWebRTC.WebRTCDataChannel - A GstWebRTC.WebRTCDataChannel instance.
  data: GBytes (not introspectable) - The data to send, or null.

Deprecated: 1.22: Use gst_webrtc_data_channel_send_data_full() instead.
```

```Python
def GstWebRTC.WebRTCDataChannel.send_data (self, data):
    #python wrapper for 'gst_webrtc_data_channel_send_data'

Parameters:
  channel: GstWebRTC.WebRTCDataChannel - A GstWebRTC.WebRTCDataChannel instance.
  data: GBytes (not introspectable) - The data to send, or None.

Deprecated: 1.22: Use gst_webrtc_data_channel_send_data_full() instead.
```

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

### GstWebRTC.WebRTCDataChannel: priority Property

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

The priority of the data channel. This property is readable, writable, and can be set only during construction.

```GObject/C
“priority” GstWebRTCPriorityType *
Flags : Read
/ Write
/ Construct Only
```

```JavaScript
“priority” GstWebRTC.WebRTCPriorityType
Flags : Read
/ Write
/ Construct Only
```

```Python
“self.props.priority” GstWebRTC.WebRTCPriorityType
Flags : Read
/ Write
/ Construct Only
```

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

### GstWebRTC.WebRTCDataChannel: protocol Property

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

The subprotocol used for the data channel. This property is readable, writable, and can be set only during construction.

```GObject/C
“protocol” gchar *
Flags : Read
/ Write
/ Construct Only
```

```JavaScript
“protocol” String
Flags : Read
/ Write
/ Construct Only
```

```Python
“self.props.protocol” str
Flags : Read
/ Write
/ Construct Only
```

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

### GstWebRTCSessionDescription

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

This object represents an RTCSessionDescription, which describes the session parameters for a WebRTC connection. It contains information about media formats, codecs, and network candidates, exchanged via SDP (Session Description Protocol).

```APIDOC
GstWebRTCSessionDescription
  - RTCSessionDescription object
```

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

### GstWebRTC.WebRTCDataChannel: negotiated Property

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

Indicates whether the data channel was negotiated out-of-band. This property is readable, writable, and can be set only during construction.

```GObject/C
“negotiated” gboolean
Flags : Read
/ Write
/ Construct Only
```

```JavaScript
“negotiated” Number
Flags : Read
/ Write
/ Construct Only
```

```Python
“self.props.negotiated” bool
Flags : Read
/ Write
/ Construct Only
```

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

### Emit 'send-data' signal for GstWebRTC.WebRTCDataChannel

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

This signal is emitted to send binary data over the WebRTC data channel. It takes the data channel instance, the data as GBytes, and optional user data. This signal is deprecated since version 1.22; use `gst_webrtc_data_channel_send_data_full()` instead. The signal is marked with 'Run Last' and 'Action' flags.

```APIDOC
Signal: send-data
  Description: Emits a signal to send binary data over the data channel.
  Parameters:
    self: GstWebRTCDataChannel * (C) | GstWebRTC.WebRTCDataChannel (JavaScript/Python)
    data: GBytes * (C, nullable) | GBytes (not introspectable) (JavaScript/Python) - a GBytes with the data
    user_data: gpointer (C) | Object (JavaScript) | variadic (Python)
  Flags: Run Last, Action
  Deprecated: 1.22: Use gst_webrtc_data_channel_send_data_full() instead
```

```C
g_signal_emit_by_name (self, "send-data", data, user_data);
```

```JavaScript
let ret = self.emit ("send-data", data, user_data);
```

```Python
ret = self.emit ("send-data", data, user_data)
```

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

### Emit 'send-string' signal for GstWebRTC.WebRTCDataChannel

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

This signal is emitted to send string data over the WebRTC data channel. It takes the data channel instance, the string data, and optional user data. This signal is deprecated since version 1.22; use `gst_webrtc_data_channel_send_string_full()` instead. The signal is marked with 'Run Last' and 'Action' flags.

```APIDOC
Signal: send-string
  Description: Emits a signal to send string data over the data channel.
  Parameters:
    self: GstWebRTCDataChannel *
    data: gchar * (nullable) - the data to send as a string
    user_data: gpointer
  Flags: Run Last, Action
  Deprecated: 1.22: Use gst_webrtc_data_channel_send_string_full() instead
```

```C
g_signal_emit_by_name (self, "send-string", data, user_data);
```

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

### GstWebRTC.WebRTCDataChannel: label Property

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

A human-readable label for the data channel. This property is readable, writable, and can be set only during construction.

```GObject/C
“label” gchar *
Flags : Read
/ Write
/ Construct Only
```

```JavaScript
“label” String
Flags : Read
/ Write
/ Construct Only
```

```Python
“self.props.label” str
Flags : Read
/ Write
/ Construct Only
```

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

### GstWebRTC.WebRTCDataChannel: buffered-amount-low-threshold Property

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

Defines the threshold for the buffered amount. When the buffered amount falls below this value, a 'buffered-amount-low' signal might be emitted. This property is readable and writable.

```GObject/C
“buffered-amount-low-threshold” guint64
Flags : Read
/ Write
```

```JavaScript
“buffered-amount-low-threshold” Number
Flags : Read
/ Write
```

```Python
“self.props.buffered_amount_low_threshold” int
Flags : Read
/ Write
```

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

### GstWebRTCRTPReceiver

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

This object represents an RTCRtpReceiver, responsible for managing the reception of RTP (Real-time Transport Protocol) media streams in a WebRTC connection. It handles decoding and processing incoming audio or video data.

```APIDOC
GstWebRTCRTPReceiver
  - RTCRtpReceiver object
```

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

### GstWebRTCRTPTransceiver

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

This object represents an RTCRtpTransceiver, which combines the functionalities of an RTCRtpSender and an RTCRtpReceiver. It allows for bidirectional RTP media stream management within a single object, simplifying negotiation and control.

```APIDOC
GstWebRTCRTPTransceiver
  - RTCRtpTransceiver object
```

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

### GstWebRTCRTPSender

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

This object represents an RTCRtpSender, responsible for managing the sending of RTP (Real-time Transport Protocol) media streams in a WebRTC connection. It handles encoding and transmitting outgoing audio or video data.

```APIDOC
GstWebRTCRTPSender
  - RTCRtpSender object
```

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

### GstWebRTC.WebRTCDataChannel: buffered-amount Property

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

Represents the amount of data currently buffered to be sent on the data channel. This property is read-only.

```GObject/C
“buffered-amount” guint64
Flags : Read
```

```JavaScript
“buffered-amount” Number
Flags : Read
```

```Python
“self.props.buffered_amount” int
Flags : Read
```

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

### Close GstWebRTCDataChannel Method

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

Provides methods to close an active WebRTC data channel across different language bindings (C, JavaScript, Python).

```C
gst_webrtc_data_channel_close (GstWebRTCDataChannel * channel)

Parameters:
  channel: GstWebRTCDataChannel - A GstWebRTCDataChannel instance.
```

```JavaScript
function GstWebRTC.WebRTCDataChannel.prototype.close(): {
    // javascript wrapper for 'gst_webrtc_data_channel_close'
}

Parameters:
  channel: GstWebRTC.WebRTCDataChannel - A GstWebRTC.WebRTCDataChannel instance.
```

```Python
def GstWebRTC.WebRTCDataChannel.close (self):
    #python wrapper for 'gst_webrtc_data_channel_close'

Parameters:
  channel: GstWebRTC.WebRTCDataChannel - A GstWebRTC.WebRTCDataChannel instance.
```

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

### GstWebRTC.WebRTCDataChannel: send-string Signal

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

Emits a signal to send string data over the WebRTC data channel. This signal is deprecated; use gst_webrtc_data_channel_send_string_full() instead. It takes the data channel instance, the string data to send, and optional user data.

```JavaScript
let ret = self.emit ("send-string", data, user_data);

Parameters:
  self: GstWebRTC.WebRTCDataChannel
  data: String - the data to send as a string
  user_data: Object
Flags: Run Last, Action
Deprecated: 1.22: Use gst_webrtc_data_channel_send_string_full() instead
```

```Python
ret = self.emit ("send-string", data, user_data)

Parameters:
  self: GstWebRTC.WebRTCDataChannel
  data: str - the data to send as a string
  user_data: variadic
Flags: Run Last, Action
Deprecated: 1.22: Use gst_webrtc_data_channel_send_string_full() instead
```

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

### Emit 'close' signal for GstWebRTC.WebRTCDataChannel

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

This signal is emitted to close the WebRTC data channel. It takes the data channel instance and optional user data. The signal is marked with 'Run Last' and 'Action' flags.

```APIDOC
Signal: close
  Description: Close the data channel
  Parameters:
    self: GstWebRTC.WebRTCDataChannel
    user_data: Object (JavaScript) / variadic (Python)
  Flags: Run Last, Action
```

```JavaScript
let ret = self.emit ("close", user_data);
```

```Python
ret = self.emit ("close", user_data)
```

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

### GstWebRTC.WebRTCDataChannel: id Property

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

The unique identifier for the data channel. This property is readable, writable, and can be set only during construction.

```GObject/C
“id” gint
Flags : Read
/ Write
/ Construct Only
```

```JavaScript
“id” Number
Flags : Read
/ Write
/ Construct Only
```

```Python
“self.props.id” int
Flags : Read
/ Write
/ Construct Only
```

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

### GstWebRTCICETransport

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

This object represents an RTCIceTransport, which manages the ICE transport for a WebRTC connection. It handles the negotiation of network candidates and the establishment of the underlying transport for media and data.

```APIDOC
GstWebRTCICETransport
  - RTCIceTransport object
```

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

### Handle GstWebRTC.WebRTCDataChannel on-message-data Signal

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

This signal is emitted when data is received on the WebRTC data channel. It provides callbacks for C and JavaScript to process the incoming GBytes data.

```C
on_message_data_callback (GstWebRTCDataChannel * self,
                          GBytes * data,
                          gpointer user_data)

Parameters:
  self: - No description available
  data: GBytes (nullable) - a GBytes of the data received
  user_data: - No description available
```

```JavaScript
function on_message_data_callback(self: GstWebRTC.WebRTCDataChannel, data: GBytes (not introspectable), user_data: Object): {
    // javascript callback for the 'on-message-data' signal
}

Parameters:
  self: GstWebRTC.WebRTCDataChannel - No description available
  data: GBytes (not introspectable) - a GBytes (not introspectable) of the data received
  user_data: Object - No description available
```

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

### Send String Data over GstWebRTCDataChannel (Deprecated)

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

This function sends a string message over the specified GstWebRTCDataChannel. It is available in C, JavaScript, and Python bindings. This method is deprecated since version 1.22; users should use gst_webrtc_data_channel_send_string_full() instead for future compatibility.

```C
gst_webrtc_data_channel_send_string (GstWebRTCDataChannel * channel,
                                     const gchar * str)
```

```APIDOC
Method: gst_webrtc_data_channel_send_string
Parameters:
  channel: GstWebRTCDataChannel - a GstWebRTCDataChannel
  str: gchar (nullable) - a string or NULL
Deprecated: 1.22 - Use gst_webrtc_data_channel_send_string_full() instead
```

```JavaScript
function GstWebRTC.WebRTCDataChannel.prototype.send_string(str: String): {
    // javascript wrapper for 'gst_webrtc_data_channel_send_string'
}
```

```APIDOC
Method: GstWebRTC.WebRTCDataChannel.prototype.send_string
Parameters:
  channel: GstWebRTC.WebRTCDataChannel - a GstWebRTC.WebRTCDataChannel
  str: String - a string or null
Deprecated: 1.22 - Use gst_webrtc_data_channel_send_string_full() instead
```

```Python
def GstWebRTC.WebRTCDataChannel.send_string (self, str):
    #python wrapper for 'gst_webrtc_data_channel_send_string'
```

```APIDOC
Method: GstWebRTC.WebRTCDataChannel.send_string
Parameters:
  channel: GstWebRTC.WebRTCDataChannel - a GstWebRTC.WebRTCDataChannel
  str: str - a string or None
Deprecated: 1.22 - Use gst_webrtc_data_channel_send_string_full() instead
```

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

### GstWebRTCDataChannel

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

This object represents an RTCDataChannel, which is used for sending and receiving arbitrary data over a WebRTC connection. It provides a reliable, ordered, and bidirectional communication channel, separate from media streams.

```APIDOC
GstWebRTCDataChannel
  - RTCDataChannel object
```

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

### Handle GstWebRTC.WebRTCDataChannel on-close Signal

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

This signal is emitted when the WebRTC data channel is closed. It provides callbacks for JavaScript and Python to handle the channel closure event.

```JavaScript
function on_close_callback(self: GstWebRTC.WebRTCDataChannel, user_data: Object): {
    // javascript callback for the 'on-close' signal
}

Parameters:
  self: GstWebRTC.WebRTCDataChannel - No description available
  user_data: Object - No description available
```

```Python
def on_close_callback (self, *user_data):
    #python callback for the 'on-close' signal

Parameters:
  self: GstWebRTC.WebRTCDataChannel - No description available
  user_data: variadic - No description available
```

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

### Handle GstWebRTC.WebRTCDataChannel on-error Signal

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

This signal is emitted when an error occurs on the WebRTC data channel. It provides callbacks for C, JavaScript, and Python to handle error events, including details about the GError thrown.

```C
on_error_callback (GstWebRTCDataChannel * self,
                   GError * error,
                   gpointer user_data)

Parameters:
  self: - No description available
  error: GError - the GError thrown
  user_data: - No description available
```

```JavaScript
function on_error_callback(self: GstWebRTC.WebRTCDataChannel, error: GError (not introspectable), user_data: Object): {
    // javascript callback for the 'on-error' signal
}

Parameters:
  self: GstWebRTC.WebRTCDataChannel - No description available
  error: GError (not introspectable) - the GError (not introspectable) thrown
  user_data: Object - No description available
```

```Python
def on_error_callback (self, error, *user_data):
    #python callback for the 'on-error' signal

Parameters:
  self: GstWebRTC.WebRTCDataChannel - No description available
  error: GError (not introspectable) - the GError (not introspectable) thrown
  user_data: variadic - No description available
```

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

### GstWebRTCDTLSTransport

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

This object represents an RTCDtlsTransport, responsible for managing the DTLS (Datagram Transport Layer Security) transport for a WebRTC connection. It handles the secure negotiation and encryption of data for media and data channels.

```APIDOC
GstWebRTCDTLSTransport
  - RTCDtlsTransport object
```

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

### GstWebRTC.WebRTCDataChannel: max-packet-lifetime Property

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

The maximum time in milliseconds that a message can be retransmitted. This property is readable, writable, and can be set only during construction.

```GObject/C
“max-packet-lifetime” gint
Flags : Read
/ Write
/ Construct Only
```

```JavaScript
“max-packet-lifetime” Number
Flags : Read
/ Write
/ Construct Only
```

```Python
“self.props.max_packet_lifetime” int
Flags : Read
/ Write
/ Construct Only
```

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

### GstWebRTC.WebRTCDataChannel: max-retransmits Property

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

The maximum number of retransmissions for a message. This property is readable, writable, and can be set only during construction.

```GObject/C
“max-retransmits” gint
Flags : Read
/ Write
/ Construct Only
```

```JavaScript
“max-retransmits” Number
Flags : Read
/ Write
/ Construct Only
```

```Python
“self.props.max_retransmits” int
Flags : Read
/ Write
/ Construct Only
```
Tokens:
Raw