Struct ProducerOptions

#[non_exhaustive]
pub struct ProducerOptions {
    pub kind: MediaKind,
    pub rtp_parameters: RtpParameters,
    pub paused: bool,
    pub key_frame_request_delay: u32,
    pub app_data: AppData,
    /* private fields */
}

Producer options.

Notes on usage

Check the RTP Parameters and Capabilities section for more details (TypeScript-oriented, but concepts apply here as well).

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.

kind: MediaKind

Media kind.

rtp_parameters: RtpParameters

RTP parameters defining what the endpoint is sending.

paused: bool

Whether the producer must start in paused mode. Default false.

key_frame_request_delay: u32

Just for video. Time (in ms) before asking the sender for a new key frame after having asked a previous one. If 0 there is no delay.

app_data: AppData

Custom application data.

Implementations

impl ProducerOptions

pub fn new_pipe_transport( producer_id: ProducerId, kind: MediaKind, rtp_parameters: RtpParameters, ) -> Self

Create producer options that will be used with Pipe transport

pub fn new(kind: MediaKind, rtp_parameters: RtpParameters) -> Self

Create producer options that will be used with non-Pipe transport

Trait Implementations

impl Clone for ProducerOptions

fn clone(&self) -> ProducerOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProducerOptions

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

Formats the value using the given formatter.