GstWebRTC.WebRTCDataChannel¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
|
|
|
|
|
|
|
|
|
Virtual Methods¶
- Inherited:
Properties¶
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r |
The amount of data in bytes currently buffered |
||
r/w |
The threshold at which the buffered amount is considered low and the buffered-amount-low signal is emitted |
||
r/w/co |
ID negotiated by this data channel (-1 = unset) |
||
r/w/co |
Data channel label |
||
r/w/co |
Maximum number of milliseconds that transmissions and retransmissions may occur in unreliable mode (-1 = unset) |
||
r/w/co |
Maximum number of retransmissions attempted in unreliable mode |
||
r/w/co |
Whether this data channel was negotiated by the application |
||
r/w/co |
Using ordered transmission mode |
||
r/w/co |
The priority of data sent using this data channel |
||
r/w/co |
Data channel protocol |
||
r |
The Ready state of this data channel |
Signals¶
- Inherited:
Name |
Short Description |
---|---|
Close the data channel |
|
|
|
Fields¶
- Inherited:
Class Details¶
- class GstWebRTC.WebRTCDataChannel(**kwargs)¶
- Bases:
- Abstract:
Yes
- Structure:
New in version 1.18.
- close()¶
Close the self.
- send_data(data)¶
- Parameters:
data (
GLib.Bytes
orNone
) – aGLib.Bytes
orNone
Send data as a data message over self.
- send_data_full(data)¶
- Parameters:
data (
GLib.Bytes
orNone
) – aGLib.Bytes
orNone
- Raises:
- Returns:
True
if self is open and data could be queued- Return type:
Send data as a data message over self.
New in version 1.22.
- send_string(str)¶
-
Send str as a string message over self.
Signal Details¶
- GstWebRTC.WebRTCDataChannel.signals.close(web_r_t_c_data_channel)¶
- Signal Name:
close
- Flags:
- Parameters:
web_r_t_c_data_channel (
GstWebRTC.WebRTCDataChannel
) – The object which received the signal
Close the data channel
- GstWebRTC.WebRTCDataChannel.signals.on_buffered_amount_low(web_r_t_c_data_channel)¶
- Signal Name:
on-buffered-amount-low
- Flags:
- Parameters:
web_r_t_c_data_channel (
GstWebRTC.WebRTCDataChannel
) – The object which received the signal
- GstWebRTC.WebRTCDataChannel.signals.on_close(web_r_t_c_data_channel)¶
- Signal Name:
on-close
- Flags:
- Parameters:
web_r_t_c_data_channel (
GstWebRTC.WebRTCDataChannel
) – The object which received the signal
- GstWebRTC.WebRTCDataChannel.signals.on_error(web_r_t_c_data_channel, error)¶
- Signal Name:
on-error
- Flags:
- Parameters:
web_r_t_c_data_channel (
GstWebRTC.WebRTCDataChannel
) – The object which received the signalerror (
GLib.Error
) – theGLib.Error
thrown
- GstWebRTC.WebRTCDataChannel.signals.on_message_data(web_r_t_c_data_channel, data)¶
- Signal Name:
on-message-data
- Flags:
- Parameters:
web_r_t_c_data_channel (
GstWebRTC.WebRTCDataChannel
) – The object which received the signaldata (
GLib.Bytes
orNone
) – aGLib.Bytes
of the data received
- GstWebRTC.WebRTCDataChannel.signals.on_message_string(web_r_t_c_data_channel, data)¶
- Signal Name:
on-message-string
- Flags:
- Parameters:
web_r_t_c_data_channel (
GstWebRTC.WebRTCDataChannel
) – The object which received the signal
- GstWebRTC.WebRTCDataChannel.signals.on_open(web_r_t_c_data_channel)¶
- Signal Name:
on-open
- Flags:
- Parameters:
web_r_t_c_data_channel (
GstWebRTC.WebRTCDataChannel
) – The object which received the signal
- GstWebRTC.WebRTCDataChannel.signals.send_data(web_r_t_c_data_channel, data)¶
- Signal Name:
send-data
- Flags:
- Parameters:
web_r_t_c_data_channel (
GstWebRTC.WebRTCDataChannel
) – The object which received the signaldata (
GLib.Bytes
orNone
) – aGLib.Bytes
with the data
Deprecated since version ???.
Property Details¶
- GstWebRTC.WebRTCDataChannel.props.buffered_amount¶
-
The amount of data in bytes currently buffered
- GstWebRTC.WebRTCDataChannel.props.buffered_amount_low_threshold¶
-
The threshold at which the buffered amount is considered low and the buffered-amount-low signal is emitted
- GstWebRTC.WebRTCDataChannel.props.id¶
- Name:
id
- Type:
- Default Value:
-1
- Flags:
ID negotiated by this data channel (-1 = unset)
- GstWebRTC.WebRTCDataChannel.props.label¶
- Name:
label
- Type:
- Default Value:
- Flags:
Data channel label
- GstWebRTC.WebRTCDataChannel.props.max_packet_lifetime¶
- Name:
max-packet-lifetime
- Type:
- Default Value:
-1
- Flags:
Maximum number of milliseconds that transmissions and retransmissions may occur in unreliable mode (-1 = unset)
- GstWebRTC.WebRTCDataChannel.props.max_retransmits¶
- Name:
max-retransmits
- Type:
- Default Value:
0
- Flags:
Maximum number of retransmissions attempted in unreliable mode
- GstWebRTC.WebRTCDataChannel.props.negotiated¶
- Name:
negotiated
- Type:
- Default Value:
- Flags:
Whether this data channel was negotiated by the application
- GstWebRTC.WebRTCDataChannel.props.ordered¶
- Name:
ordered
- Type:
- Default Value:
- Flags:
Using ordered transmission mode
- GstWebRTC.WebRTCDataChannel.props.priority¶
- Name:
priority
- Type:
- Default Value:
- Flags:
The priority of data sent using this data channel
- GstWebRTC.WebRTCDataChannel.props.protocol¶
- Name:
protocol
- Type:
- Default Value:
''
- Flags:
Data channel protocol
- GstWebRTC.WebRTCDataChannel.props.ready_state¶
- Name:
ready-state
- Type:
- Default Value:
- Flags:
The Ready state of this data channel