Class: FishjamAgent
Defined in: js-server-sdk/src/agent.ts:49
Extends
TypedEventEmitter<AgentEvents,this>
Constructors
Constructor
new FishjamAgent(
config,agentToken,callbacks?):FishjamAgent
Defined in: js-server-sdk/src/agent.ts:56
Parameters
| Parameter | Type |
|---|---|
config | FishjamConfig |
agentToken | string |
callbacks? | AgentCallbacks |
Returns
FishjamAgent
Overrides
(EventEmitter as new () => TypedEmitter<AgentEvents>).constructor
Methods
awaitConnected()
awaitConnected():
Promise<void>
Defined in: js-server-sdk/src/agent.ts:83
Await Agent connection to Fishjam.
Returns
Promise<void>
captureImage()
captureImage(
trackId,timeoutMs):Promise<AgentResponse_TrackImage>
Defined in: js-server-sdk/src/agent.ts:144
Request a captured image from the given track
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
trackId | TrackId | undefined | 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
createTrack()
createTrack(
codecParameters,metadata):AgentTrack
Defined in: js-server-sdk/src/agent.ts:91
Creates an outgoing audio track for the agent
Parameters
| Parameter | Type |
|---|---|
codecParameters | AudioCodecParameters |
metadata | object |
Returns
a new audio track
deleteTrack()
deleteTrack(
trackId):void
Defined in: js-server-sdk/src/agent.ts:123
Deletes an outgoing audio track for the agent
Parameters
| Parameter | Type |
|---|---|
trackId | TrackId |
Returns
void
disconnect()
disconnect():
void
Defined in: js-server-sdk/src/agent.ts:169
Returns
void
interruptTrack()
interruptTrack(
trackId):void
Defined in: js-server-sdk/src/agent.ts:114
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
| Parameter | Type |
|---|---|
trackId | TrackId |
Returns
void
sendData()
sendData(
trackId,data):void
Defined in: js-server-sdk/src/agent.ts:132
Send audio data for the given track
Parameters
| Parameter | Type |
|---|---|
trackId | TrackId |
data | Uint8Array |
Returns
void