GstWebRTC.WebRTCDataChannel¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`close` ()
	`send_data` (data)
	`send_data_full` (data)
	`send_string` (str)
	`send_string_full` (str)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`buffered-amount`	`int`	r	The amount of data in bytes currently buffered
`buffered-amount-low-threshold`	`int`	r/w	The threshold at which the buffered amount is considered low and the buffered-amount-low signal is emitted
`id`	`int`	r/w/co	ID negotiated by this data channel (-1 = unset)
`label`	`str`	r/w/co	Data channel label
`max-packet-lifetime`	`int`	r/w/co	Maximum number of milliseconds that transmissions and retransmissions may occur in unreliable mode (-1 = unset)
`max-retransmits`	`int`	r/w/co	Maximum number of retransmissions attempted in unreliable mode
`negotiated`	`bool`	r/w/co	Whether this data channel was negotiated by the application
`ordered`	`bool`	r/w/co	Using ordered transmission mode
`priority`	`GstWebRTC.WebRTCPriorityType`	r/w/co	The priority of data sent using this data channel
`protocol`	`str`	r/w/co	Data channel protocol
`ready-state`	`GstWebRTC.WebRTCDataChannelState`	r	The Ready state of this data channel

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`close`	Close the data channel
`on-buffered-amount-low`
`on-close`
`on-error`
`on-message-data`
`on-message-string`
`on-open`
`send-data`	`deprecated`
`send-string`

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class GstWebRTC.WebRTCDataChannel(**kwargs)¶

Bases:: GObject.Object
Abstract:: Yes
Structure:: GstWebRTC.WebRTCDataChannelClass

New in version 1.18.

close()¶: Close the self.

send_data(data)¶

Parameters:: data (GLib.Bytes or None) – a GLib.Bytes or None

Send data as a data message over self.

send_data_full(data)¶

Parameters:: data (GLib.Bytes or None) – a GLib.Bytes or None
Raises:: GLib.Error
Returns:: True if self is open and data could be queued
Return type:: bool

Send data as a data message over self.

New in version 1.22.

send_string(str)¶

Parameters:: str (str or None) – a string or None

Send str as a string message over self.

send_string_full(str)¶

Parameters:: str (str or None) – a string or None
Raises:: GLib.Error
Returns:: True if self is open and data could be queued
Return type:: bool

Send str as a string message over self.

New in version 1.22.

Signal Details¶

GstWebRTC.WebRTCDataChannel.signals.close(web_r_t_c_data_channel)¶

Signal Name:: close
Flags:: RUN_LAST, ACTION
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:: RUN_LAST
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:: RUN_LAST
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:

RUN_LAST

Parameters:

web_r_t_c_data_channel (GstWebRTC.WebRTCDataChannel) – The object which received the signal
error (GLib.Error) – the GLib.Error thrown

GstWebRTC.WebRTCDataChannel.signals.on_message_data(web_r_t_c_data_channel, data)¶

Signal Name:

on-message-data

Flags:

RUN_LAST

Parameters:

web_r_t_c_data_channel (GstWebRTC.WebRTCDataChannel) – The object which received the signal
data (GLib.Bytes or None) – a GLib.Bytes of the data received

GstWebRTC.WebRTCDataChannel.signals.on_message_string(web_r_t_c_data_channel, data)¶

Signal Name:

on-message-string

Flags:

RUN_LAST

Parameters:

web_r_t_c_data_channel (GstWebRTC.WebRTCDataChannel) – The object which received the signal
data (str or None) – the data received as a string

GstWebRTC.WebRTCDataChannel.signals.on_open(web_r_t_c_data_channel)¶

Signal Name:: on-open
Flags:: RUN_LAST
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:

RUN_LAST, ACTION, DEPRECATED

Parameters:

web_r_t_c_data_channel (GstWebRTC.WebRTCDataChannel) – The object which received the signal
data (GLib.Bytes or None) – a GLib.Bytes with the data

Deprecated since version ???.

GstWebRTC.WebRTCDataChannel.signals.send_string(web_r_t_c_data_channel, data)¶

Signal Name:

send-string

Flags:

RUN_LAST, ACTION

Parameters:

web_r_t_c_data_channel (GstWebRTC.WebRTCDataChannel) – The object which received the signal
data (str or None) – the data to send as a string

Property Details¶

GstWebRTC.WebRTCDataChannel.props.buffered_amount¶

Name:: buffered-amount
Type:: int
Default Value:: 0
Flags:: READABLE

The amount of data in bytes currently buffered

GstWebRTC.WebRTCDataChannel.props.buffered_amount_low_threshold¶

Name:: buffered-amount-low-threshold
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

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:: int
Default Value:: -1
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

ID negotiated by this data channel (-1 = unset)

GstWebRTC.WebRTCDataChannel.props.label¶

Name:: label
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Data channel label

GstWebRTC.WebRTCDataChannel.props.max_packet_lifetime¶

Name:: max-packet-lifetime
Type:: int
Default Value:: -1
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Maximum number of milliseconds that transmissions and retransmissions may occur in unreliable mode (-1 = unset)

GstWebRTC.WebRTCDataChannel.props.max_retransmits¶

Name:: max-retransmits
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Maximum number of retransmissions attempted in unreliable mode

GstWebRTC.WebRTCDataChannel.props.negotiated¶

Name:: negotiated
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Whether this data channel was negotiated by the application

GstWebRTC.WebRTCDataChannel.props.ordered¶

Name:: ordered
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Using ordered transmission mode

GstWebRTC.WebRTCDataChannel.props.priority¶

Name:: priority
Type:: GstWebRTC.WebRTCPriorityType
Default Value:: GstWebRTC.WebRTCPriorityType.LOW
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The priority of data sent using this data channel

GstWebRTC.WebRTCDataChannel.props.protocol¶

Name:: protocol
Type:: str
Default Value:: ''
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

Data channel protocol

GstWebRTC.WebRTCDataChannel.props.ready_state¶

Name:: ready-state
Type:: GstWebRTC.WebRTCDataChannelState
Default Value:: GstWebRTC.WebRTCDataChannelState.CONNECTING
Flags:: READABLE

The Ready state of this data channel