Class: FishjamAgent
Defined in: js-server-sdk/src/agent.ts:47
Extends​
TypedEventEmitter<AgentEvents,this>
Constructors​
Constructor​
new FishjamAgent(
config,agentToken,callbacks?,peerWebsocketUrl?):FishjamAgent
Defined in: js-server-sdk/src/agent.ts:55
Parameters​
| Parameter | Type |
|---|---|
config | FishjamConfig |
agentToken | string |
callbacks? | AgentCallbacks |
peerWebsocketUrl? | string |
Returns​
FishjamAgent
Overrides​
(EventEmitter as new () => TypedEmitter<AgentEvents>).constructor
Methods​
awaitConnected()​
awaitConnected():
Promise<void>
Defined in: js-server-sdk/src/agent.ts:94
Await Agent connection to Fishjam.
Returns​
Promise<void>
captureImage()​
captureImage(
trackId,timeoutMs):Promise<AgentResponse_TrackImage>
Defined in: js-server-sdk/src/agent.ts:155
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:102
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:134
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:180
Returns​
void
interruptTrack()​
interruptTrack(
trackId):void
Defined in: js-server-sdk/src/agent.ts:125
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:143
Send audio data for the given track
Parameters​
| Parameter | Type |
|---|---|
trackId | TrackId |
data | Uint8Array |
Returns​
void