Member Junction
    Preparing search index...

    Interface SoftphoneCallSession

    The live per-call session (ringcentral-softphone's CallSession / its In/Outbound subclasses) — the subset import('./ringcentral-softphone-call-sdk').RingCentralSoftphoneCallSdk and import('./realtime-rtp-sender').RealtimeRtpSender drive. All members are public on the real class.

    interface SoftphoneCallSession {
        callId?: string;
        disposed?: boolean;
        encoder: { encode: (pcm: Buffer) => Buffer };
        remotePeer?: string;
        sequenceNumber: number;
        softphone: { codec: SoftphoneCodec };
        ssrc: number;
        timestamp: number;
        hangup(): Promise<void>;
        on(
            event: "audioPacket",
            handler: (rtpPacket: { payload: Buffer }) => void,
        ): void;
        on(event: "dtmf", handler: (digit: string) => void): void;
        once(event: "disposed" | "answered" | "busy", handler: () => void): void;
        sendDTMF(char: string): void;
        sendPacket(rtpPacket: RtpPacketInstance): void;
        transfer(toNumber: string): Promise<void>;
    }
    Index

    Properties

    callId? disposed? encoder remotePeer? sequenceNumber softphone ssrc timestamp

    Methods

    hangup on once sendDTMF sendPacket transfer

    Properties

    callId?: string

    The SIP Call-ID for this call (per-call identifier). Present once the session is established.

    disposed?: boolean

    Whether the session has been torn down (guards sendPacket).

    encoder: { encode: (pcm: Buffer) => Buffer }

    The encoder instance produced by codec.createEncoder() — PCM16 frame → encoded payload.

    remotePeer?: string

    The raw SIP From header for an inbound call (the caller); parsed for the caller number.

    sequenceNumber: number

    RTP sequence number (seeded random; the sender advances it per frame, wrapping at 65535).

    softphone: { codec: SoftphoneCodec }

    Back-reference to the owning softphone (the RTP loop reads softphone.codec).

    ssrc: number

    RTP SSRC (seeded random; constant for the call).

    timestamp: number

    RTP timestamp (seeded random; the sender advances it by codec.timestampInterval per frame).

    Methods

    • Subscribe to a recurring session event ('audioPacket', 'dtmf').

      Parameters

      • event: "audioPacket"
      • handler: (rtpPacket: { payload: Buffer }) => void

      Returns void

    • Parameters

      • event: "dtmf"
      • handler: (digit: string) => void

      Returns void

    • Subscribe to a one-shot session event ('disposed', 'answered', 'busy').

      Parameters

      • event: "disposed" | "answered" | "busy"
      • handler: () => void

      Returns void

    Settings

    Member Visibility

    On This Page

    Properties
    Methods