Trait gstreamer_webrtc::prelude::WebRTCICEExt

source · 
pub trait WebRTCICEExt:
    IsA<WebRTCICE>
    + Sealed
    + 'static {

Show 28 methods    // Provided methods
    fn add_stream(&self, session_id: u32) -> Option<WebRTCICEStream> { ... }
    fn add_turn_server(&self, uri: &str) -> bool { ... }
    fn find_transport(
        &self,
        stream: &impl IsA<WebRTCICEStream>,
        component: WebRTCICEComponent,
    ) -> Option<WebRTCICETransport> { ... }
    fn gather_candidates(&self, stream: &impl IsA<WebRTCICEStream>) -> bool { ... }
    fn http_proxy(&self) -> GString { ... }
    fn is_controller(&self) -> bool { ... }
    fn local_candidates(
        &self,
        stream: &impl IsA<WebRTCICEStream>,
    ) -> Vec<WebRTCICECandidateStats> { ... }
    fn remote_candidates(
        &self,
        stream: &impl IsA<WebRTCICEStream>,
    ) -> Vec<WebRTCICECandidateStats> { ... }
    fn selected_pair(
        &self,
        stream: &impl IsA<WebRTCICEStream>,
    ) -> Option<(WebRTCICECandidateStats, WebRTCICECandidateStats)> { ... }
    fn stun_server(&self) -> Option<GString> { ... }
    fn turn_server(&self) -> Option<GString> { ... }
    fn set_force_relay(&self, force_relay: bool) { ... }
    fn set_http_proxy(&self, uri: &str) { ... }
    fn set_is_controller(&self, controller: bool) { ... }
    fn set_local_credentials(
        &self,
        stream: &impl IsA<WebRTCICEStream>,
        ufrag: &str,
        pwd: &str,
    ) -> bool { ... }
    fn set_on_ice_candidate<P: Fn(&WebRTCICE, u32, &str) + Send + Sync + 'static>(
        &self,
        func: P,
    ) { ... }
    fn set_remote_credentials(
        &self,
        stream: &impl IsA<WebRTCICEStream>,
        ufrag: &str,
        pwd: &str,
    ) -> bool { ... }
    fn set_stun_server(&self, uri: Option<&str>) { ... }
    fn set_tos(&self, stream: &impl IsA<WebRTCICEStream>, tos: u32) { ... }
    fn set_turn_server(&self, uri: Option<&str>) { ... }
    fn max_rtp_port(&self) -> u32 { ... }
    fn set_max_rtp_port(&self, max_rtp_port: u32) { ... }
    fn min_rtp_port(&self) -> u32 { ... }
    fn set_min_rtp_port(&self, min_rtp_port: u32) { ... }
    fn connect_add_local_ip_address<F: Fn(&Self, &str) -> bool + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn emit_add_local_ip_address(&self, address: &str) -> bool { ... }
    fn connect_max_rtp_port_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }
    fn connect_min_rtp_port_notify<F: Fn(&Self) + Send + Sync + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId { ... }

}
Expand description

Trait containing all WebRTCICE methods.

§Implementors

WebRTCICE

Provided Methods§

source

fn add_stream(&self, session_id: u32) -> Option<WebRTCICEStream>

§session_id

The session id

§Returns

The WebRTCICEStream, or None

source

fn add_turn_server(&self, uri: &str) -> bool

§uri

URI of the TURN server

§Returns

FALSE on error, TRUE otherwise

source

fn find_transport( &self, stream: &impl IsA<WebRTCICEStream>, component: WebRTCICEComponent, ) -> Option<WebRTCICETransport>

§stream

The WebRTCICEStream

§component

The WebRTCICEComponent

§Returns

The WebRTCICETransport, or None

source

fn gather_candidates(&self, stream: &impl IsA<WebRTCICEStream>) -> bool

§stream

The WebRTCICEStream

§Returns

FALSE on error, TRUE otherwise

source

fn http_proxy(&self) -> GString

§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.

source

fn is_controller(&self) -> bool

§Returns

TRUE if set as controller, FALSE otherwise

source

fn local_candidates( &self, stream: &impl IsA<WebRTCICEStream>, ) -> Vec<WebRTCICECandidateStats>

§stream

The WebRTCICEStream

§Returns

List of local candidates

source

fn remote_candidates( &self, stream: &impl IsA<WebRTCICEStream>, ) -> Vec<WebRTCICECandidateStats>

§stream

The WebRTCICEStream

§Returns

List of remote candidates

source

fn selected_pair( &self, stream: &impl IsA<WebRTCICEStream>, ) -> Option<(WebRTCICECandidateStats, WebRTCICECandidateStats)>

§stream

The WebRTCICEStream

§Returns

FALSE on failure, otherwise local_stats remote_stats will be set

§local_stats

A pointer to WebRTCICECandidateStats for local candidate

§remote_stats

pointer to WebRTCICECandidateStats for remote candidate

source

fn stun_server(&self) -> Option<GString>

§Returns

URI of the STUN sever

source

fn turn_server(&self) -> Option<GString>

§Returns

URI of the TURN sever

source

fn set_force_relay(&self, force_relay: bool)

§force_relay

TRUE to enable force relay

source

fn set_http_proxy(&self, uri: &str)

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

§uri

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

source

fn set_is_controller(&self, controller: bool)

§controller

TRUE to set as controller

source

fn set_local_credentials( &self, stream: &impl IsA<WebRTCICEStream>, ufrag: &str, pwd: &str, ) -> bool

§stream

The WebRTCICEStream

§ufrag

ICE username

§pwd

ICE password

§Returns

FALSE on error, TRUE otherwise

source

fn set_on_ice_candidate<P: Fn(&WebRTCICE, u32, &str) + Send + Sync + 'static>( &self, func: P, )

§func

The GstWebRTCICEOnCandidateFunc callback function

§notify

a GDestroyNotify when the candidate is no longer needed

source

fn set_remote_credentials( &self, stream: &impl IsA<WebRTCICEStream>, ufrag: &str, pwd: &str, ) -> bool

§stream

The WebRTCICEStream

§ufrag

ICE username

§pwd

ICE password

§Returns

FALSE on error, TRUE otherwise

source

fn set_stun_server(&self, uri: Option<&str>)

§uri

URI of the STUN server

source

fn set_tos(&self, stream: &impl IsA<WebRTCICEStream>, tos: u32)

§stream

The WebRTCICEStream

§tos

ToS to be set

source

fn set_turn_server(&self, uri: Option<&str>)

§uri

URI of the TURN sever

source

fn max_rtp_port(&self) -> u32

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

source

fn set_max_rtp_port(&self, max_rtp_port: u32)

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

source

fn min_rtp_port(&self) -> u32

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

source

fn set_min_rtp_port(&self, min_rtp_port: u32)

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

source

fn connect_add_local_ip_address<F: Fn(&Self, &str) -> bool + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

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.

§address

The local IP address

§Returns

whether the address could be added.

source

fn emit_add_local_ip_address(&self, address: &str) -> bool

source

fn connect_max_rtp_port_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

source

fn connect_min_rtp_port_notify<F: Fn(&Self) + Send + Sync + 'static>( &self, f: F, ) -> SignalHandlerId

Object Safety§

This trait is not object safe.

Implementors§