Struct mediasoup::plain_transport::PlainTransportOptions

#[non_exhaustive]
pub struct PlainTransportOptions {
    pub listen_ip: TransportListenIp,
    pub port: Option<u16>,
    pub rtcp_mux: bool,
    pub comedia: bool,
    pub enable_sctp: bool,
    pub num_sctp_streams: NumSctpStreams,
    pub max_sctp_message_size: u32,
    pub sctp_send_buffer_size: u32,
    pub enable_srtp: bool,
    pub srtp_crypto_suite: SrtpCryptoSuite,
    pub app_data: AppData,
}

PlainTransport options.

Notes on usage

• Note that comedia mode just makes sense when the remote endpoint is gonna produce RTP on this plain transport. Otherwise, if the remote endpoint does not send any RTP (or SCTP) packet to mediasoup, there is no way to detect its remote RTP IP and port, so the endpoint won’t receive any packet from mediasoup.
• In other words, do not use comedia mode if the remote endpoint is not going to produce RTP but just consume it. In those cases, do not set comedia flag and call PlainTransport::connect() with the IP and port(s) of the remote endpoint.

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_ip: TransportListenIp

Listening IP address.

port: Option<u16>

Fixed port to listen on instead of selecting automatically from Worker’s port range.

rtcp_mux: bool

Use RTCP-mux (RTP and RTCP in the same port). Default true.

comedia: bool

Whether remote IP:port should be auto-detected based on first RTP/RTCP packet received. If enabled, connect() method must not be called unless SRTP is enabled. If so, it must be called with just remote SRTP parameters. Default false.

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. Default 262144.

sctp_send_buffer_size: u32

Maximum SCTP send buffer used by DataConsumers. Default 262144.

enable_srtp: bool

Enable SRTP. For this to work, connect() must be called with remote SRTP parameters. Default false.

srtp_crypto_suite: SrtpCryptoSuite

The SRTP crypto suite to be used if enableSrtp is set. Default ‘AesCm128HmacSha180’.

app_data: AppData

Custom application data.

Implementations

impl PlainTransportOptions

pub fn new(listen_ip: TransportListenIp) -> Self

Create Plain transport options with given listen IP.

Trait Implementations

impl Clone for PlainTransportOptions

fn clone(&self) -> PlainTransportOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PlainTransportOptions

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

Formats the value using the given formatter.