Class TelnyxMediaStreamParser<P>

constructor

• new TelnyxMediaStreamParser<P>(options?): TelnyxMediaStreamParser<P>

• Carrier mode requires Telnyx bidirectional RTP with PCMU configured by the host.

  Type Parameters

  • P extends "legacy" | "carrier" = "legacy"

  Parameters

  • options: {
        protocol?: P;
    } = {}

    • Optional protocol?: P

  Returns TelnyxMediaStreamParser<P>

parseIncoming

• parseIncoming(data): null | MediaStreamIncoming

• Parse a raw WebSocket frame from a Telnyx media stream.

  The carrier profile (parseCarrierMedia) reads start with the nested start.call_control_id and start.media_format, which must declare PCMU at 8 kHz mono; media with its base64 media.payload, inbound track only; dtmf, mark and stop. An unsupported start format, an error event or an oversized frame throws.

  The legacy profile keeps the released mapping: stream_id to streamSid, a top-level call_control_id to callSid and the audio in media.chunk, with start, media and stop alone.

  Parameters

  • data: string | Buffer<ArrayBufferLike>

    Raw WebSocket frame payload (JSON string or Buffer from Telnyx).

  Returns null | MediaStreamIncoming

  Normalised MediaStreamIncoming event, or null for outbound audio tracks, unknown event types, or malformed messages.

formatOutgoing

• formatOutgoing(audio, streamSid): P extends "carrier"
      ? string
      : Buffer<ArrayBufferLike>

• Carrier mode sends JSON media; legacy mode returns the original bytes.

  Parameters

  • audio: Buffer<ArrayBufferLike>
  • streamSid: string

  Returns P extends "carrier"
      ? string
      : Buffer<ArrayBufferLike>

formatConnected

• formatConnected(_streamSid): null

• No explicit connection acknowledgment is required by Telnyx.

  Unlike Twilio, Telnyx does not need a connected handshake message before it starts sending media events.

  Parameters

  • _streamSid: string

    Unused (accepted for interface parity).

  Returns null

  Always null.

formatClear

• formatClear(streamSid): null | string

• Stops queued carrier playback.

  Parameters

  • streamSid: string

  Returns null | string

formatMark

• formatMark(streamSid, name): null | string

• Marks carrier playback.

  Parameters

  • streamSid: string
  • name: string

  Returns null | string

Readonly protocol