Class FishjamAgent

Hierarchy

TypedEventEmitter<AgentEvents, this>
- FishjamAgent

Index

Constructors

Methods

addListener createTrack deleteTrack emit eventNames getMaxListeners listenerCount listeners off on once prependListener prependOnceListener rawListeners removeAllListeners removeListener sendData setMaxListeners

Constructors

constructor

new FishjamAgent(
    config: FishjamConfig,
    agentToken: string,
    onError: ErrorEventHandler,
    onClose: CloseEventHandler,
): FishjamAgent
Parameters
- config: FishjamConfig
- agentToken: string
- onError: ErrorEventHandler
- onClose: CloseEventHandler
Returns FishjamAgent
Overrides (EventEmitter as new () => TypedEmitter<AgentEvents>).constructor
- Defined in packages/js-server-sdk/src/agent.ts:44

Methods

addListener

addListener<E extends "trackData">(event: E, listener: AgentEvents[E]): this
Type Parameters
- E extends "trackData"
Parameters
- event: E
- listener: AgentEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<AgentEvents>).addListener
- Defined in node_modules/typed-emitter/index.d.ts:22

createTrack

createTrack(codecParameters: AudioCodecParameters, metadata?: object): Track
Creates an outgoing audio track for the agent
Parameters
- codecParameters: AudioCodecParameters
- metadata: object = {}
Returns Track
a new audio track
- Defined in packages/js-server-sdk/src/agent.ts:63

deleteTrack

deleteTrack(trackId: TrackId): void
Deletes an outgoing audio track for the agent
Parameters
- trackId: TrackId
Returns void
- Defined in packages/js-server-sdk/src/agent.ts:81

emit

emit<E extends "trackData">(
event: E,
...args: Parameters<AgentEvents[E]>,
): boolean
Type Parameters
- E extends "trackData"
Parameters
- event: E
- ...args: Parameters<AgentEvents[E]>
Returns boolean
Inherited from (EventEmitter as new () => TypedEmitter<AgentEvents>).emit
- Defined in node_modules/typed-emitter/index.d.ts:32

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]
Inherited from (EventEmitter as new () => TypedEmitter<AgentEvents>).eventNames
- Defined in node_modules/typed-emitter/index.d.ts:34

getMaxListeners

getMaxListeners(): number
Returns number
Inherited from (EventEmitter as new () => TypedEmitter<AgentEvents>).getMaxListeners
- Defined in node_modules/typed-emitter/index.d.ts:39

listenerCount

listenerCount<E extends "trackData">(event: E): number
Type Parameters
- E extends "trackData"
Parameters
- event: E
Returns number
Inherited from (EventEmitter as new () => TypedEmitter<AgentEvents>).listenerCount
- Defined in node_modules/typed-emitter/index.d.ts:37

listeners

listeners<E extends "trackData">(event: E): AgentEvents[E][]
Type Parameters
- E extends "trackData"
Parameters
- event: E
Returns AgentEvents[E][]
Inherited from (EventEmitter as new () => TypedEmitter<AgentEvents>).listeners
- Defined in node_modules/typed-emitter/index.d.ts:36

off

off<E extends "trackData">(event: E, listener: AgentEvents[E]): this
Type Parameters
- E extends "trackData"
Parameters
- event: E
- listener: AgentEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<AgentEvents>).off
- Defined in node_modules/typed-emitter/index.d.ts:28

on

on<E extends "trackData">(event: E, listener: AgentEvents[E]): this
Type Parameters
- E extends "trackData"
Parameters
- event: E
- listener: AgentEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<AgentEvents>).on
- Defined in node_modules/typed-emitter/index.d.ts:23

once

once<E extends "trackData">(event: E, listener: AgentEvents[E]): this
Type Parameters
- E extends "trackData"
Parameters
- event: E
- listener: AgentEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<AgentEvents>).once
- Defined in node_modules/typed-emitter/index.d.ts:24

prependListener

prependListener<E extends "trackData">(event: E, listener: AgentEvents[E]): this
Type Parameters
- E extends "trackData"
Parameters
- event: E
- listener: AgentEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<AgentEvents>).prependListener
- Defined in node_modules/typed-emitter/index.d.ts:25

prependOnceListener

prependOnceListener<E extends "trackData">(
event: E,
listener: AgentEvents[E],
): this
Type Parameters
- E extends "trackData"
Parameters
- event: E
- listener: AgentEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<AgentEvents>).prependOnceListener
- Defined in node_modules/typed-emitter/index.d.ts:26

rawListeners

rawListeners<E extends "trackData">(event: E): AgentEvents[E][]
Type Parameters
- E extends "trackData"
Parameters
- event: E
Returns AgentEvents[E][]
Inherited from (EventEmitter as new () => TypedEmitter<AgentEvents>).rawListeners
- Defined in node_modules/typed-emitter/index.d.ts:35

removeAllListeners

removeAllListeners<E extends "trackData">(event?: E): this
Type Parameters
- E extends "trackData"
Parameters
- Optionalevent: E
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<AgentEvents>).removeAllListeners
- Defined in node_modules/typed-emitter/index.d.ts:29

removeListener

removeListener<E extends "trackData">(event: E, listener: AgentEvents[E]): this
Type Parameters
- E extends "trackData"
Parameters
- event: E
- listener: AgentEvents[E]
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<AgentEvents>).removeListener
- Defined in node_modules/typed-emitter/index.d.ts:30

sendData

sendData(trackId: TrackId, data: Uint8Array): void
Send audio data for the given track
Parameters
- trackId: TrackId
- data: Uint8Array
Returns void
- Defined in packages/js-server-sdk/src/agent.ts:90

setMaxListeners

setMaxListeners(maxListeners: number): this
Parameters
- maxListeners: number
Returns this
Inherited from (EventEmitter as new () => TypedEmitter<AgentEvents>).setMaxListeners
- Defined in node_modules/typed-emitter/index.d.ts:40