GstWebRTC.WebRTCICE¶

Subclasses:: None

Methods¶

Inherited:: Gst.Object (27), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

	`add_candidate` (stream, candidate, promise)
	`add_stream` (session_id)
	`add_turn_server` (uri)
	`find_transport` (stream, component)
	`gather_candidates` (stream)
	`get_http_proxy` ()
	`get_is_controller` ()
	`get_local_candidates` (stream)
	`get_remote_candidates` (stream)
	`get_selected_pair` (stream)
	`get_stun_server` ()
	`get_turn_server` ()
	`set_force_relay` (force_relay)
	`set_http_proxy` (uri)
	`set_is_controller` (controller)
	`set_local_credentials` (stream, ufrag, pwd)
	`set_on_ice_candidate` (func, *user_data)
	`set_remote_credentials` (stream, ufrag, pwd)
	`set_stun_server` (uri)
	`set_tos` (stream, tos)
	`set_turn_server` (uri)

Virtual Methods¶

Inherited:: Gst.Object (1), GObject.Object (7)

	`do_add_candidate` (stream, candidate, promise)
	`do_add_stream` (session_id)
	`do_add_turn_server` (uri)
	`do_find_transport` (stream, component)
	`do_gather_candidates` (stream)
	`do_get_http_proxy` ()
	`do_get_is_controller` ()
	`do_get_local_candidates` (stream)
	`do_get_remote_candidates` (stream)
	`do_get_selected_pair` (stream)
	`do_get_stun_server` ()
	`do_get_turn_server` ()
	`do_set_force_relay` (force_relay)
	`do_set_http_proxy` (uri)
	`do_set_is_controller` (controller)
	`do_set_local_credentials` (stream, ufrag, pwd)
	`do_set_on_ice_candidate` (func, *user_data)
	`do_set_remote_credentials` (stream, ufrag, pwd)
	`do_set_stun_server` (uri)
	`do_set_tos` (stream, tos)
	`do_set_turn_server` (uri)

Properties¶

Inherited:: Gst.Object (2)

Name	Type	Flags	Short Description
`max-rtp-port`	`int`	r/w/c	Maximum port for local rtp port range. max-rtp-port must be >= min-rtp-port
`min-rtp-port`	`int`	r/w/c	Minimum port for local rtp port range. min-rtp-port must be <= max-rtp-port

Signals¶

Inherited:: Gst.Object (1), GObject.Object (1)

Name	Short Description
`add-local-ip-address`	Add a local IP address to use for ICE candidate gathering.

Fields¶

Inherited:: Gst.Object (1), GObject.Object (1)

Name	Type	Access
ice_connection_state	`GstWebRTC.WebRTCICEConnectionState`	r
ice_gathering_state	`GstWebRTC.WebRTCICEGatheringState`	r
max_rtp_port	`int`	r
min_rtp_port	`int`	r
parent	`Gst.Object`	r

Class Details¶

class GstWebRTC.WebRTCICE(**kwargs)¶

Bases:: Gst.Object
Abstract:: Yes
Structure:: GstWebRTC.WebRTCICEClass

New in version 1.22.

add_candidate(stream, candidate, promise)¶

Parameters:

stream (GstWebRTC.WebRTCICEStream) – The GstWebRTC.WebRTCICEStream
candidate (str) – The ICE candidate
promise (Gst.Promise or None) – A Gst.Promise for task notifications

New in version 1.22.

add_stream(session_id)¶

Parameters:: session_id (int) – The session id
Returns:: The GstWebRTC.WebRTCICEStream, or None
Return type:: GstWebRTC.WebRTCICEStream or None

New in version 1.22.

add_turn_server(uri)¶

Parameters:: uri (str) – URI of the TURN server
Returns:: False on error, True otherwise
Return type:: bool

New in version 1.22.

find_transport(stream, component)¶

Parameters:

stream (GstWebRTC.WebRTCICEStream) – The GstWebRTC.WebRTCICEStream
component (GstWebRTC.WebRTCICEComponent) – The GstWebRTC.WebRTCICEComponent

Returns:

The GstWebRTC.WebRTCICETransport, or None

Return type:

GstWebRTC.WebRTCICETransport or None

New in version 1.22.

gather_candidates(stream)¶

Parameters:: stream (GstWebRTC.WebRTCICEStream) – The GstWebRTC.WebRTCICEStream
Returns:: False on error, True otherwise
Return type:: bool

New in version 1.22.

get_http_proxy()¶

Returns:

URI of the HTTP proxy of the form http://[username:password@]hostname’:port [?alpn=<alpn>]’

Get HTTP Proxy to be used when connecting to TURN server.

Return type:

str

New in version 1.22.

get_is_controller()¶

Returns:: True if set as controller, False otherwise
Return type:: bool

New in version 1.22.

get_local_candidates(stream)¶

Parameters:: stream (GstWebRTC.WebRTCICEStream) – The GstWebRTC.WebRTCICEStream
Returns:: List of local candidates
Return type:: [GstWebRTC.WebRTCICECandidateStats]

New in version 1.22.

get_remote_candidates(stream)¶

Parameters:: stream (GstWebRTC.WebRTCICEStream) – The GstWebRTC.WebRTCICEStream
Returns:: List of remote candidates
Return type:: [GstWebRTC.WebRTCICECandidateStats]

New in version 1.22.

get_selected_pair(stream)¶

Parameters:

stream (GstWebRTC.WebRTCICEStream) – The GstWebRTC.WebRTCICEStream

Returns:

False on failure, otherwise local_stats remote_stats will be set

local_stats:: A pointer to GstWebRTC.WebRTCICECandidateStats for local candidate
remote_stats:: pointer to GstWebRTC.WebRTCICECandidateStats for remote candidate

Return type:

(bool, local_stats: GstWebRTC.WebRTCICECandidateStats, remote_stats: GstWebRTC.WebRTCICECandidateStats)

New in version 1.22.

get_stun_server()¶

Returns:: URI of the STUN sever
Return type:: str or None

New in version 1.22.

get_turn_server()¶

Returns:: URI of the TURN sever
Return type:: str or None

New in version 1.22.

set_force_relay(force_relay)¶

Parameters:: force_relay (bool) – True to enable force relay

New in version 1.22.

set_http_proxy(uri)¶

Parameters:: uri (str) – URI of the HTTP proxy of the form http://[username:password@]hostname’:port [?alpn=<alpn>]’

Set HTTP Proxy to be used when connecting to TURN server.

New in version 1.22.

set_is_controller(controller)¶

Parameters:: controller (bool) – True to set as controller

New in version 1.22.

set_local_credentials(stream, ufrag, pwd)¶

Parameters:

stream (GstWebRTC.WebRTCICEStream) – The GstWebRTC.WebRTCICEStream
ufrag (str) – ICE username
pwd (str) – ICE password

Returns:

False on error, True otherwise

Return type:

bool

New in version 1.22.

set_on_ice_candidate(func, *user_data)¶

Parameters:

func (GstWebRTC.WebRTCICEOnCandidateFunc) – The GstWebRTC.WebRTCICEOnCandidateFunc callback function
user_data (object or None) – User data passed to the callback function

New in version 1.22.

set_remote_credentials(stream, ufrag, pwd)¶

Parameters:

stream (GstWebRTC.WebRTCICEStream) – The GstWebRTC.WebRTCICEStream
ufrag (str) – ICE username
pwd (str) – ICE password

Returns:

False on error, True otherwise

Return type:

bool

New in version 1.22.

set_stun_server(uri)¶

Parameters:: uri (str or None) – URI of the STUN server

New in version 1.22.

set_tos(stream, tos)¶

Parameters:

stream (GstWebRTC.WebRTCICEStream) – The GstWebRTC.WebRTCICEStream
tos (int) – ToS to be set

New in version 1.22.

set_turn_server(uri)¶

Parameters:: uri (str or None) – URI of the TURN sever

New in version 1.22.

do_add_candidate(stream, candidate, promise) virtual¶

Parameters:

stream (GstWebRTC.WebRTCICEStream) – The GstWebRTC.WebRTCICEStream
candidate (str) – The ICE candidate
promise (Gst.Promise or None) – A Gst.Promise for task notifications

New in version 1.22.

do_add_stream(session_id) virtual¶

Parameters:: session_id (int) – The session id
Returns:: The GstWebRTC.WebRTCICEStream, or None
Return type:: GstWebRTC.WebRTCICEStream or None

New in version 1.22.

do_add_turn_server(uri) virtual¶

Parameters:: uri (str) – URI of the TURN server
Returns:: False on error, True otherwise
Return type:: bool

New in version 1.22.

do_find_transport(stream, component) virtual¶

Parameters:

stream (GstWebRTC.WebRTCICEStream) – The GstWebRTC.WebRTCICEStream
component (GstWebRTC.WebRTCICEComponent) – The GstWebRTC.WebRTCICEComponent

Returns:

The GstWebRTC.WebRTCICETransport, or None

Return type:

GstWebRTC.WebRTCICETransport or None

New in version 1.22.

do_gather_candidates(stream) virtual¶

Parameters:: stream (GstWebRTC.WebRTCICEStream) – The GstWebRTC.WebRTCICEStream
Returns:: False on error, True otherwise
Return type:: bool

New in version 1.22.

do_get_http_proxy() virtual¶

Returns:

URI of the HTTP proxy of the form http://[username:password@]hostname’:port [?alpn=<alpn>]’

Get HTTP Proxy to be used when connecting to TURN server.

Return type:

str

Get HTTP Proxy to be used when connecting to TURN server.

New in version 1.22.

do_get_is_controller() virtual¶

Returns:: True if set as controller, False otherwise
Return type:: bool

New in version 1.22.

do_get_local_candidates(stream) virtual¶

Parameters:: stream (GstWebRTC.WebRTCICEStream) –
Return type:: GstWebRTC.WebRTCICECandidateStats

do_get_remote_candidates(stream) virtual¶

Parameters:: stream (GstWebRTC.WebRTCICEStream) –
Return type:: GstWebRTC.WebRTCICECandidateStats

do_get_selected_pair(stream) virtual¶

Parameters:

stream (GstWebRTC.WebRTCICEStream) – The GstWebRTC.WebRTCICEStream

Returns:

False on failure, otherwise local_stats remote_stats will be set

local_stats:: A pointer to GstWebRTC.WebRTCICECandidateStats for local candidate
remote_stats:: pointer to GstWebRTC.WebRTCICECandidateStats for remote candidate

Return type:

(bool, local_stats: GstWebRTC.WebRTCICECandidateStats, remote_stats: GstWebRTC.WebRTCICECandidateStats)

New in version 1.22.

do_get_stun_server() virtual¶

Returns:: URI of the STUN sever
Return type:: str or None

New in version 1.22.

do_get_turn_server() virtual¶

Returns:: URI of the TURN sever
Return type:: str or None

New in version 1.22.

do_set_force_relay(force_relay) virtual¶

Parameters:: force_relay (bool) – True to enable force relay

New in version 1.22.

do_set_http_proxy(uri) virtual¶

Parameters:: uri (str) – URI of the HTTP proxy of the form http://[username:password@]hostname’:port [?alpn=<alpn>]’

Set HTTP Proxy to be used when connecting to TURN server.

New in version 1.22.

do_set_is_controller(controller) virtual¶

Parameters:: controller (bool) – True to set as controller

New in version 1.22.

do_set_local_credentials(stream, ufrag, pwd) virtual¶

Parameters:

stream (GstWebRTC.WebRTCICEStream) – The GstWebRTC.WebRTCICEStream
ufrag (str) – ICE username
pwd (str) – ICE password

Returns:

False on error, True otherwise

Return type:

bool

New in version 1.22.

do_set_on_ice_candidate(func, *user_data) virtual¶

Parameters:

func (GstWebRTC.WebRTCICEOnCandidateFunc) – The GstWebRTC.WebRTCICEOnCandidateFunc callback function
user_data (object or None) – User data passed to the callback function

New in version 1.22.

do_set_remote_credentials(stream, ufrag, pwd) virtual¶

Parameters:

stream (GstWebRTC.WebRTCICEStream) – The GstWebRTC.WebRTCICEStream
ufrag (str) – ICE username
pwd (str) – ICE password

Returns:

False on error, True otherwise

Return type:

bool

New in version 1.22.

do_set_stun_server(uri) virtual¶

Parameters:: uri (str or None) – URI of the STUN server

New in version 1.22.

do_set_tos(stream, tos) virtual¶

Parameters:

stream (GstWebRTC.WebRTCICEStream) – The GstWebRTC.WebRTCICEStream
tos (int) – ToS to be set

New in version 1.22.

do_set_turn_server(uri) virtual¶

Parameters:: uri (str or None) – URI of the TURN sever

New in version 1.22.

Signal Details¶

GstWebRTC.WebRTCICE.signals.add_local_ip_address(web_r_t_c_i_c_e, address)¶

Signal Name:

add-local-ip-address

Flags:

RUN_LAST, ACTION

Parameters:

web_r_t_c_i_c_e (GstWebRTC.WebRTCICE) – The object which received the signal
address (str) – The local IP address

Returns:

whether the address could be added.

Return type:

bool

Add a local IP address to use for ICE candidate gathering. If none are supplied, they will be discovered automatically. Calling this signal stops automatic ICE gathering.

Property Details¶

GstWebRTC.WebRTCICE.props.max_rtp_port¶

Name:: max-rtp-port
Type:: int
Default Value:: 65535
Flags:: READABLE, WRITABLE, CONSTRUCT

Maximum port for local rtp port range. min-rtp-port must be <= max-rtp-port

New in version 1.20.

GstWebRTC.WebRTCICE.props.min_rtp_port¶

Name:: min-rtp-port
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT

Minimum port for local rtp port range. min-rtp-port must be <= max-rtp-port

New in version 1.20.