Struct WebRtcTransportOptions

#[non_exhaustive]
pub struct WebRtcTransportOptions {
    pub listen: WebRtcTransportListen,
    pub initial_available_outgoing_bitrate: u32,
    pub enable_udp: bool,
    pub enable_tcp: bool,
    pub prefer_udp: bool,
    pub prefer_tcp: bool,
    pub ice_consent_timeout: u8,
    pub enable_sctp: bool,
    pub num_sctp_streams: NumSctpStreams,
    pub max_sctp_message_size: u32,
    pub sctp_send_buffer_size: u32,
    pub app_data: AppData,
}

WebRtcTransport options.

Notes on usage

• initial_available_outgoing_bitrate is just applied when the consumer endpoint supports REMB or Transport-CC.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

listen: WebRtcTransportListen

How WebRtcTransport should listen on interfaces.

initial_available_outgoing_bitrate: u32

Initial available outgoing bitrate (in bps). Default 600000.

enable_udp: bool

Enable UDP. Default true.

enable_tcp: bool

Enable TCP. Default true if webrtc_server is given, false otherwise.

prefer_udp: bool

Prefer UDP. Default false.

prefer_tcp: bool

Prefer TCP. Default false.

ice_consent_timeout: u8

ICE consent timeout (in seconds). If 0 it is disabled. Default 30.

enable_sctp: bool

Create a SCTP association. Default false.

num_sctp_streams: NumSctpStreams

SCTP streams number.

max_sctp_message_size: u32

Maximum allowed size for SCTP messages sent by DataProducers.

sctp_send_buffer_size: u32

Maximum SCTP send buffer used by DataConsumers. Default 262144.

app_data: AppData

Custom application data.

Implementations

impl WebRtcTransportOptions

pub fn new(listen_infos: WebRtcTransportListenInfos) -> Self

Create WebRtcTransport options with given listen infos.

pub fn new_with_server(webrtc_server: WebRtcServer) -> Self

Create WebRtcTransport options with given WebRtcServer.

Trait Implementations

impl Clone for WebRtcTransportOptions

fn clone(&self) -> WebRtcTransportOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WebRtcTransportOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.