Class: FishjamAgent
Defined in: js-server-sdk/src/agent.ts:44
Extends
TypedEventEmitter<AgentEvents,this>
Constructors
Constructor
new FishjamAgent(
config,agentToken,callbacks?):FishjamAgent
Defined in: js-server-sdk/src/agent.ts:50
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:74
Await Agent connection to Fishjam.
Returns
Promise<void>
captureImage()
captureImage(
trackId):void
Defined in: js-server-sdk/src/agent.ts:132
Request a captured image from the given track
Parameters
| Parameter | Type |
|---|---|
trackId | TrackId |
Returns
void
createTrack()
createTrack(
codecParameters,metadata):AgentTrack
Defined in: js-server-sdk/src/agent.ts:82
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:114
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:138
Returns
void
interruptTrack()
interruptTrack(
trackId):void
Defined in: js-server-sdk/src/agent.ts:105
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:123
Send audio data for the given track
Parameters
| Parameter | Type |
|---|---|
trackId | TrackId |
data | Uint8Array |
Returns
void