Class: FishjamAgent
Defined in: js-server-sdk/src/agent.ts:42
Extends
TypedEventEmitter<AgentEvents,this>
Constructors
Constructor
new FishjamAgent(
config,agentToken,callbacks?):FishjamAgent
Defined in: js-server-sdk/src/agent.ts:45
Parameters
| Parameter | Type |
|---|---|
config | FishjamConfig |
agentToken | string |
callbacks? | AgentCallbacks |
Returns
FishjamAgent
Overrides
(EventEmitter as new () => TypedEmitter<AgentEvents>).constructor
Methods
createTrack()
createTrack(
codecParameters,metadata):AgentTrack
Defined in: js-server-sdk/src/agent.ts:66
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:98
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:113
Returns
void
interruptTrack()
interruptTrack(
trackId):void
Defined in: js-server-sdk/src/agent.ts:89
Interrupt track indentified 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:107
Send audio data for the given track
Parameters
| Parameter | Type |
|---|---|
trackId | TrackId |
data | Uint8Array |
Returns
void