Skip to content

@seydx/rtsp / BackchannelTranscoderOptions

Interface: BackchannelTranscoderOptions

Defined in: sinks/rtsp-server/backchannel-transcoder.ts:131

Configuration for a BackchannelTranscoder.

Pairs the inbound viewer format with the desired upstream target format and supplies the callback that receives the produced output. The optional sample format and logger tune the resample stage and surface pipeline errors.

Properties

from

from: BackchannelInput

Defined in: sinks/rtsp-server/backchannel-transcoder.ts:137

Format received from viewers on the talkback channel.

Determines the decoder and input SDP used at the start of the pipeline.


logger?

optional logger?: Logger

Defined in: sinks/rtsp-server/backchannel-transcoder.ts:168

Optional logger used to report transcode pipeline failures.

Only the error method is used, and only for failures that occur while the transcoder is active.


output

output: (data) => void

Defined in: sinks/rtsp-server/backchannel-transcoder.ts:152

Callback invoked with each chunk of produced output.

Receives RTP packets when the target format is rtp, or container bytes for non-rtp formats. The buffer is owned by the callee and may be retained.

Parameters

data

Buffer

Returns

void


sampleFormat?

optional sampleFormat?: string

Defined in: sinks/rtsp-server/backchannel-transcoder.ts:160

Intermediate sample format name for the resample stage.

Resolved via FFmpeg's sample-format names (for example s16, fltp). Defaults to signed 16-bit (AV_SAMPLE_FMT_S16) when omitted.


to

to: BackchannelTarget

Defined in: sinks/rtsp-server/backchannel-transcoder.ts:144

Target format the talkback audio is converted into.

Determines the encoder, resample target, and output muxer format.