Class: TelephonyStreamTransport
Defined in: packages/agentos/src/io/channels/telephony/TelephonyStreamTransport.ts:402
Opt-in carrier transport; the no-option construction retains the original transport behavior.
Extends
EventEmitter
Implements
IStreamTransport
Constructors
Constructor
new TelephonyStreamTransport(
ws,parser,config?):TelephonyStreamTransport
Defined in: packages/agentos/src/io/channels/telephony/TelephonyStreamTransport.ts:431
Delegates compatibility construction, or installs bounded carrier I/O.
Parameters
ws
unknown
The provider's WebSocket, an object with the TelephonySocket shape. Typed loosely, as the released constructor was, so every existing caller keeps compiling.
parser
config?
TelephonyStreamTransportConfig = {}
Returns
TelephonyStreamTransport
Overrides
EventEmitter.constructor
Properties
id
readonlyid:string
Defined in: packages/agentos/src/io/channels/telephony/TelephonyStreamTransport.ts:404
Stable connection identifier.
Implementation of
IStreamTransport.id
captureRejections
staticcaptureRejections:boolean
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:425
Value: boolean
Change the default captureRejections option on all new EventEmitter objects.
Since
v13.4.0, v12.16.0
Inherited from
EventEmitter.captureRejections
captureRejectionSymbol
readonlystaticcaptureRejectionSymbol: typeofcaptureRejectionSymbol
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:418
Value: Symbol.for('nodejs.rejection')
See how to write a custom rejection handler.
Since
v13.4.0, v12.16.0
Inherited from
EventEmitter.captureRejectionSymbol
defaultMaxListeners
staticdefaultMaxListeners:number
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:464
By default, a maximum of 10 listeners can be registered for any single
event. This limit can be changed for individual EventEmitter instances
using the emitter.setMaxListeners(n) method. To change the default
for allEventEmitter instances, the events.defaultMaxListeners property
can be used. If this value is not a positive number, a RangeError is thrown.
Take caution when setting the events.defaultMaxListeners because the
change affects all EventEmitter instances, including those created before
the change is made. However, calling emitter.setMaxListeners(n) still has
precedence over events.defaultMaxListeners.
This is not a hard limit. The EventEmitter instance will allow
more listeners to be added but will output a trace warning to stderr indicating
that a "possible EventEmitter memory leak" has been detected. For any single
EventEmitter, the emitter.getMaxListeners() and emitter.setMaxListeners() methods can be used to
temporarily avoid this warning:
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.setMaxListeners(emitter.getMaxListeners() + 1);
emitter.once('event', () => {
// do stuff
emitter.setMaxListeners(Math.max(emitter.getMaxListeners() - 1, 0));
});
The --trace-warnings command-line flag can be used to display the
stack trace for such warnings.
The emitted warning can be inspected with process.on('warning') and will
have the additional emitter, type, and count properties, referring to
the event emitter instance, the event's name and the number of attached
listeners, respectively.
Its name property is set to 'MaxListenersExceededWarning'.
Since
v0.11.2
Inherited from
EventEmitter.defaultMaxListeners
errorMonitor
readonlystaticerrorMonitor: typeoferrorMonitor
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:411
This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.
Installing a listener using this symbol does not change the behavior once an 'error' event is emitted. Therefore, the process will still crash if no
regular 'error' listener is installed.
Since
v13.6.0, v12.17.0
Inherited from
EventEmitter.errorMonitor
Accessors
state
Get Signature
get state():
"connecting"|"open"|"closed"|"closing"
Defined in: packages/agentos/src/io/channels/telephony/TelephonyStreamTransport.ts:450
The physical transport state, with start authority required before carrier mode opens.
Returns
"connecting" | "open" | "closed" | "closing"
Implementation of
IStreamTransport.state
Methods
[captureRejectionSymbol]()?
optional[captureRejectionSymbol]<K>(error,event, ...args):void
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:103
Type Parameters
K
K
Parameters
error
Error
event
string | symbol
args
...AnyRest
Returns
void
Inherited from
EventEmitter.[captureRejectionSymbol]
addListener()
addListener<
K>(eventName,listener):this
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:642
Alias for emitter.on(eventName, listener).
Type Parameters
K
K
Parameters
eventName
string | symbol
listener
(...args) => void
Returns
this
Since
v0.1.26
Implementation of
IStreamTransport.addListener
Inherited from
EventEmitter.addListener
close()
close(
code?,reason?):void
Defined in: packages/agentos/src/io/channels/telephony/TelephonyStreamTransport.ts:603
Stops admission and pending output once; subsequent socket-close events are harmless.
Parameters
code?
number
reason?
string
Returns
void
Implementation of
IStreamTransport.close
emit()
emit<
K>(eventName, ...args):boolean
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:904
Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments
to each.
Returns true if the event had listeners, false otherwise.
import { EventEmitter } from 'node:events';
const myEmitter = new EventEmitter();
// First listener
myEmitter.on('event', function firstListener() {
console.log('Helloooo! first listener');
});
// Second listener
myEmitter.on('event', function secondListener(arg1, arg2) {
console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
});
// Third listener
myEmitter.on('event', function thirdListener(...args) {
const parameters = args.join(', ');
console.log(`event with parameters ${parameters} in third listener`);
});
console.log(myEmitter.listeners('event'));
myEmitter.emit('event', 1, 2, 3, 4, 5);
// Prints:
// [
// [Function: firstListener],
// [Function: secondListener],
// [Function: thirdListener]
// ]
// Helloooo! first listener
// event with parameters 1, 2 in second listener
// event with parameters 1, 2, 3, 4, 5 in third listener
Type Parameters
K
K
Parameters
eventName
string | symbol
args
...AnyRest
Returns
boolean
Since
v0.1.26
Implementation of
IStreamTransport.emit
Inherited from
EventEmitter.emit
eventNames()
eventNames(): (
string|symbol)[]
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:967
Returns an array listing the events for which the emitter has registered
listeners. The values in the array are strings or Symbols.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => {});
myEE.on('bar', () => {});
const sym = Symbol('symbol');
myEE.on(sym, () => {});
console.log(myEE.eventNames());
// Prints: [ 'foo', 'bar', Symbol(symbol) ]
Returns
(string | symbol)[]
Since
v6.0.0
Implementation of
IStreamTransport.eventNames
Inherited from
EventEmitter.eventNames
getMaxListeners()
getMaxListeners():
number
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:819
Returns the current max listener value for the EventEmitter which is either
set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.
Returns
number
Since
v1.0.0
Implementation of
IStreamTransport.getMaxListeners
Inherited from
EventEmitter.getMaxListeners
listenerCount()
listenerCount<
K>(eventName,listener?):number
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:913
Returns the number of listeners listening for the event named eventName.
If listener is provided, it will return how many times the listener is found
in the list of the listeners of the event.
Type Parameters
K
K
Parameters
eventName
The name of the event being listened for
string | symbol
listener?
Function
The event handler function
Returns
number
Since
v3.2.0
Implementation of
IStreamTransport.listenerCount
Inherited from
EventEmitter.listenerCount
listeners()
listeners<
K>(eventName):Function[]
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:832
Returns a copy of the array of listeners for the event named eventName.
server.on('connection', (stream) => {
console.log('someone connected!');
});
console.log(util.inspect(server.listeners('connection')));
// Prints: [ [Function] ]
Type Parameters
K
K
Parameters
eventName
string | symbol
Returns
Function[]
Since
v0.1.26
Implementation of
IStreamTransport.listeners
Inherited from
EventEmitter.listeners
off()
off<
K>(eventName,listener):this
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:792
Alias for emitter.removeListener().
Type Parameters
K
K
Parameters
eventName
string | symbol
listener
(...args) => void
Returns
this
Since
v10.0.0
Implementation of
IStreamTransport.off
Inherited from
EventEmitter.off
on()
on<
K>(eventName,listener):this
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:674
Adds the listener function to the end of the listeners array for the event
named eventName. No checks are made to see if the listener has already
been added. Multiple calls passing the same combination of eventName and
listener will result in the listener being added, and called, multiple times.
server.on('connection', (stream) => {
console.log('someone connected!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
By default, event listeners are invoked in the order they are added. The emitter.prependListener() method can be used as an alternative to add the
event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.on('foo', () => console.log('a'));
myEE.prependListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
Type Parameters
K
K
Parameters
eventName
The name of the event.
string | symbol
listener
(...args) => void
The callback function
Returns
this
Since
v0.1.101
Implementation of
IStreamTransport.on
Inherited from
EventEmitter.on
once()
once<
K>(eventName,listener):this
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:704
Adds a one-time listener function for the event named eventName. The
next time eventName is triggered, this listener is removed and then invoked.
server.once('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
By default, event listeners are invoked in the order they are added. The emitter.prependOnceListener() method can be used as an alternative to add the
event listener to the beginning of the listeners array.
import { EventEmitter } from 'node:events';
const myEE = new EventEmitter();
myEE.once('foo', () => console.log('a'));
myEE.prependOnceListener('foo', () => console.log('b'));
myEE.emit('foo');
// Prints:
// b
// a
Type Parameters
K
K
Parameters
eventName
The name of the event.
string | symbol
listener
(...args) => void
The callback function
Returns
this
Since
v0.3.0
Implementation of
IStreamTransport.once
Inherited from
EventEmitter.once
prependListener()
prependListener<
K>(eventName,listener):this
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:931
Adds the listener function to the beginning of the listeners array for the
event named eventName. No checks are made to see if the listener has
already been added. Multiple calls passing the same combination of eventName
and listener will result in the listener being added, and called, multiple times.
server.prependListener('connection', (stream) => {
console.log('someone connected!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
Type Parameters
K
K
Parameters
eventName
The name of the event.
string | symbol
listener
(...args) => void
The callback function
Returns
this
Since
v6.0.0
Implementation of
IStreamTransport.prependListener
Inherited from
EventEmitter.prependListener
prependOnceListener()
prependOnceListener<
K>(eventName,listener):this
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:947
Adds a one-timelistener function for the event named eventName to the beginning of the listeners array. The next time eventName is triggered, this
listener is removed, and then invoked.
server.prependOnceListener('connection', (stream) => {
console.log('Ah, we have our first user!');
});
Returns a reference to the EventEmitter, so that calls can be chained.
Type Parameters
K
K
Parameters
eventName
The name of the event.
string | symbol
listener
(...args) => void
The callback function
Returns
this
Since
v6.0.0
Implementation of
IStreamTransport.prependOnceListener
Inherited from
EventEmitter.prependOnceListener
rawListeners()
rawListeners<
K>(eventName):Function[]
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:863
Returns a copy of the array of listeners for the event named eventName,
including any wrappers (such as those created by .once()).
import { EventEmitter } from 'node:events';
const emitter = new EventEmitter();
emitter.once('log', () => console.log('log once'));
// Returns a new Array with a function `onceWrapper` which has a property
// `listener` which contains the original listener bound above
const listeners = emitter.rawListeners('log');
const logFnWrapper = listeners[0];
// Logs "log once" to the console and does not unbind the `once` event
logFnWrapper.listener();
// Logs "log once" to the console and removes the listener
logFnWrapper();
emitter.on('log', () => console.log('log persistently'));
// Will return a new Array with a single function bound by `.on()` above
const newListeners = emitter.rawListeners('log');
// Logs "log persistently" twice
newListeners[0]();
emitter.emit('log');
Type Parameters
K
K
Parameters
eventName
string | symbol
Returns
Function[]
Since
v9.4.0
Implementation of
IStreamTransport.rawListeners
Inherited from
EventEmitter.rawListeners
removeAllListeners()
removeAllListeners(
eventName?):this
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:803
Removes all listeners, or those of the specified eventName.
It is bad practice to remove listeners added elsewhere in the code,
particularly when the EventEmitter instance was created by some other
component or module (e.g. sockets or file streams).
Returns a reference to the EventEmitter, so that calls can be chained.
Parameters
eventName?
string | symbol
Returns
this
Since
v0.1.26
Implementation of
IStreamTransport.removeAllListeners
Inherited from
EventEmitter.removeAllListeners
removeListener()
removeListener<
K>(eventName,listener):this
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:787
Removes the specified listener from the listener array for the event named eventName.
const callback = (stream) => {
console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removeListener('connection', callback);
removeListener() will remove, at most, one instance of a listener from the
listener array. If any single listener has been added multiple times to the
listener array for the specified eventName, then removeListener() must be
called multiple times to remove each instance.
Once an event is emitted, all listeners attached to it at the
time of emitting are called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution
will not remove them fromemit() in progress. Subsequent events behave as expected.
import { EventEmitter } from 'node:events';
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
const callbackA = () => {
console.log('A');
myEmitter.removeListener('event', callbackB);
};
const callbackB = () => {
console.log('B');
};
myEmitter.on('event', callbackA);
myEmitter.on('event', callbackB);
// callbackA removes listener callbackB but it will still be called.
// Internal listener array at time of emit [callbackA, callbackB]
myEmitter.emit('event');
// Prints:
// A
// B
// callbackB is now removed.
// Internal listener array [callbackA]
myEmitter.emit('event');
// Prints:
// A
Because listeners are managed using an internal array, calling this will
change the position indices of any listener registered after the listener
being removed. This will not impact the order in which listeners are called,
but it means that any copies of the listener array as returned by
the emitter.listeners() method will need to be recreated.
When a single function has been added as a handler multiple times for a single
event (as in the example below), removeListener() will remove the most
recently added instance. In the example the once('ping') listener is removed:
import { EventEmitter } from 'node:events';
const ee = new EventEmitter();
function pong() {
console.log('pong');
}
ee.on('ping', pong);
ee.once('ping', pong);
ee.removeListener('ping', pong);
ee.emit('ping');
ee.emit('ping');
Returns a reference to the EventEmitter, so that calls can be chained.
Type Parameters
K
K
Parameters
eventName
string | symbol
listener
(...args) => void
Returns
this
Since
v0.1.26
Implementation of
IStreamTransport.removeListener
Inherited from
EventEmitter.removeListener
sendAudio()
sendAudio(
chunk):Promise<void>
Defined in: packages/agentos/src/io/channels/telephony/TelephonyStreamTransport.ts:499
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>
Implementation of
IStreamTransport.sendAudio
sendControl()
sendControl(
message):Promise<void>
Defined in: packages/agentos/src/io/channels/telephony/TelephonyStreamTransport.ts:582
Cancels pending playback before sending clear. All other pipeline controls remain local.
Parameters
message
ServerTextMessage
Returns
Promise<void>
Implementation of
IStreamTransport.sendControl
setMaxListeners()
setMaxListeners(
n):this
Defined in: packages/agentos/node_modules/.pnpm/@types+node@22.20.5/node_modules/@types/node/events.d.ts:813
By default EventEmitters will print a warning if more than 10 listeners are
added for a particular event. This is a useful default that helps finding
memory leaks. The emitter.setMaxListeners() method allows the limit to be
modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) to indicate an unlimited number of listeners.
Returns a reference to the EventEmitter, so that calls can be chained.
Parameters
n
number
Returns
this