Class PlivoMediaStreamParser

constructor

• new PlivoMediaStreamParser(options?): PlivoMediaStreamParser

• Selects explicit PCMU 8 kHz in the documented carrier protocol.

  Parameters

  • options: CarrierProtocolOptions = {}

  Returns PlivoMediaStreamParser

parseIncoming

• parseIncoming(data): null | MediaStreamIncoming

• Parse a raw WebSocket frame from a Plivo audio stream.

  The carrier profile (parseCarrierMedia) reads start with the nested start.callId, start.streamId and start.mediaFormat, which must declare PCMU at 8 kHz (one channel when the count is omitted); media with its base64 media.payload, inbound track only; dtmf, playedStream (reported as a mark) and stop. An unsupported start format, an error event or an oversized frame throws.

  The legacy profile keeps the released snake-case mapping: stream_id to streamSid and call_uuid to callSid, with start, media and stop alone.

  Parameters

  • data: string | Buffer<ArrayBufferLike>

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

  Returns null | MediaStreamIncoming

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

formatOutgoing

• formatOutgoing(audio, streamSid): string

• Carrier output declares codec and numeric rate; legacy output preserves its old shape.

  Parameters

  • audio: Buffer<ArrayBufferLike>
  • streamSid: string

  Returns string

formatClear

• formatClear(streamSid): null | string

• Clears queued carrier audio.

  Parameters

  • streamSid: string

  Returns null | string

formatMark

• formatMark(streamSid, name): null | string

• Sends a Plivo checkpoint.

  Parameters

  • streamSid: string
  • name: string

  Returns null | string

Readonly protocol