Struct CodecStringOptions 

pub struct CodecStringOptions { /* private fields */ }

Controls which qualifiers appear in a CodecStringEntry built from an SdpCodec.

Audio defaults emit rate, ptime, bitrate, and channels but not fmtp (see docs/codec-string-format.md — audio fmtp in the codec string does not reach a generated offer unless the leg has a bridged partner). Video entries emit only name and fmtp, no numeric qualifiers.

This deliberately deviates from FreeSWITCH’s own add_audio_codec, which emits @<n>c only when channels > 1 and never emits @<n>b and @<n>c together — the two share one format buffer, so one overwrites the other (switch_core_media.c:13530-13536, see docs/codec-string-format.md). Audio defaults here emit @1c on every mono codec and can emit both qualifiers at once. This is behaviourally neutral for matching and dedup — an absent channel count normalizes to 1 either way — but it is not a byte-for-byte port of upstream’s emission quirk.

Implementations

impl CodecStringOptions

pub fn audio() -> Self

Default options for audio: rate, ptime, bitrate, channels on; fmtp off.

pub fn video() -> Self

Options for video: only name and fmtp; no numeric qualifiers.

Matches FreeSWITCH’s video path in add_audio_codec.

pub fn with_rate(self, emit: bool) -> Self

Emit or suppress the rate qualifier (@<n>h).

pub fn with_ptime(self, emit: bool) -> Self

Emit or suppress the ptime qualifier (@<n>i).

Warning

For G.722, suppressing ptime while keeping rate causes FreeSWITCH to select whichever implementation is first in its list rather than the 20 ms default, potentially producing non-standard packetization. Leave this on.

pub fn with_bitrate(self, emit: bool) -> Self

Emit or suppress the bitrate qualifier (@<n>b).

pub fn with_channels(self, emit: bool) -> Self

Emit or suppress the channel count qualifier (@<n>c).

pub fn with_fmtp(self, emit: bool) -> Self

Emit or suppress the fmtp (~fmtp segment).

pub fn emits_rate(&self) -> bool

Whether rate will be emitted.

pub fn emits_ptime(&self) -> bool

Whether ptime will be emitted.

pub fn emits_bitrate(&self) -> bool

Whether bitrate will be emitted.

pub fn emits_channels(&self) -> bool

Whether channels will be emitted.

pub fn emits_fmtp(&self) -> bool

Whether fmtp will be emitted.

pub fn sdp_codec_to_entry( &self, codec: &SdpCodec, ) -> Result<CodecStringEntry, CodecStringError>

Convert an SdpCodec into a CodecStringEntry honouring these options.

Returns Err if the codec name or fmtp value would produce an invalid entry (wire-injection, @ in fmtp, dotted fmtp without a module prefix).

Trait Implementations

impl Clone for CodecStringOptions

fn clone(&self) -> CodecStringOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodecStringOptions

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

Formats the value using the given formatter.

impl Default for CodecStringOptions

fn default() -> Self

Audio-mode defaults: rate, ptime, bitrate, channels on; fmtp off.

impl Eq for CodecStringOptions

impl PartialEq for CodecStringOptions

fn eq(&self, other: &CodecStringOptions) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for CodecStringOptions