SipUserAgent class

Constructors

SipUserAgent({Random? rng, AudioSink audioSinkFactory()?, String? publicMediaAddress, RtpPacketTap? rtpPacketTap})

Properties

account → SipAccount?
no setter
callStream → Stream<SipCall>
no setter
hashCode → int
The hash code for this object.
no setterinherited
logStream → Stream<String>
no setter
messageStream → Stream<SipTextMessage>
no setter
registrationState → RegistrationState
no setter
registrationStream → Stream<RegistrationState>
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

answer(String callId, {VideoEncoder? videoEncoder, VideoDecoder? videoDecoder}) → Future<void>
attachFileLogger(SipFileLogger logger) → void
Attach a wire-format file logger. Every subsequent inbound/outbound SIP message is written to logger's file verbatim.
callById(String callId) → SipCall?
Snapshot of the call with callId, or null if no such call is active. Lets the UI seed itself synchronously instead of waiting for the next callStream emission (which broadcast semantics don't replay).
hangup(String callId) → void
isHeld(String callId) → bool?
Whether callId is currently on hold.
isMuted(String callId) → bool?
Convenience: returns whether callId is currently muted, or null if the call has no active media.
makeCall(String target, {bool withVideo = false, VideoEncoder? videoEncoder, VideoDecoder? videoDecoder}) → Future<SipCall?>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
sendDtmf(String callId, String digit, {Duration duration = const Duration(milliseconds: 200)}) → Future<void>
Send an RFC 4733 DTMF digit on an active call. No-op if the call isn't active or DTMF wasn't negotiated.
sendMessage(String target, String text) → void
setHold(String callId, bool hold) → bool?
Place callId on hold (or resume it). Sends a re-INVITE with a=sendonly (hold) or a=sendrecv (resume). The local mic is also muted while held so we don't keep streaming audio after the peer stops listening. Returns the new held state, or null if the call isn't active.
setMuted(String callId, bool muted) → bool?
Toggle whether mic input is dropped on the wire for callId. Returns the new muted state, or null if the call isn't active.
start(SipAccount account) → Future<void>
stop() → Future<void>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited