Video.Client
You can use instances of this class to subscribe to video events. Please see VideoClientApiEvents for the full list of events you can subscribe to.
Example
const video = new Video.Client({
project: '<project-id>',
token: '<project-token>'
})
video.on('room.started', async (roomSession) => {
console.log("Room started")
});
video.on('room.ended', async (roomSession) => {
console.log("Room ended")
});
Constructors
• new Client(opts)
Parameters
| Name | Type | Description |
|---|---|---|
opts | Object | - |
opts.project | string | SignalWire project id, e.g. |
opts.token | string | SignalWire project token, e.g. |
Methods
▸ off<T>(event, fn?): EmitterContract<RealTimeVideoApiEventsDocs>
Type parameters
| Name | Type |
|---|---|
T | extends keyof RealTimeVideoApiEventsDocs |
Parameters
| Name | Type |
|---|---|
event | T |
fn? | (...args: ArgumentMap<RealTimeVideoApiEventsDocs>[Extract<T, keyof RealTimeVideoApiEventsDocs>]) => void |
Returns
EmitterContract<RealTimeVideoApiEventsDocs>
▸ on<T>(event, fn): EmitterContract<RealTimeVideoApiEventsDocs>
Type parameters
| Name | Type |
|---|---|
T | extends keyof RealTimeVideoApiEventsDocs |
Parameters
| Name | Type |
|---|---|
event | T |
fn | (...args: ArgumentMap<RealTimeVideoApiEventsDocs>[Extract<T, keyof RealTimeVideoApiEventsDocs>]) => void |
Returns
EmitterContract<RealTimeVideoApiEventsDocs>
▸ once<T>(event, fn): EmitterContract<RealTimeVideoApiEventsDocs>
Type parameters
| Name | Type |
|---|---|
T | extends keyof RealTimeVideoApiEventsDocs |
Parameters
| Name | Type |
|---|---|
event | T |
fn | (...args: ArgumentMap<RealTimeVideoApiEventsDocs>[Extract<T, keyof RealTimeVideoApiEventsDocs>]) => void |
Returns
EmitterContract<RealTimeVideoApiEventsDocs>
▸ removeAllListeners<T>(event?): EmitterContract<RealTimeVideoApiEventsDocs>
Type parameters
| Name | Type |
|---|---|
T | extends keyof RealTimeVideoApiEventsDocs |
Parameters
| Name | Type |
|---|---|
event? | T |
Returns
EmitterContract<RealTimeVideoApiEventsDocs>