Skip to main content

RtpSession

Struct RtpSession 

Source
pub struct RtpSession { /* private fields */ }
Expand description

RTP session that manages send/receive streams

Implementations§

Source§

impl RtpSession

Source

pub async fn new(config: SessionConfig) -> Result<Self, SessionError>

Create and bind a new RTP session

Source

pub fn local_addr(&self) -> SocketAddr

Get the local address this session is bound to

Source

pub fn set_remote_addr(&mut self, addr: SocketAddr)

Update the remote address (e.g. after receiving SDP answer)

Source

pub async fn send_audio( &mut self, pcm_samples: &[i16], ) -> Result<usize, SessionError>

Send PCM audio samples as an RTP packet

Source

pub async fn send_rfc2833_digit( &mut self, digit: char, payload_type: u8, ) -> Result<(), SessionError>

Send one RFC2833 telephone-event digit.

payload_type is typically negotiated via SDP a=rtpmap:<pt> telephone-event/8000.

Source

pub fn queue_rfc2833_digits( &mut self, digits: &str, ) -> Result<usize, SessionError>

Queue DTMF digits for RFC2833 transmission.

Returns the number of queued digits.

Source

pub fn queued_rfc2833_digits(&self) -> usize

Source

pub async fn send_next_queued_rfc2833( &mut self, payload_type: u8, ) -> Result<Option<char>, SessionError>

Send the next queued RFC2833 DTMF digit.

Source

pub async fn flush_queued_rfc2833( &mut self, payload_type: u8, inter_digit_gap_ms: u64, ) -> Result<usize, SessionError>

Flush the queued RFC2833 digits with an inter-digit gap.

Source

pub async fn send_packet( &self, packet: &RtpPacket, ) -> Result<usize, SessionError>

Send a raw RTP packet

Source

pub async fn recv_packet(&self) -> Result<(RtpPacket, SocketAddr), SessionError>

Receive a single RTP packet

Source

pub fn decode_packet( &mut self, packet: &RtpPacket, ) -> Result<Vec<i16>, SessionError>

Decode an RTP packet’s payload to PCM samples

Source

pub fn silence_frame(&self) -> Vec<u8>

Get a silence frame for this session’s codec

Source

pub fn start_receiving( &self, buffer_size: usize, ) -> (Receiver<Vec<i16>>, Sender<()>)

Start a receive loop that feeds packets into a jitter buffer and outputs decoded audio

Source

pub fn start_receiving_events( &self, buffer_size: usize, dtmf_payload_type: Option<u8>, ) -> (Receiver<ReceiveEvent>, Sender<()>)

Start a receive loop that emits both decoded audio and RFC2833 DTMF events.

Source

pub fn stats(&self) -> SessionStats

Get session statistics

Source

pub fn codec(&self) -> &CodecPipeline

Get the codec pipeline reference

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,