GstWebRTCDataChannel

GObject
    ╰──GstWebRTCDataChannel

Members

parent (GObject) –
No description available
lock (GMutex) –
No description available
label (gchar *) –
No description available
ordered (gboolean) –
No description available
max_packet_lifetime (guint) –
No description available
max_retransmits (guint) –
No description available
protocol (gchar *) –
No description available
negotiated (gboolean) –
No description available
id (gint) –
No description available
priority (GstWebRTCPriorityType) –
No description available
ready_state (GstWebRTCDataChannelState) –
No description available
buffered_amount (guint64) –
No description available
buffered_amount_low_threshold (guint64) –
No description available
_padding (gpointer *) –
No description available

Class structure

GstWebRTCDataChannelClass

Fields
parent_class (GObjectClass) –
No description available
_padding (gpointer *) –
No description available

GstWebRTC.WebRTCDataChannelClass

Attributes
parent_class (GObject.ObjectClass) –
No description available
_padding ([ Object ]) –
No description available

GstWebRTC.WebRTCDataChannelClass

Attributes
parent_class (GObject.ObjectClass) –
No description available
_padding ([ object ]) –
No description available

GstWebRTC.WebRTCDataChannel

GObject.Object
    ╰──GstWebRTC.WebRTCDataChannel

Members

parent (GObject.Object) –
No description available
lock (GLib.Mutex) –
No description available
label (String) –
No description available
ordered (Number) –
No description available
max_packet_lifetime (Number) –
No description available
max_retransmits (Number) –
No description available
protocol (String) –
No description available
negotiated (Number) –
No description available
id (Number) –
No description available
No description available
No description available
buffered_amount (Number) –
No description available
buffered_amount_low_threshold (Number) –
No description available
_padding ([ Object ]) –
No description available

GstWebRTC.WebRTCDataChannel

GObject.Object
    ╰──GstWebRTC.WebRTCDataChannel

Members

parent (GObject.Object) –
No description available
lock (GLib.Mutex) –
No description available
label (str) –
No description available
ordered (bool) –
No description available
max_packet_lifetime (int) –
No description available
max_retransmits (int) –
No description available
protocol (str) –
No description available
negotiated (bool) –
No description available
id (int) –
No description available
No description available
No description available
buffered_amount (int) –
No description available
buffered_amount_low_threshold (int) –
No description available
_padding ([ object ]) –
No description available

Methods

gst_webrtc_data_channel_close

gst_webrtc_data_channel_close (GstWebRTCDataChannel * channel)

Close the channel.

Parameters:

channel

a GstWebRTCDataChannel


GstWebRTC.WebRTCDataChannel.prototype.close

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

Close the channel.


GstWebRTC.WebRTCDataChannel.close

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

Close the channel.


gst_webrtc_data_channel_on_buffered_amount_low

gst_webrtc_data_channel_on_buffered_amount_low (GstWebRTCDataChannel * channel)

Signal that the data channel reached a low buffered amount. Should only be used by subclasses.

Parameters:

channel

a GstWebRTCDataChannel


GstWebRTC.WebRTCDataChannel.prototype.on_buffered_amount_low

function GstWebRTC.WebRTCDataChannel.prototype.on_buffered_amount_low(): {
    // javascript wrapper for 'gst_webrtc_data_channel_on_buffered_amount_low'
}

Signal that the data channel reached a low buffered amount. Should only be used by subclasses.


GstWebRTC.WebRTCDataChannel.on_buffered_amount_low

def GstWebRTC.WebRTCDataChannel.on_buffered_amount_low (self):
    #python wrapper for 'gst_webrtc_data_channel_on_buffered_amount_low'

Signal that the data channel reached a low buffered amount. Should only be used by subclasses.


gst_webrtc_data_channel_on_close

gst_webrtc_data_channel_on_close (GstWebRTCDataChannel * channel)

Signal that the data channel was closed. Should only be used by subclasses.

Parameters:

channel

a GstWebRTCDataChannel


GstWebRTC.WebRTCDataChannel.prototype.on_close

function GstWebRTC.WebRTCDataChannel.prototype.on_close(): {
    // javascript wrapper for 'gst_webrtc_data_channel_on_close'
}

Signal that the data channel was closed. Should only be used by subclasses.


GstWebRTC.WebRTCDataChannel.on_close

def GstWebRTC.WebRTCDataChannel.on_close (self):
    #python wrapper for 'gst_webrtc_data_channel_on_close'

Signal that the data channel was closed. Should only be used by subclasses.


gst_webrtc_data_channel_on_error

gst_webrtc_data_channel_on_error (GstWebRTCDataChannel * channel,
                                  GError * error)

Signal that the data channel had an error. Should only be used by subclasses.

Parameters:

channel

a GstWebRTCDataChannel

error ( [transfer: full] ) –

a GError


GstWebRTC.WebRTCDataChannel.prototype.on_error

function GstWebRTC.WebRTCDataChannel.prototype.on_error(error: GLib.Error): {
    // javascript wrapper for 'gst_webrtc_data_channel_on_error'
}

Signal that the data channel had an error. Should only be used by subclasses.

Parameters:

error ( GLib.Error ) –

a GLib.Error


GstWebRTC.WebRTCDataChannel.on_error

def GstWebRTC.WebRTCDataChannel.on_error (self, error):
    #python wrapper for 'gst_webrtc_data_channel_on_error'

Signal that the data channel had an error. Should only be used by subclasses.

Parameters:

error ( GLib.Error ) –

a GLib.Error


gst_webrtc_data_channel_on_message_data

gst_webrtc_data_channel_on_message_data (GstWebRTCDataChannel * channel,
                                         GBytes * data)

Signal that the data channel received a data message. Should only be used by subclasses.

Parameters:

channel

a GstWebRTCDataChannel

data ( [nullable] ) –

a GBytes or NULL


GstWebRTC.WebRTCDataChannel.prototype.on_message_data

function GstWebRTC.WebRTCDataChannel.prototype.on_message_data(data: GLib.Bytes): {
    // javascript wrapper for 'gst_webrtc_data_channel_on_message_data'
}

Signal that the data channel received a data message. Should only be used by subclasses.

Parameters:

data ( GLib.Bytes ) –

a GLib.Bytes or null


GstWebRTC.WebRTCDataChannel.on_message_data

def GstWebRTC.WebRTCDataChannel.on_message_data (self, data):
    #python wrapper for 'gst_webrtc_data_channel_on_message_data'

Signal that the data channel received a data message. Should only be used by subclasses.

Parameters:

data ( GLib.Bytes ) –

a GLib.Bytes or None


gst_webrtc_data_channel_on_message_string

gst_webrtc_data_channel_on_message_string (GstWebRTCDataChannel * channel,
                                           const gchar * str)

Signal that the data channel received a string message. Should only be used by subclasses.

Parameters:

channel

a GstWebRTCDataChannel

str ( [nullable] ) –

a string or NULL


GstWebRTC.WebRTCDataChannel.prototype.on_message_string

function GstWebRTC.WebRTCDataChannel.prototype.on_message_string(str: String): {
    // javascript wrapper for 'gst_webrtc_data_channel_on_message_string'
}

Signal that the data channel received a string message. Should only be used by subclasses.

Parameters:

str ( String ) –

a string or null


GstWebRTC.WebRTCDataChannel.on_message_string

def GstWebRTC.WebRTCDataChannel.on_message_string (self, str):
    #python wrapper for 'gst_webrtc_data_channel_on_message_string'

Signal that the data channel received a string message. Should only be used by subclasses.

Parameters:

str ( str ) –

a string or None


gst_webrtc_data_channel_on_open

gst_webrtc_data_channel_on_open (GstWebRTCDataChannel * channel)

Signal that the data channel was opened. Should only be used by subclasses.

Parameters:

channel

a GstWebRTCDataChannel


GstWebRTC.WebRTCDataChannel.prototype.on_open

function GstWebRTC.WebRTCDataChannel.prototype.on_open(): {
    // javascript wrapper for 'gst_webrtc_data_channel_on_open'
}

Signal that the data channel was opened. Should only be used by subclasses.


GstWebRTC.WebRTCDataChannel.on_open

def GstWebRTC.WebRTCDataChannel.on_open (self):
    #python wrapper for 'gst_webrtc_data_channel_on_open'

Signal that the data channel was opened. Should only be used by subclasses.


gst_webrtc_data_channel_send_data

gst_webrtc_data_channel_send_data (GstWebRTCDataChannel * channel,
                                   GBytes * data)

Send data as a data message over channel.

Parameters:

channel

a GstWebRTCDataChannel

data ( [nullable] ) –

a GBytes or NULL


GstWebRTC.WebRTCDataChannel.prototype.send_data

function GstWebRTC.WebRTCDataChannel.prototype.send_data(data: GLib.Bytes): {
    // javascript wrapper for 'gst_webrtc_data_channel_send_data'
}

Send data as a data message over channel.

Parameters:

data ( GLib.Bytes ) –

a GLib.Bytes or null


GstWebRTC.WebRTCDataChannel.send_data

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

Send data as a data message over channel.

Parameters:

data ( GLib.Bytes ) –

a GLib.Bytes or None


gst_webrtc_data_channel_send_string

gst_webrtc_data_channel_send_string (GstWebRTCDataChannel * channel,
                                     const gchar * str)

Send str as a string message over channel.

Parameters:

channel

a GstWebRTCDataChannel

str ( [nullable] ) –

a string or NULL


GstWebRTC.WebRTCDataChannel.prototype.send_string

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

Send str as a string message over channel.

Parameters:

str ( String ) –

a string or null


GstWebRTC.WebRTCDataChannel.send_string

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

Send str as a string message over channel.

Parameters:

str ( str ) –

a string or None


Signals

on-buffered-amount-low

on_buffered_amount_low_callback (GstWebRTCDataChannel * self,
                                 gpointer user_data)

Parameters:

self
No description available
user_data
No description available

Flags: Run Last


on-buffered-amount-low

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

Parameters:

No description available
user_data ( Object ) –
No description available

Flags: Run Last


on-buffered-amount-low

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

Parameters:

No description available
user_data ( variadic ) –
No description available

Flags: Run Last


on-close

on_close_callback (GstWebRTCDataChannel * self,
                   gpointer user_data)

Parameters:

self
No description available
user_data
No description available

Flags: Run Last


on-close

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

Parameters:

No description available
user_data ( Object ) –
No description available

Flags: Run Last


on-close

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

Parameters:

No description available
user_data ( variadic ) –
No description available

Flags: Run Last


on-error

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

Parameters:

self
No description available
error

the GError thrown

user_data
No description available

Flags: Run Last


on-error

function on_error_callback(self: GstWebRTC.WebRTCDataChannel, error: GLib.Error, user_data: Object): {
    // javascript callback for the 'on-error' signal
}

Parameters:

No description available
error ( GLib.Error ) –

the GLib.Error thrown

user_data ( Object ) –
No description available

Flags: Run Last


on-error

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

Parameters:

No description available
error ( GLib.Error ) –

the GLib.Error thrown

user_data ( variadic ) –
No description available

Flags: Run Last


on-message-data

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

Parameters:

self
No description available
data ( [nullable] ) –

a GBytes of the data received

user_data
No description available

Flags: Run Last


on-message-data

function on_message_data_callback(self: GstWebRTC.WebRTCDataChannel, data: GLib.Bytes, user_data: Object): {
    // javascript callback for the 'on-message-data' signal
}

Parameters:

No description available
data ( GLib.Bytes ) –

a GLib.Bytes of the data received

user_data ( Object ) –
No description available

Flags: Run Last


on-message-data

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

Parameters:

No description available
data ( GLib.Bytes ) –

a GLib.Bytes of the data received

user_data ( variadic ) –
No description available

Flags: Run Last


on-message-string

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

Parameters:

self
No description available
data ( [nullable] ) –

the data received as a string

user_data
No description available

Flags: Run Last


on-message-string

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

Parameters:

No description available
data ( String ) –

the data received as a string

user_data ( Object ) –
No description available

Flags: Run Last


on-message-string

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

Parameters:

No description available
data ( str ) –

the data received as a string

user_data ( variadic ) –
No description available

Flags: Run Last


on-open

on_open_callback (GstWebRTCDataChannel * self,
                  gpointer user_data)

Parameters:

self
No description available
user_data
No description available

Flags: Run Last


on-open

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

Parameters:

No description available
user_data ( Object ) –
No description available

Flags: Run Last


on-open

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

Parameters:

No description available
user_data ( variadic ) –
No description available

Flags: Run Last


Action Signals

close

g_signal_emit_by_name (self, "close", user_data);

Close the data channel

Parameters:

self ( GstWebRTCDataChannel * ) –
No description available
user_data ( gpointer ) –
No description available

Flags: Run Last / Action


close

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

Close the data channel

Parameters:

No description available
user_data ( Object ) –
No description available

Flags: Run Last / Action


close

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

Close the data channel

Parameters:

No description available
user_data ( variadic ) –
No description available

Flags: Run Last / Action


send-data

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

Parameters:

self ( GstWebRTCDataChannel * ) –
No description available
data ( GBytes * [nullable] ) –

a GBytes with the data

user_data ( gpointer ) –
No description available

Flags: Run Last / Action


send-data

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

Parameters:

No description available
data ( GLib.Bytes ) –

a GLib.Bytes with the data

user_data ( Object ) –
No description available

Flags: Run Last / Action


send-data

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

Parameters:

No description available
data ( GLib.Bytes ) –

a GLib.Bytes with the data

user_data ( variadic ) –
No description available

Flags: Run Last / Action


send-string

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

Parameters:

self ( GstWebRTCDataChannel * ) –
No description available
data ( gchar * [nullable] ) –

the data to send as a string

user_data ( gpointer ) –
No description available

Flags: Run Last / Action


send-string

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

Parameters:

No description available
data ( String ) –

the data to send as a string

user_data ( Object ) –
No description available

Flags: Run Last / Action


send-string

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

Parameters:

No description available
data ( str ) –

the data to send as a string

user_data ( variadic ) –
No description available

Flags: Run Last / Action


Properties

buffered-amount

“buffered-amount” guint64

Flags : Read


buffered-amount

“buffered-amount” Number

Flags : Read


buffered_amount

“self.props.buffered_amount” int

Flags : Read


buffered-amount-low-threshold

“buffered-amount-low-threshold” guint64

Flags : Read / Write


buffered-amount-low-threshold

“buffered-amount-low-threshold” Number

Flags : Read / Write


buffered_amount_low_threshold

“self.props.buffered_amount_low_threshold” int

Flags : Read / Write


id

“id” gint

Flags : Read / Write / Construct Only


id

“id” Number

Flags : Read / Write / Construct Only


id

“self.props.id” int

Flags : Read / Write / Construct Only


label

“label” gchar *

Flags : Read / Write / Construct Only


label

“label” String

Flags : Read / Write / Construct Only


label

“self.props.label” str

Flags : Read / Write / Construct Only


max-packet-lifetime

“max-packet-lifetime” gint

Flags : Read / Write / Construct Only


max-packet-lifetime

“max-packet-lifetime” Number

Flags : Read / Write / Construct Only


max_packet_lifetime

“self.props.max_packet_lifetime” int

Flags : Read / Write / Construct Only


max-retransmits

“max-retransmits” gint

Flags : Read / Write / Construct Only


max-retransmits

“max-retransmits” Number

Flags : Read / Write / Construct Only


max_retransmits

“self.props.max_retransmits” int

Flags : Read / Write / Construct Only


negotiated

“negotiated” gboolean

Flags : Read / Write / Construct Only


negotiated

“negotiated” Number

Flags : Read / Write / Construct Only


negotiated

“self.props.negotiated” bool

Flags : Read / Write / Construct Only


ordered

“ordered” gboolean

Flags : Read / Write / Construct Only


ordered

“ordered” Number

Flags : Read / Write / Construct Only


ordered

“self.props.ordered” bool

Flags : Read / Write / Construct Only


priority

“priority” GstWebRTCPriorityType *

Flags : Read / Write / Construct Only


priority

“priority” GstWebRTC.WebRTCPriorityType

Flags : Read / Write / Construct Only


priority

“self.props.priority” GstWebRTC.WebRTCPriorityType

Flags : Read / Write / Construct Only


protocol

“protocol” gchar *

Flags : Read / Write / Construct Only


protocol

“protocol” String

Flags : Read / Write / Construct Only


protocol

“self.props.protocol” str

Flags : Read / Write / Construct Only


ready-state

“ready-state” GstWebRTCDataChannelState *

Flags : Read


ready-state

“ready-state” GstWebRTC.WebRTCDataChannelState

Flags : Read


ready_state

“self.props.ready_state” GstWebRTC.WebRTCDataChannelState

Flags : Read


Virtual Methods

close

close (GstWebRTCDataChannel * channel)

Parameters:

channel
No description available

vfunc_close

function vfunc_close(channel: GstWebRTC.WebRTCDataChannel): {
    // javascript implementation of the 'close' virtual method
}

Parameters:

channel ( GstWebRTC.WebRTCDataChannel ) –
No description available

do_close

def do_close (channel):
    #python implementation of the 'close' virtual method

Parameters:

channel ( GstWebRTC.WebRTCDataChannel ) –
No description available

send_data

send_data (GstWebRTCDataChannel * channel,
           GBytes * data)

Parameters:

channel
No description available
data
No description available

vfunc_send_data

function vfunc_send_data(channel: GstWebRTC.WebRTCDataChannel, data: GLib.Bytes): {
    // javascript implementation of the 'send_data' virtual method
}

Parameters:

channel ( GstWebRTC.WebRTCDataChannel ) –
No description available
data ( GLib.Bytes ) –
No description available

do_send_data

def do_send_data (channel, data):
    #python implementation of the 'send_data' virtual method

Parameters:

channel ( GstWebRTC.WebRTCDataChannel ) –
No description available
data ( GLib.Bytes ) –
No description available

send_string

send_string (GstWebRTCDataChannel * channel,
             const gchar * str)

Parameters:

channel
No description available
str
No description available

vfunc_send_string

function vfunc_send_string(channel: GstWebRTC.WebRTCDataChannel, str: String): {
    // javascript implementation of the 'send_string' virtual method
}

Parameters:

channel ( GstWebRTC.WebRTCDataChannel ) –
No description available
str ( String ) –
No description available

do_send_string

def do_send_string (channel, str):
    #python implementation of the 'send_string' virtual method

Parameters:

channel ( GstWebRTC.WebRTCDataChannel ) –
No description available
str ( str ) –
No description available

Function Macros

GST_WEBRTC_DATA_CHANNEL_LOCK

#define GST_WEBRTC_DATA_CHANNEL_LOCK(channel) g_mutex_lock(&((GstWebRTCDataChannel *)(channel))->lock)

GST_WEBRTC_DATA_CHANNEL_UNLOCK

#define GST_WEBRTC_DATA_CHANNEL_UNLOCK(channel) g_mutex_unlock(&((GstWebRTCDataChannel *)(channel))->lock)

The results of the search are