Class VoiceClient<Platform, MSC>

Type Parameters

Platform extends MSCPlatform
MSC extends MediaSoup<Platform> = MediaSoup<Platform>

Hierarchy

EventEmitter<VoiceClientEvents>
- VoiceClient

Constructors

constructor

new VoiceClient<Platform, MSC>(platform: Platform, client: VoiceClientOptions | Client, msc: Platform extends "node" ? __module : __module, createDevice: (() => MSC["Device"]), consumeTrack?: VoiceClientConsumer<Platform>): VoiceClient<Platform, MSC>
The base voice client. It's recommended to use the platform-specific clients instead.
Type Parameters
- Platform extends MSCPlatform
- MSC extends MediaSoup<Platform, MSC> = MediaSoup<Platform>
Parameters
- platform: Platform
- client: VoiceClientOptions | Client
- msc: Platform extends "node" ? __module : __module
  
  The MediaSoup client to use. (for tree-shaking)
- createDevice: (() => MSC["Device"])
  
  A function called to create a new MediaSoup Device for the client.
  - - (): MSC["Device"]
    - Returns MSC["Device"]
- Optional consumeTrack: VoiceClientConsumer<Platform>
  
  A callback that is run to play a new MediaStreamTrack. The function returned will be called when the stream is closed. (leave out to disable consuming media)
Returns VoiceClient<Platform, MSC>
Overrides EventEmitter<VoiceClientEvents>.constructor
- Defined in voice/src/VoiceClient.ts:78

Properties

`Private` _deafened

_deafened: boolean = false

`Protected` `Optional` audioProducer

audioProducer?: MSC["Producer"]

channelID

channelID: null | string = null

client

client: Client = ...

`Private` `Optional` consumeTrack

consumeTrack?: VoiceClientConsumer<Platform>

A callback that is run to play a new MediaStreamTrack. The function returned will be called when the stream is closed. (leave out to disable consuming media)

`Protected` consumers

consumers: Map<string, VoiceConsumer<Platform>> = ...

`Private` createDevice

createDevice: (() => MSC["Device"])

Type declaration

- (): MSC["Device"]
- A function called to create a new MediaSoup Device for the client.
  
  Returns MSC["Device"]

`Private` `Optional` device

device?: MSC["Device"]

`Private` msc

msc: Platform extends "node" ? __module : __module

The MediaSoup client to use. (for tree-shaking)

participants

participants: MiniMapEmitter<VoiceParticipant> = ...

`Readonly` platform

platform: Platform

`Private` recvTransport

recvTransport: null | MSC["Transport"] = null

`Private` sendTransport

sendTransport: null | MSC["Transport"] = null

`Private` sessionDetails

sessionDetails: null | {
token: string;
type: "user" | "bot";
} = null

`Private` signaling

signaling: default<Platform> = ...

status

status: VoiceStatus = VoiceStatus.UNLOADED

`Readonly` supported

supported: boolean = false

`Static` prefixed

prefixed: string | boolean

Accessors

channel

get channel(): undefined | Channel
Returns undefined | Channel
- Defined in voice/src/VoiceClient.ts:68

connected

get connected(): boolean
Returns boolean
- Defined in voice/src/VoiceClient.ts:61

deafened

get deafened(): boolean
Returns boolean
- Defined in voice/src/VoiceClient.ts:56

Methods

addListener

addListener<T>(event: T, fn: ((...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]) => void), context?: any): VoiceClient<Platform, MSC>
Type Parameters
- T extends keyof VoiceClientEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]) => void)
  - - (...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]
      
      Returns void
- Optional context: any
Returns VoiceClient<Platform, MSC>
Inherited from EventEmitter.addListener
- Defined in voice/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:45

authenticate

authenticate(token: string): Promise<void>
Parameters
- token: string
Returns Promise<void>
- Defined in voice/src/VoiceClient.ts:200

connect

connect(channelResolvable: string | VoiceChannel | DMChannel | GroupDMChannel): Promise<undefined | VoiceClient<Platform, MSC>>
Connect to a channel.

Returns
Itself.
Parameters
- channelResolvable: string | VoiceChannel | DMChannel | GroupDMChannel
Returns Promise<undefined | VoiceClient<Platform, MSC>>
- Defined in voice/src/VoiceClient.ts:376

connectTransport

connectTransport(address: string, roomId: string): Promise<void>
Parameters
- address: string
- roomId: string
Returns Promise<void>
- Defined in voice/src/VoiceClient.ts:175

disconnect

disconnect(): void
Returns void
- Defined in voice/src/VoiceClient.ts:422

disconnectTransport

disconnectTransport(error?: VoiceError, forceDisconnect?: boolean): void
Parameters
- Optional error: VoiceError
- forceDisconnect: boolean = false
Returns void
- Defined in voice/src/VoiceClient.ts:182

emit

emit<T>(event: T, ...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends keyof VoiceClientEvents
Parameters
- event: T
- Rest ...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]
Returns boolean
Inherited from EventEmitter.emit
- Defined in voice/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): (keyof VoiceClientEvents)[]
Return an array listing the events for which the emitter has registered listeners.

Returns (keyof VoiceClientEvents)[]
Inherited from EventEmitter.eventNames
- Defined in voice/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:15

initializeTransports

initializeTransports(): Promise<void>
Returns Promise<void>
- Defined in voice/src/VoiceClient.ts:225

isProducing

isProducing(type: "audio"): boolean
Parameters
- type: "audio"
Returns boolean
- Defined in voice/src/VoiceClient.ts:427

listenerCount

listenerCount(event: keyof VoiceClientEvents): number
Return the number of listeners listening to a given event.
Parameters
- event: keyof VoiceClientEvents
Returns number
Inherited from EventEmitter.listenerCount
- Defined in voice/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event: T): ((...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends keyof VoiceClientEvents
Parameters
- event: T
Returns ((...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]) => void)[]
Inherited from EventEmitter.listeners
- Defined in voice/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:20

off

off<T>(event: T, fn?: ((...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]) => void), context?: any, once?: boolean): VoiceClient<Platform, MSC>
Type Parameters
- T extends keyof VoiceClientEvents
Parameters
- event: T
- Optional fn: ((...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]) => void)
  - - (...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns VoiceClient<Platform, MSC>
Inherited from EventEmitter.off
- Defined in voice/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:69

on

on<T>(event: T, fn: ((...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]) => void), context?: any): VoiceClient<Platform, MSC>
Add a listener for a given event.
Type Parameters
- T extends keyof VoiceClientEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]) => void)
  - - (...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]
      
      Returns void
- Optional context: any
Returns VoiceClient<Platform, MSC>
Inherited from EventEmitter.on
- Defined in voice/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:40

once

once<T>(event: T, fn: ((...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]) => void), context?: any): VoiceClient<Platform, MSC>
Add a one-time listener for a given event.
Type Parameters
- T extends keyof VoiceClientEvents
Parameters
- event: T
- fn: ((...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]) => void)
  - - (...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]
      
      Returns void
- Optional context: any
Returns VoiceClient<Platform, MSC>
Inherited from EventEmitter.once
- Defined in voice/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?: keyof VoiceClientEvents): VoiceClient<Platform, MSC>
Remove all listeners, or those of the specified event.
Parameters
- Optional event: keyof VoiceClientEvents
Returns VoiceClient<Platform, MSC>
Inherited from EventEmitter.removeAllListeners
- Defined in voice/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event: T, fn?: ((...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]) => void), context?: any, once?: boolean): VoiceClient<Platform, MSC>
Remove the listeners of a given event.
Type Parameters
- T extends keyof VoiceClientEvents
Parameters
- event: T
- Optional fn: ((...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]) => void)
  - - (...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]): void
    - Parameters
      
      Rest ...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]
      
      Returns void
- Optional context: any
- Optional once: boolean
Returns VoiceClient<Platform, MSC>
Inherited from EventEmitter.removeListener
- Defined in voice/node_modules/.pnpm/[email protected]/node_modules/eventemitter3/index.d.ts:63

setStatus

setStatus(status: VoiceStatus): void
Parameters
- status: VoiceStatus
Returns void
- Defined in voice/src/VoiceClient.ts:366

`Private` startConsume

startConsume(userId: string, type: "audio"): Promise<void>
Parameters
- userId: string
- type: "audio"
Returns Promise<void>
- Defined in voice/src/VoiceClient.ts:269

startDeafen

startDeafen(): Promise<void>
Deafens yourself and stops consuming audio from participants.

Returns Promise<void>
- Defined in voice/src/VoiceClient.ts:437

startProduce

startProduce(type: "audio", track: MSC["MediaStreamTrack"]): Promise<void>
Parameters
- type: "audio"
- track: MSC["MediaStreamTrack"]
Returns Promise<void>
- Defined in voice/src/VoiceClient.ts:314

`Private` stopConsume

stopConsume(userId: string, type?: "audio"): Promise<void>
Parameters
- userId: string
- Optional type: "audio"
Returns Promise<void>
- Defined in voice/src/VoiceClient.ts:288

stopDeafen

stopDeafen(): Promise<void>
Undeafens yourself and restarts consuming audio from participants.

Returns Promise<void>
- Defined in voice/src/VoiceClient.ts:446

stopProduce

stopProduce(type: "audio"): Promise<void>
Parameters
- type: "audio"
Returns Promise<void>
- Defined in voice/src/VoiceClient.ts:337

`Private` throwIfUnsupported

throwIfUnsupported(): void
Returns void
- Defined in voice/src/VoiceClient.ts:171

Class VoiceClient<Platform, MSC>

Type Parameters

Platform extends MSCPlatform

MSC extends MediaSoup<Platform> = MediaSoup<Platform>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Platform extends MSCPlatform

MSC extends MediaSoup<Platform, MSC> = MediaSoup<Platform>

Parameters

platform: Platform

client: VoiceClientOptions | Client

msc: Platform extends "node" ? __module : __module

createDevice: (() => MSC["Device"])

Returns MSC["Device"]

Optional consumeTrack: VoiceClientConsumer<Platform>

Returns VoiceClient<Platform, MSC>

Properties

Private _deafened

Protected Optional audioProducer

channelID

client

Private Optional consumeTrack

Protected consumers

Private createDevice

Type declaration

Returns MSC["Device"]

Private Optional device

Private msc

participants

Readonly platform

Private recvTransport

Private sendTransport

Private sessionDetails

Private signaling

status

Readonly supported

Static prefixed

Accessors

channel

Returns undefined | Channel

connected

Returns boolean

deafened

Returns boolean

Methods

addListener

Type Parameters

T extends keyof VoiceClientEvents

Parameters

event: T

fn: ((...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]) => void)

Parameters

Rest ...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]

Returns void

Optional context: any

Returns VoiceClient<Platform, MSC>

authenticate

Parameters

token: string

Returns Promise<void>

connect

Returns

Parameters

channelResolvable: string | VoiceChannel | DMChannel | GroupDMChannel

Returns Promise<undefined | VoiceClient<Platform, MSC>>

connectTransport

Parameters

address: string

roomId: string

Returns Promise<void>

disconnect

Returns void

disconnectTransport

msc: Platform extends "node" ? module : module

`Optional` consumeTrack: VoiceClientConsumer<Platform>

`Private` _deafened

`Protected` `Optional` audioProducer

`Private` `Optional` consumeTrack

`Protected` consumers

`Private` createDevice

`Private` `Optional` device

`Private` msc

`Readonly` platform

`Private` recvTransport

`Private` sendTransport

`Private` sessionDetails

`Private` signaling

`Readonly` supported

`Static` prefixed

`Rest` ...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]

`Optional` context: any

`Optional` error: VoiceError

`Rest` ...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]

`Optional` fn: ((...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]) => void)

`Rest` ...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]

`Optional` context: any

`Optional` once: boolean

`Rest` ...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]

`Optional` context: any

`Rest` ...args: ArgumentMap<VoiceClientEvents>[Extract<T, keyof VoiceClientEvents>]

`Optional` context: any

`Optional` event: keyof VoiceClientEvents