Class TelephonyStreamTransport

Opt-in carrier transport; the no-option construction retains the original transport behavior.

Hierarchy

  • EventEmitter
    • TelephonyStreamTransport

Implements

  • IStreamTransport

Accessors

Constructors

Methods

Properties

Accessors

  • get state(): "closing" | "connecting" | "open" | "closed"
  • The physical transport state, with start authority required before carrier mode opens.

    Returns "closing" | "connecting" | "open" | "closed"

Constructors

Methods

  • Plays one chunk; completion means its carrier checkpoint returned before an interruption or a close.

    A chunk with a generation is one producer's at a time: a second chunk before the first completes is refused, and so are an older generation and, once a generation was sent, a chunk without one. A chunk without a generation from a producer that sends none, as the voice pipeline without a call profile sends none and does not wait for one send before the next, is admitted behind the chunks before it: each is written in order with its checkpoint after it, without waiting for the earlier chunks to play, and at most 196608 bytes of their PCMU wait unwritten. An interruption rejects every chunk not yet played; the chunks sent after it play. A chunk outside TelephonyAudioChunk, such as one in an MP3 or Ogg container, is refused before output.

    Parameters

    • chunk: EncodedAudioChunk

    Returns Promise<void>

  • Cancels pending playback before sending clear. All other pipeline controls remain local.

    Parameters

    • message: ServerTextMessage

    Returns Promise<void>

  • Stops admission and pending output once; subsequent socket-close events are harmless.

    Parameters

    • Optional code: number
    • Optional reason: string

    Returns void

Properties

id: string

Stable connection identifier.