@seydx/rtsp

Appearance

@seydx/rtsp / RtspServerSinkOptions

Interface: RtspServerSinkOptions ​

Defined in: sinks/rtsp-server/rtsp-server-sink.ts:21

Configuration for an RtspServerSink.

Controls the address the server binds to, the path viewers connect on, the RTP packetization size, optional authentication, and whether a talkback (ONVIF backchannel) media is advertised to clients. Every field is optional; sensible defaults are applied for a localhost-only server.

Properties ​

auth? ​

optional auth?: RtspAuth

Defined in: sinks/rtsp-server/rtsp-server-sink.ts:62

Authenticator that pulling clients must satisfy before they can DESCRIBE or play the stream.

When provided, every request is challenged (Basic or Digest); when omitted the endpoint is open to any client that can reach it.

See ​

RtspAuth

backchannel? ​

optional backchannel?: boolean | BackchannelAdvertise

Defined in: sinks/rtsp-server/rtsp-server-sink.ts:85

Advertise a talkback (ONVIF backchannel) media section to viewers so they can send audio back to the camera.

Pass true to advertise the upstream's own backchannel codec verbatim, so inbound viewer RTP is forwarded straight through (pass-through). Pass a BackchannelAdvertise to advertise a specific codec instead, in which case the relay transcodes the viewer audio into the camera's native format. When the upstream advertises no backchannel, the request is ignored with a warning.

host? ​

optional host?: string

Defined in: sinks/rtsp-server/rtsp-server-sink.ts:30

Hostname or IP address the TCP listener binds to.

Use a specific interface address to limit reachability, or 0.0.0.0 to accept connections on every interface.

Default ​

ts
'127.0.0.1'

logger? ​

optional logger?: Logger

Defined in: sinks/rtsp-server/rtsp-server-sink.ts:93

Logger used to emit diagnostics about the server lifecycle and per-request activity.

When omitted no diagnostics are emitted.

mtu? ​

optional mtu?: number

Defined in: sinks/rtsp-server/rtsp-server-sink.ts:72

Maximum RTP packet size in bytes used by the underlying muxer.

Larger payloads are fragmented to fit within this limit. The default keeps packets comfortably below typical network MTUs to avoid IP fragmentation.

Default ​

ts
1200

path? ​

optional path?: string

Defined in: sinks/rtsp-server/rtsp-server-sink.ts:51

Stream path that viewers append to the server URL (the portion after the port, e.g. rtsp://host:port/live).

Any leading slashes are stripped, so live and /live are equivalent.

Default ​

ts
'live'

port? ​

optional port?: number

Defined in: sinks/rtsp-server/rtsp-server-sink.ts:41

TCP port the RTSP server listens on.

When omitted (or 0), the operating system assigns a free ephemeral port; the chosen value is reflected by RtspServerSink.url after RtspServerSink.listen resolves.

Default ​

ts
an ephemeral free port