Class FishjamAgent

Hierarchy

TypedEventEmitter<AgentEvents, this>
- FishjamAgent

Constructors

constructor

new FishjamAgent(
    config: FishjamConfig,
    agentToken: string,
    callbacks?: AgentCallbacks,
): FishjamAgent
Parameters
- config: FishjamConfig
- agentToken: string
- Optionalcallbacks: AgentCallbacks
Returns FishjamAgent
Overrides (EventEmitter as new () => TypedEmitter<AgentEvents>).constructor
- Defined in packages/js-server-sdk/src/agent.ts:57

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

awaitConnected

awaitConnected(): Promise<void>
Await Agent connection to Fishjam.

Returns Promise<void>
- Defined in packages/js-server-sdk/src/agent.ts:84

captureImage

captureImage(
trackId: string,
timeoutMs?: number,
): Promise<AgentResponse_TrackImage>
Request a captured image from the given track
Parameters
- trackId: string
  the track to capture an image from
- timeoutMs: number = 5000
  timeout in milliseconds (default: 5000)
Returns Promise<AgentResponse_TrackImage>
a promise that resolves with the captured image data
- Defined in packages/js-server-sdk/src/agent.ts:145

createTrack

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

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:124

disconnect

disconnect(): void
Returns void
- Defined in packages/js-server-sdk/src/agent.ts:170

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

interruptTrack

interruptTrack(trackId: TrackId): void
Interrupt track identified by trackId.

Any audio that has been sent by the agent, but not played by Fishjam will be cleared and be prevented from playing.

Audio sent after the interrupt will be played normally.
Parameters
- trackId: TrackId
Returns void
- Defined in packages/js-server-sdk/src/agent.ts:115

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:133

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