Bridge | @types/ari-client

Hierarchy

Resource
- Bridge

Index

Properties

Methods

Properties

bridge_class

bridge_class: string

Bridging class.

bridge_type

bridge_type: string

Type of bridge technology.

channels

channels: string | string[]

Ids of channels participating in this bridge.

creationtime

creationtime: Date

Timestamp when bridge was created.

creator

creator: string

Entity that created the bridge.

id

id: string

Unique identifier for this bridge.

name

name: string

Name the creator gave the bridge.

technology

technology: string

Name of the current bridging technology.

Optional video_mode

video_mode: string

The video mode the bridge is using. One of none, talker, or single.

Optional video_source_id

video_source_id: string

The ID of the channel that is the source of video in this bridge, if one exists.

Methods

addChannel

addChannel(params: { absorbDTMF?: boolean; channel: string | string[]; mute?: boolean; role?: string }, callback: (err: Error) => void): void
addChannel(params: { absorbDTMF?: boolean; channel: string | string[]; mute?: boolean; role?: string }): Promise<void>

- Defined in index.d.ts:2868
Add a channel to a bridge.

Parameters
- params: { absorbDTMF?: boolean; channel: string | string[]; mute?: boolean; role?: string }
  - Optional absorbDTMF?: boolean
  - channel: string | string[]
    
    Ids of channels to add to bridge.
  - Optional mute?: boolean
  - Optional role?: string
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:2881
Add a channel to a bridge.

Parameters
- params: { absorbDTMF?: boolean; channel: string | string[]; mute?: boolean; role?: string }
  - Optional absorbDTMF?: boolean
  - channel: string | string[]
    
    Ids of channels to add to bridge.
  - Optional mute?: boolean
  - Optional role?: string
Returns Promise<void>

addListener

addListener(event: "Message", callback: (event: Message, instances: Message) => void): void
addListener(event: "MissingParams", callback: (event: MissingParams, instances: MissingParams) => void): void
addListener(event: "Event", callback: (event: Event, instances: Event) => void): void
addListener(event: "ContactInfo", callback: (event: ContactInfo, instances: ContactInfo) => void): void
addListener(event: "Peer", callback: (event: Peer, instances: Peer) => void): void
addListener(event: "DeviceStateChanged", callback: (event: DeviceStateChanged, devicestate: DeviceState) => void): void
addListener(event: "PlaybackStarted", callback: (event: PlaybackStarted, playback: Playback) => void): void
addListener(event: "PlaybackContinuing", callback: (event: PlaybackContinuing, playback: Playback) => void): void
addListener(event: "PlaybackFinished", callback: (event: PlaybackFinished, playback: Playback) => void): void
addListener(event: "RecordingStarted", callback: (event: RecordingStarted, liverecording: LiveRecording) => void): void
addListener(event: "RecordingFinished", callback: (event: RecordingFinished, liverecording: LiveRecording) => void): void
addListener(event: "RecordingFailed", callback: (event: RecordingFailed, liverecording: LiveRecording) => void): void
addListener(event: "ApplicationMoveFailed", callback: (event: ApplicationMoveFailed, channel: Channel) => void): void
addListener(event: "ApplicationReplaced", callback: (event: Event) => void): void
addListener(event: "BridgeCreated", callback: (event: BridgeCreated, bridge: Bridge) => void): void
addListener(event: "BridgeDestroyed", callback: (event: BridgeDestroyed, bridge: Bridge) => void): void
addListener(event: "BridgeMerged", callback: (event: BridgeMerged, bridge: Bridge) => void): void
addListener(event: "BridgeVideoSourceChanged", callback: (event: BridgeVideoSourceChanged, bridge: Bridge) => void): void
addListener(event: "BridgeBlindTransfer", callback: (event: BridgeBlindTransfer, instances: BridgeBlindTransfer) => void): void
addListener(event: "BridgeAttendedTransfer", callback: (event: BridgeAttendedTransfer, instances: BridgeAttendedTransfer) => void): void
addListener(event: "ChannelCreated", callback: (event: ChannelCreated, channel: Channel) => void): void
addListener(event: "ChannelDestroyed", callback: (event: ChannelDestroyed, channel: Channel) => void): void
addListener(event: "ChannelEnteredBridge", callback: (event: ChannelEnteredBridge, instances: ChannelEnteredBridge) => void): void
addListener(event: "ChannelLeftBridge", callback: (event: ChannelLeftBridge, instances: ChannelLeftBridge) => void): void
addListener(event: "ChannelStateChange", callback: (event: ChannelStateChange, channel: Channel) => void): void
addListener(event: "ChannelDtmfReceived", callback: (event: ChannelDtmfReceived, channel: Channel) => void): void
addListener(event: "ChannelDialplan", callback: (event: ChannelDialplan, channel: Channel) => void): void
addListener(event: "ChannelCallerId", callback: (event: ChannelCallerId, channel: Channel) => void): void
addListener(event: "ChannelUserevent", callback: (event: ChannelUserevent, instances: ChannelUserevent) => void): void
addListener(event: "ChannelHangupRequest", callback: (event: ChannelHangupRequest, channel: Channel) => void): void
addListener(event: "ChannelVarset", callback: (event: ChannelVarset, channel: Channel) => void): void
addListener(event: "ChannelHold", callback: (event: ChannelHold, channel: Channel) => void): void
addListener(event: "ChannelUnhold", callback: (event: ChannelUnhold, channel: Channel) => void): void
addListener(event: "ChannelTalkingStarted", callback: (event: ChannelTalkingStarted, channel: Channel) => void): void
addListener(event: "ChannelTalkingFinished", callback: (event: ChannelTalkingFinished, channel: Channel) => void): void
addListener(event: "ContactStatusChange", callback: (event: ContactStatusChange, endpoint: Endpoint) => void): void
addListener(event: "PeerStatusChange", callback: (event: PeerStatusChange, endpoint: Endpoint) => void): void
addListener(event: "EndpointStateChange", callback: (event: EndpointStateChange, endpoint: Endpoint) => void): void
addListener(event: "Dial", callback: (event: Dial, channel: Channel) => void): void
addListener(event: "StasisEnd", callback: (event: StasisEnd, channel: Channel) => void): void
addListener(event: "StasisStart", callback: (event: StasisStart, channel: Channel) => void): void
addListener(event: "TextMessageReceived", callback: (event: TextMessageReceived, endpoint: Endpoint) => void): void
addListener(event: "ChannelConnectedLine", callback: (event: ChannelConnectedLine, channel: Channel) => void): void

Inherited from Resource.addListener
- Defined in index.d.ts:1399
Base type for errors and events.

Parameters
- event: "Message"
- callback: (event: Message, instances: Message) => void
  - - (event: Message, instances: Message): void
    - Parameters
      - event: Message
      - instances: Message
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1404
Error event sent when required params are missing.

Parameters
- event: "MissingParams"
- callback: (event: MissingParams, instances: MissingParams) => void
  - - (event: MissingParams, instances: MissingParams): void
    - Parameters
      - event: MissingParams
      - instances: MissingParams
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1412
Base type for asynchronous events from Asterisk.

Parameters
- event: "Event"
- callback: (event: Event, instances: Event) => void
  - - (event: Event, instances: Event): void
    - Parameters
      - event: Event
      - instances: Event
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1417
Detailed information about a contact on an endpoint.

Parameters
- event: "ContactInfo"
- callback: (event: ContactInfo, instances: ContactInfo) => void
  - - (event: ContactInfo, instances: ContactInfo): void
    - Parameters
      - event: ContactInfo
      - instances: ContactInfo
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1422
Detailed information about a remote peer that communicates with Asterisk.

Parameters
- event: "Peer"
- callback: (event: Peer, instances: Peer) => void
  - - (event: Peer, instances: Peer): void
    - Parameters
      - event: Peer
      - instances: Peer
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1427
Notification that a device state has changed.

Parameters
- event: "DeviceStateChanged"
- callback: (event: DeviceStateChanged, devicestate: DeviceState) => void
  - - (event: DeviceStateChanged, devicestate: DeviceState): void
    - Parameters
      - event: DeviceStateChanged
      - devicestate: DeviceState
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1435
Event showing the start of a media playback operation.

Parameters
- event: "PlaybackStarted"
- callback: (event: PlaybackStarted, playback: Playback) => void
  - - (event: PlaybackStarted, playback: Playback): void
    - Parameters
      - event: PlaybackStarted
      - playback: Playback
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1440
Event showing the continuation of a media playback operation from one media URI to the next in the list.

Parameters
- event: "PlaybackContinuing"
- callback: (event: PlaybackContinuing, playback: Playback) => void
  - - (event: PlaybackContinuing, playback: Playback): void
    - Parameters
      - event: PlaybackContinuing
      - playback: Playback
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1448
Event showing the completion of a media playback operation.

Parameters
- event: "PlaybackFinished"
- callback: (event: PlaybackFinished, playback: Playback) => void
  - - (event: PlaybackFinished, playback: Playback): void
    - Parameters
      - event: PlaybackFinished
      - playback: Playback
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1456
Event showing the start of a recording operation.

Parameters
- event: "RecordingStarted"
- callback: (event: RecordingStarted, liverecording: LiveRecording) => void
  - - (event: RecordingStarted, liverecording: LiveRecording): void
    - Parameters
      - event: RecordingStarted
      - liverecording: LiveRecording
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1464
Event showing the completion of a recording operation.

Parameters
- event: "RecordingFinished"
- callback: (event: RecordingFinished, liverecording: LiveRecording) => void
  - - (event: RecordingFinished, liverecording: LiveRecording): void
    - Parameters
      - event: RecordingFinished
      - liverecording: LiveRecording
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1472
Event showing failure of a recording operation.

Parameters
- event: "RecordingFailed"
- callback: (event: RecordingFailed, liverecording: LiveRecording) => void
  - - (event: RecordingFailed, liverecording: LiveRecording): void
    - Parameters
      - event: RecordingFailed
      - liverecording: LiveRecording
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1480
Notification that trying to move a channel to another Stasis application failed.

Parameters
- event: "ApplicationMoveFailed"
- callback: (event: ApplicationMoveFailed, channel: Channel) => void
  - - (event: ApplicationMoveFailed, channel: Channel): void
    - Parameters
      - event: ApplicationMoveFailed
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1489
Notification that another WebSocket has taken over for an application. An application may only be subscribed to by a single WebSocket at a time. If multiple WebSockets attempt to subscribe to the same application, the newer WebSocket wins, and the older one receives this event.

Parameters
- event: "ApplicationReplaced"
- callback: (event: Event) => void
  - - (event: Event): void
    - Parameters
      - event: Event
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1494
Notification that a bridge has been created.

Parameters
- event: "BridgeCreated"
- callback: (event: BridgeCreated, bridge: Bridge) => void
  - - (event: BridgeCreated, bridge: Bridge): void
    - Parameters
      - event: BridgeCreated
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1499
Notification that a bridge has been destroyed.

Parameters
- event: "BridgeDestroyed"
- callback: (event: BridgeDestroyed, bridge: Bridge) => void
  - - (event: BridgeDestroyed, bridge: Bridge): void
    - Parameters
      - event: BridgeDestroyed
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1504
Notification that one bridge has merged into another.

Parameters
- event: "BridgeMerged"
- callback: (event: BridgeMerged, bridge: Bridge) => void
  - - (event: BridgeMerged, bridge: Bridge): void
    - Parameters
      - event: BridgeMerged
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1509
Notification that the source of video in a bridge has changed.

Parameters
- event: "BridgeVideoSourceChanged"
- callback: (event: BridgeVideoSourceChanged, bridge: Bridge) => void
  - - (event: BridgeVideoSourceChanged, bridge: Bridge): void
    - Parameters
      - event: BridgeVideoSourceChanged
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1517
Notification that a blind transfer has occurred.

Parameters
- event: "BridgeBlindTransfer"
- callback: (event: BridgeBlindTransfer, instances: BridgeBlindTransfer) => void
  - - (event: BridgeBlindTransfer, instances: BridgeBlindTransfer): void
    - Parameters
      - event: BridgeBlindTransfer
      - instances: BridgeBlindTransfer
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1525
Notification that an attended transfer has occurred.

Parameters
- event: "BridgeAttendedTransfer"
- callback: (event: BridgeAttendedTransfer, instances: BridgeAttendedTransfer) => void
  - - (event: BridgeAttendedTransfer, instances: BridgeAttendedTransfer): void
    - Parameters
      - event: BridgeAttendedTransfer
      - instances: BridgeAttendedTransfer
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1533
Notification that a channel has been created.

Parameters
- event: "ChannelCreated"
- callback: (event: ChannelCreated, channel: Channel) => void
  - - (event: ChannelCreated, channel: Channel): void
    - Parameters
      - event: ChannelCreated
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1538
Notification that a channel has been destroyed.

Parameters
- event: "ChannelDestroyed"
- callback: (event: ChannelDestroyed, channel: Channel) => void
  - - (event: ChannelDestroyed, channel: Channel): void
    - Parameters
      - event: ChannelDestroyed
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1543
Notification that a channel has entered a bridge.

Parameters
- event: "ChannelEnteredBridge"
- callback: (event: ChannelEnteredBridge, instances: ChannelEnteredBridge) => void
  - - (event: ChannelEnteredBridge, instances: ChannelEnteredBridge): void
    - Parameters
      - event: ChannelEnteredBridge
      - instances: ChannelEnteredBridge
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1551
Notification that a channel has left a bridge.

Parameters
- event: "ChannelLeftBridge"
- callback: (event: ChannelLeftBridge, instances: ChannelLeftBridge) => void
  - - (event: ChannelLeftBridge, instances: ChannelLeftBridge): void
    - Parameters
      - event: ChannelLeftBridge
      - instances: ChannelLeftBridge
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1559
Notification of a channels state change.

Parameters
- event: "ChannelStateChange"
- callback: (event: ChannelStateChange, channel: Channel) => void
  - - (event: ChannelStateChange, channel: Channel): void
    - Parameters
      - event: ChannelStateChange
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1567
DTMF received on a channel. This event is sent when the DTMF ends. There is no notification about the start of DTMF.

Parameters
- event: "ChannelDtmfReceived"
- callback: (event: ChannelDtmfReceived, channel: Channel) => void
  - - (event: ChannelDtmfReceived, channel: Channel): void
    - Parameters
      - event: ChannelDtmfReceived
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1575
Channel changed location in the dialplan.

Parameters
- event: "ChannelDialplan"
- callback: (event: ChannelDialplan, channel: Channel) => void
  - - (event: ChannelDialplan, channel: Channel): void
    - Parameters
      - event: ChannelDialplan
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1580
Channel changed Caller ID.

Parameters
- event: "ChannelCallerId"
- callback: (event: ChannelCallerId, channel: Channel) => void
  - - (event: ChannelCallerId, channel: Channel): void
    - Parameters
      - event: ChannelCallerId
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1585
User-generated event with additional user-defined fields in the object.

Parameters
- event: "ChannelUserevent"
- callback: (event: ChannelUserevent, instances: ChannelUserevent) => void
  - - (event: ChannelUserevent, instances: ChannelUserevent): void
    - Parameters
      - event: ChannelUserevent
      - instances: ChannelUserevent
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1593
A hangup was requested on the channel.

Parameters
- event: "ChannelHangupRequest"
- callback: (event: ChannelHangupRequest, channel: Channel) => void
  - - (event: ChannelHangupRequest, channel: Channel): void
    - Parameters
      - event: ChannelHangupRequest
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1601
Channel variable changed.

Parameters
- event: "ChannelVarset"
- callback: (event: ChannelVarset, channel: Channel) => void
  - - (event: ChannelVarset, channel: Channel): void
    - Parameters
      - event: ChannelVarset
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1606
A channel initiated a media hold.

Parameters
- event: "ChannelHold"
- callback: (event: ChannelHold, channel: Channel) => void
  - - (event: ChannelHold, channel: Channel): void
    - Parameters
      - event: ChannelHold
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1611
A channel initiated a media unhold.

Parameters
- event: "ChannelUnhold"
- callback: (event: ChannelUnhold, channel: Channel) => void
  - - (event: ChannelUnhold, channel: Channel): void
    - Parameters
      - event: ChannelUnhold
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1616
Talking was detected on the channel.

Parameters
- event: "ChannelTalkingStarted"
- callback: (event: ChannelTalkingStarted, channel: Channel) => void
  - - (event: ChannelTalkingStarted, channel: Channel): void
    - Parameters
      - event: ChannelTalkingStarted
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1624
Talking is no longer detected on the channel.

Parameters
- event: "ChannelTalkingFinished"
- callback: (event: ChannelTalkingFinished, channel: Channel) => void
  - - (event: ChannelTalkingFinished, channel: Channel): void
    - Parameters
      - event: ChannelTalkingFinished
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1632
The state of a contact on an endpoint has changed.

Parameters
- event: "ContactStatusChange"
- callback: (event: ContactStatusChange, endpoint: Endpoint) => void
  - - (event: ContactStatusChange, endpoint: Endpoint): void
    - Parameters
      - event: ContactStatusChange
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1640
The state of a peer associated with an endpoint has changed.

Parameters
- event: "PeerStatusChange"
- callback: (event: PeerStatusChange, endpoint: Endpoint) => void
  - - (event: PeerStatusChange, endpoint: Endpoint): void
    - Parameters
      - event: PeerStatusChange
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1648
Endpoint state changed.

Parameters
- event: "EndpointStateChange"
- callback: (event: EndpointStateChange, endpoint: Endpoint) => void
  - - (event: EndpointStateChange, endpoint: Endpoint): void
    - Parameters
      - event: EndpointStateChange
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1656
Dialing state has changed.

Parameters
- event: "Dial"
- callback: (event: Dial, channel: Channel) => void
  - - (event: Dial, channel: Channel): void
    - Parameters
      - event: Dial
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1661
Notification that a channel has left a Stasis application.

Parameters
- event: "StasisEnd"
- callback: (event: StasisEnd, channel: Channel) => void
  - - (event: StasisEnd, channel: Channel): void
    - Parameters
      - event: StasisEnd
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1666
Notification that a channel has entered a Stasis application.

Parameters
- event: "StasisStart"
- callback: (event: StasisStart, channel: Channel) => void
  - - (event: StasisStart, channel: Channel): void
    - Parameters
      - event: StasisStart
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1671
A text message was received from an endpoint.

Parameters
- event: "TextMessageReceived"
- callback: (event: TextMessageReceived, endpoint: Endpoint) => void
  - - (event: TextMessageReceived, endpoint: Endpoint): void
    - Parameters
      - event: TextMessageReceived
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.addListener
- Defined in index.d.ts:1679
Channel changed Connected Line.

Parameters
- event: "ChannelConnectedLine"
- callback: (event: ChannelConnectedLine, channel: Channel) => void
  - - (event: ChannelConnectedLine, channel: Channel): void
    - Parameters
      - event: ChannelConnectedLine
      - channel: Channel
      Returns void
Returns void

clearVideoSource

clearVideoSource(callback: (err: Error) => void): void
clearVideoSource(): Promise<void>

- Defined in index.d.ts:2920
Removes any explicit video source in a multi-party mixing bridge. This operation has no effect on bridges with two or fewer participants. When no explicit video source is set, talk detection will be used to determine the active video stream.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:2926
Removes any explicit video source in a multi-party mixing bridge. This operation has no effect on bridges with two or fewer participants. When no explicit video source is set, talk detection will be used to determine the active video stream.

Returns Promise<void>

create

create(params: { name?: string; type?: string }, callback: (err: Error, bridge: Bridge) => void): void
create(callback: (err: Error, bridge: Bridge) => void): void
create(params?: { name?: string; type?: string }): Promise<Bridge>

- Defined in index.d.ts:2797
Create a new bridge. This bridge persists until it has been shut down, or Asterisk has been shut down.

Parameters
- params: { name?: string; type?: string }
  - Optional name?: string
  - Optional type?: string
- callback: (err: Error, bridge: Bridge) => void
  - - (err: Error, bridge: Bridge): void
    - Parameters
      - err: Error
      - bridge: Bridge
      Returns void
Returns void
- Defined in index.d.ts:2803
Create a new bridge. This bridge persists until it has been shut down, or Asterisk has been shut down.

Parameters
- callback: (err: Error, bridge: Bridge) => void
  - - (err: Error, bridge: Bridge): void
    - Parameters
      - err: Error
      - bridge: Bridge
      Returns void
Returns void
- Defined in index.d.ts:2812
Create a new bridge. This bridge persists until it has been shut down, or Asterisk has been shut down.

Parameters
- Optional params: { name?: string; type?: string }
  - Optional name?: string
  - Optional type?: string
Returns Promise<Bridge>

createWithId

createWithId(params: { name?: string; type?: string }, callback: (err: Error, bridge: Bridge) => void): void
createWithId(callback: (err: Error, bridge: Bridge) => void): void
createWithId(params?: { name?: string; type?: string }): Promise<Bridge>

- Defined in index.d.ts:2821
Create a new bridge or updates an existing one. This bridge persists until it has been shut down, or Asterisk has been shut down.

Parameters
- params: { name?: string; type?: string }
  - Optional name?: string
  - Optional type?: string
- callback: (err: Error, bridge: Bridge) => void
  - - (err: Error, bridge: Bridge): void
    - Parameters
      - err: Error
      - bridge: Bridge
      Returns void
Returns void
- Defined in index.d.ts:2827
Create a new bridge or updates an existing one. This bridge persists until it has been shut down, or Asterisk has been shut down.

Parameters
- callback: (err: Error, bridge: Bridge) => void
  - - (err: Error, bridge: Bridge): void
    - Parameters
      - err: Error
      - bridge: Bridge
      Returns void
Returns void
- Defined in index.d.ts:2836
Create a new bridge or updates an existing one. This bridge persists until it has been shut down, or Asterisk has been shut down.

Parameters
- Optional params: { name?: string; type?: string }
  - Optional name?: string
  - Optional type?: string
Returns Promise<Bridge>

destroy

destroy(callback: (err: Error) => void): void
destroy(): Promise<void>

- Defined in index.d.ts:2852
Shut down a bridge. If any channels are in this bridge, they will be removed and resume whatever they were doing beforehand.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:2858
Shut down a bridge. If any channels are in this bridge, they will be removed and resume whatever they were doing beforehand.

Returns Promise<void>

get

get(callback: (err: Error, bridge: Bridge) => void): void
get(): Promise<Bridge>

- Defined in index.d.ts:2841
Get bridge details.

Parameters
- callback: (err: Error, bridge: Bridge) => void
  - - (err: Error, bridge: Bridge): void
    - Parameters
      - err: Error
      - bridge: Bridge
      Returns void
Returns void
- Defined in index.d.ts:2846
Get bridge details.

Returns Promise<Bridge>

list

list(callback: (err: Error, bridges: Bridge[]) => void): void
list(): Promise<Bridge[]>

- Defined in index.d.ts:2783
List all active bridges in Asterisk.

Parameters
- callback: (err: Error, bridges: Bridge[]) => void
  - - (err: Error, bridges: Bridge[]): void
    - Parameters
      - err: Error
      - bridges: Bridge[]
      Returns void
Returns void
- Defined in index.d.ts:2788
List all active bridges in Asterisk.

Returns Promise<Bridge[]>

on

on(event: "Message", callback: (event: Message, instances: Message) => void): void
on(event: "MissingParams", callback: (event: MissingParams, instances: MissingParams) => void): void
on(event: "Event", callback: (event: Event, instances: Event) => void): void
on(event: "ContactInfo", callback: (event: ContactInfo, instances: ContactInfo) => void): void
on(event: "Peer", callback: (event: Peer, instances: Peer) => void): void
on(event: "DeviceStateChanged", callback: (event: DeviceStateChanged, devicestate: DeviceState) => void): void
on(event: "PlaybackStarted", callback: (event: PlaybackStarted, playback: Playback) => void): void
on(event: "PlaybackContinuing", callback: (event: PlaybackContinuing, playback: Playback) => void): void
on(event: "PlaybackFinished", callback: (event: PlaybackFinished, playback: Playback) => void): void
on(event: "RecordingStarted", callback: (event: RecordingStarted, liverecording: LiveRecording) => void): void
on(event: "RecordingFinished", callback: (event: RecordingFinished, liverecording: LiveRecording) => void): void
on(event: "RecordingFailed", callback: (event: RecordingFailed, liverecording: LiveRecording) => void): void
on(event: "ApplicationMoveFailed", callback: (event: ApplicationMoveFailed, channel: Channel) => void): void
on(event: "ApplicationReplaced", callback: (event: Event) => void): void
on(event: "BridgeCreated", callback: (event: BridgeCreated, bridge: Bridge) => void): void
on(event: "BridgeDestroyed", callback: (event: BridgeDestroyed, bridge: Bridge) => void): void
on(event: "BridgeMerged", callback: (event: BridgeMerged, bridge: Bridge) => void): void
on(event: "BridgeVideoSourceChanged", callback: (event: BridgeVideoSourceChanged, bridge: Bridge) => void): void
on(event: "BridgeBlindTransfer", callback: (event: BridgeBlindTransfer, instances: BridgeBlindTransfer) => void): void
on(event: "BridgeAttendedTransfer", callback: (event: BridgeAttendedTransfer, instances: BridgeAttendedTransfer) => void): void
on(event: "ChannelCreated", callback: (event: ChannelCreated, channel: Channel) => void): void
on(event: "ChannelDestroyed", callback: (event: ChannelDestroyed, channel: Channel) => void): void
on(event: "ChannelEnteredBridge", callback: (event: ChannelEnteredBridge, instances: ChannelEnteredBridge) => void): void
on(event: "ChannelLeftBridge", callback: (event: ChannelLeftBridge, instances: ChannelLeftBridge) => void): void
on(event: "ChannelStateChange", callback: (event: ChannelStateChange, channel: Channel) => void): void
on(event: "ChannelDtmfReceived", callback: (event: ChannelDtmfReceived, channel: Channel) => void): void
on(event: "ChannelDialplan", callback: (event: ChannelDialplan, channel: Channel) => void): void
on(event: "ChannelCallerId", callback: (event: ChannelCallerId, channel: Channel) => void): void
on(event: "ChannelUserevent", callback: (event: ChannelUserevent, instances: ChannelUserevent) => void): void
on(event: "ChannelHangupRequest", callback: (event: ChannelHangupRequest, channel: Channel) => void): void
on(event: "ChannelVarset", callback: (event: ChannelVarset, channel: Channel) => void): void
on(event: "ChannelHold", callback: (event: ChannelHold, channel: Channel) => void): void
on(event: "ChannelUnhold", callback: (event: ChannelUnhold, channel: Channel) => void): void
on(event: "ChannelTalkingStarted", callback: (event: ChannelTalkingStarted, channel: Channel) => void): void
on(event: "ChannelTalkingFinished", callback: (event: ChannelTalkingFinished, channel: Channel) => void): void
on(event: "ContactStatusChange", callback: (event: ContactStatusChange, endpoint: Endpoint) => void): void
on(event: "PeerStatusChange", callback: (event: PeerStatusChange, endpoint: Endpoint) => void): void
on(event: "EndpointStateChange", callback: (event: EndpointStateChange, endpoint: Endpoint) => void): void
on(event: "Dial", callback: (event: Dial, channel: Channel) => void): void
on(event: "StasisEnd", callback: (event: StasisEnd, channel: Channel) => void): void
on(event: "StasisStart", callback: (event: StasisStart, channel: Channel) => void): void
on(event: "TextMessageReceived", callback: (event: TextMessageReceived, endpoint: Endpoint) => void): void
on(event: "ChannelConnectedLine", callback: (event: ChannelConnectedLine, channel: Channel) => void): void

Inherited from Resource.on
- Defined in index.d.ts:898
Base type for errors and events.

Parameters
- event: "Message"
- callback: (event: Message, instances: Message) => void
  - - (event: Message, instances: Message): void
    - Parameters
      - event: Message
      - instances: Message
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:903
Error event sent when required params are missing.

Parameters
- event: "MissingParams"
- callback: (event: MissingParams, instances: MissingParams) => void
  - - (event: MissingParams, instances: MissingParams): void
    - Parameters
      - event: MissingParams
      - instances: MissingParams
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:908
Base type for asynchronous events from Asterisk.

Parameters
- event: "Event"
- callback: (event: Event, instances: Event) => void
  - - (event: Event, instances: Event): void
    - Parameters
      - event: Event
      - instances: Event
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:913
Detailed information about a contact on an endpoint.

Parameters
- event: "ContactInfo"
- callback: (event: ContactInfo, instances: ContactInfo) => void
  - - (event: ContactInfo, instances: ContactInfo): void
    - Parameters
      - event: ContactInfo
      - instances: ContactInfo
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:918
Detailed information about a remote peer that communicates with Asterisk.

Parameters
- event: "Peer"
- callback: (event: Peer, instances: Peer) => void
  - - (event: Peer, instances: Peer): void
    - Parameters
      - event: Peer
      - instances: Peer
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:923
Notification that a device state has changed.

Parameters
- event: "DeviceStateChanged"
- callback: (event: DeviceStateChanged, devicestate: DeviceState) => void
  - - (event: DeviceStateChanged, devicestate: DeviceState): void
    - Parameters
      - event: DeviceStateChanged
      - devicestate: DeviceState
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:931
Event showing the start of a media playback operation.

Parameters
- event: "PlaybackStarted"
- callback: (event: PlaybackStarted, playback: Playback) => void
  - - (event: PlaybackStarted, playback: Playback): void
    - Parameters
      - event: PlaybackStarted
      - playback: Playback
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:936
Event showing the continuation of a media playback operation from one media URI to the next in the list.

Parameters
- event: "PlaybackContinuing"
- callback: (event: PlaybackContinuing, playback: Playback) => void
  - - (event: PlaybackContinuing, playback: Playback): void
    - Parameters
      - event: PlaybackContinuing
      - playback: Playback
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:941
Event showing the completion of a media playback operation.

Parameters
- event: "PlaybackFinished"
- callback: (event: PlaybackFinished, playback: Playback) => void
  - - (event: PlaybackFinished, playback: Playback): void
    - Parameters
      - event: PlaybackFinished
      - playback: Playback
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:946
Event showing the start of a recording operation.

Parameters
- event: "RecordingStarted"
- callback: (event: RecordingStarted, liverecording: LiveRecording) => void
  - - (event: RecordingStarted, liverecording: LiveRecording): void
    - Parameters
      - event: RecordingStarted
      - liverecording: LiveRecording
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:954
Event showing the completion of a recording operation.

Parameters
- event: "RecordingFinished"
- callback: (event: RecordingFinished, liverecording: LiveRecording) => void
  - - (event: RecordingFinished, liverecording: LiveRecording): void
    - Parameters
      - event: RecordingFinished
      - liverecording: LiveRecording
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:962
Event showing failure of a recording operation.

Parameters
- event: "RecordingFailed"
- callback: (event: RecordingFailed, liverecording: LiveRecording) => void
  - - (event: RecordingFailed, liverecording: LiveRecording): void
    - Parameters
      - event: RecordingFailed
      - liverecording: LiveRecording
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:967
Notification that trying to move a channel to another Stasis application failed.

Parameters
- event: "ApplicationMoveFailed"
- callback: (event: ApplicationMoveFailed, channel: Channel) => void
  - - (event: ApplicationMoveFailed, channel: Channel): void
    - Parameters
      - event: ApplicationMoveFailed
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:973
Notification that another WebSocket has taken over for an application. An application may only be subscribed to by a single WebSocket at a time. If multiple WebSockets attempt to subscribe to the same application, the newer WebSocket wins, and the older one receives this event.

Parameters
- event: "ApplicationReplaced"
- callback: (event: Event) => void
  - - (event: Event): void
    - Parameters
      - event: Event
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:978
Notification that a bridge has been created.

Parameters
- event: "BridgeCreated"
- callback: (event: BridgeCreated, bridge: Bridge) => void
  - - (event: BridgeCreated, bridge: Bridge): void
    - Parameters
      - event: BridgeCreated
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:983
Notification that a bridge has been destroyed.

Parameters
- event: "BridgeDestroyed"
- callback: (event: BridgeDestroyed, bridge: Bridge) => void
  - - (event: BridgeDestroyed, bridge: Bridge): void
    - Parameters
      - event: BridgeDestroyed
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:988
Notification that one bridge has merged into another.

Parameters
- event: "BridgeMerged"
- callback: (event: BridgeMerged, bridge: Bridge) => void
  - - (event: BridgeMerged, bridge: Bridge): void
    - Parameters
      - event: BridgeMerged
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:993
Notification that the source of video in a bridge has changed.

Parameters
- event: "BridgeVideoSourceChanged"
- callback: (event: BridgeVideoSourceChanged, bridge: Bridge) => void
  - - (event: BridgeVideoSourceChanged, bridge: Bridge): void
    - Parameters
      - event: BridgeVideoSourceChanged
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1001
Notification that a blind transfer has occurred.

Parameters
- event: "BridgeBlindTransfer"
- callback: (event: BridgeBlindTransfer, instances: BridgeBlindTransfer) => void
  - - (event: BridgeBlindTransfer, instances: BridgeBlindTransfer): void
    - Parameters
      - event: BridgeBlindTransfer
      - instances: BridgeBlindTransfer
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1009
Notification that an attended transfer has occurred.

Parameters
- event: "BridgeAttendedTransfer"
- callback: (event: BridgeAttendedTransfer, instances: BridgeAttendedTransfer) => void
  - - (event: BridgeAttendedTransfer, instances: BridgeAttendedTransfer): void
    - Parameters
      - event: BridgeAttendedTransfer
      - instances: BridgeAttendedTransfer
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1017
Notification that a channel has been created.

Parameters
- event: "ChannelCreated"
- callback: (event: ChannelCreated, channel: Channel) => void
  - - (event: ChannelCreated, channel: Channel): void
    - Parameters
      - event: ChannelCreated
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1022
Notification that a channel has been destroyed.

Parameters
- event: "ChannelDestroyed"
- callback: (event: ChannelDestroyed, channel: Channel) => void
  - - (event: ChannelDestroyed, channel: Channel): void
    - Parameters
      - event: ChannelDestroyed
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1027
Notification that a channel has entered a bridge.

Parameters
- event: "ChannelEnteredBridge"
- callback: (event: ChannelEnteredBridge, instances: ChannelEnteredBridge) => void
  - - (event: ChannelEnteredBridge, instances: ChannelEnteredBridge): void
    - Parameters
      - event: ChannelEnteredBridge
      - instances: ChannelEnteredBridge
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1035
Notification that a channel has left a bridge.

Parameters
- event: "ChannelLeftBridge"
- callback: (event: ChannelLeftBridge, instances: ChannelLeftBridge) => void
  - - (event: ChannelLeftBridge, instances: ChannelLeftBridge): void
    - Parameters
      - event: ChannelLeftBridge
      - instances: ChannelLeftBridge
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1043
Notification of a channels state change.

Parameters
- event: "ChannelStateChange"
- callback: (event: ChannelStateChange, channel: Channel) => void
  - - (event: ChannelStateChange, channel: Channel): void
    - Parameters
      - event: ChannelStateChange
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1048
DTMF received on a channel. This event is sent when the DTMF ends. There is no notification about the start of DTMF.

Parameters
- event: "ChannelDtmfReceived"
- callback: (event: ChannelDtmfReceived, channel: Channel) => void
  - - (event: ChannelDtmfReceived, channel: Channel): void
    - Parameters
      - event: ChannelDtmfReceived
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1053
Channel changed location in the dialplan.

Parameters
- event: "ChannelDialplan"
- callback: (event: ChannelDialplan, channel: Channel) => void
  - - (event: ChannelDialplan, channel: Channel): void
    - Parameters
      - event: ChannelDialplan
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1058
Channel changed Caller ID.

Parameters
- event: "ChannelCallerId"
- callback: (event: ChannelCallerId, channel: Channel) => void
  - - (event: ChannelCallerId, channel: Channel): void
    - Parameters
      - event: ChannelCallerId
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1063
User-generated event with additional user-defined fields in the object.

Parameters
- event: "ChannelUserevent"
- callback: (event: ChannelUserevent, instances: ChannelUserevent) => void
  - - (event: ChannelUserevent, instances: ChannelUserevent): void
    - Parameters
      - event: ChannelUserevent
      - instances: ChannelUserevent
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1071
A hangup was requested on the channel.

Parameters
- event: "ChannelHangupRequest"
- callback: (event: ChannelHangupRequest, channel: Channel) => void
  - - (event: ChannelHangupRequest, channel: Channel): void
    - Parameters
      - event: ChannelHangupRequest
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1076
Channel variable changed.

Parameters
- event: "ChannelVarset"
- callback: (event: ChannelVarset, channel: Channel) => void
  - - (event: ChannelVarset, channel: Channel): void
    - Parameters
      - event: ChannelVarset
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1081
A channel initiated a media hold.

Parameters
- event: "ChannelHold"
- callback: (event: ChannelHold, channel: Channel) => void
  - - (event: ChannelHold, channel: Channel): void
    - Parameters
      - event: ChannelHold
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1086
A channel initiated a media unhold.

Parameters
- event: "ChannelUnhold"
- callback: (event: ChannelUnhold, channel: Channel) => void
  - - (event: ChannelUnhold, channel: Channel): void
    - Parameters
      - event: ChannelUnhold
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1091
Talking was detected on the channel.

Parameters
- event: "ChannelTalkingStarted"
- callback: (event: ChannelTalkingStarted, channel: Channel) => void
  - - (event: ChannelTalkingStarted, channel: Channel): void
    - Parameters
      - event: ChannelTalkingStarted
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1096
Talking is no longer detected on the channel.

Parameters
- event: "ChannelTalkingFinished"
- callback: (event: ChannelTalkingFinished, channel: Channel) => void
  - - (event: ChannelTalkingFinished, channel: Channel): void
    - Parameters
      - event: ChannelTalkingFinished
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1104
The state of a contact on an endpoint has changed.

Parameters
- event: "ContactStatusChange"
- callback: (event: ContactStatusChange, endpoint: Endpoint) => void
  - - (event: ContactStatusChange, endpoint: Endpoint): void
    - Parameters
      - event: ContactStatusChange
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1109
The state of a peer associated with an endpoint has changed.

Parameters
- event: "PeerStatusChange"
- callback: (event: PeerStatusChange, endpoint: Endpoint) => void
  - - (event: PeerStatusChange, endpoint: Endpoint): void
    - Parameters
      - event: PeerStatusChange
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1114
Endpoint state changed.

Parameters
- event: "EndpointStateChange"
- callback: (event: EndpointStateChange, endpoint: Endpoint) => void
  - - (event: EndpointStateChange, endpoint: Endpoint): void
    - Parameters
      - event: EndpointStateChange
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1119
Dialing state has changed.

Parameters
- event: "Dial"
- callback: (event: Dial, channel: Channel) => void
  - - (event: Dial, channel: Channel): void
    - Parameters
      - event: Dial
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1124
Notification that a channel has left a Stasis application.

Parameters
- event: "StasisEnd"
- callback: (event: StasisEnd, channel: Channel) => void
  - - (event: StasisEnd, channel: Channel): void
    - Parameters
      - event: StasisEnd
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1129
Notification that a channel has entered a Stasis application.

Parameters
- event: "StasisStart"
- callback: (event: StasisStart, channel: Channel) => void
  - - (event: StasisStart, channel: Channel): void
    - Parameters
      - event: StasisStart
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1134
A text message was received from an endpoint.

Parameters
- event: "TextMessageReceived"
- callback: (event: TextMessageReceived, endpoint: Endpoint) => void
  - - (event: TextMessageReceived, endpoint: Endpoint): void
    - Parameters
      - event: TextMessageReceived
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.on
- Defined in index.d.ts:1139
Channel changed Connected Line.

Parameters
- event: "ChannelConnectedLine"
- callback: (event: ChannelConnectedLine, channel: Channel) => void
  - - (event: ChannelConnectedLine, channel: Channel): void
    - Parameters
      - event: ChannelConnectedLine
      - channel: Channel
      Returns void
Returns void

once

once(event: "Message", callback: (event: Message, instances: Message) => void): void
once(event: "MissingParams", callback: (event: MissingParams, instances: MissingParams) => void): void
once(event: "Event", callback: (event: Event, instances: Event) => void): void
once(event: "ContactInfo", callback: (event: ContactInfo, instances: ContactInfo) => void): void
once(event: "Peer", callback: (event: Peer, instances: Peer) => void): void
once(event: "DeviceStateChanged", callback: (event: DeviceStateChanged, devicestate: DeviceState) => void): void
once(event: "PlaybackStarted", callback: (event: PlaybackStarted, playback: Playback) => void): void
once(event: "PlaybackContinuing", callback: (event: PlaybackContinuing, playback: Playback) => void): void
once(event: "PlaybackFinished", callback: (event: PlaybackFinished, playback: Playback) => void): void
once(event: "RecordingStarted", callback: (event: RecordingStarted, liverecording: LiveRecording) => void): void
once(event: "RecordingFinished", callback: (event: RecordingFinished, liverecording: LiveRecording) => void): void
once(event: "RecordingFailed", callback: (event: RecordingFailed, liverecording: LiveRecording) => void): void
once(event: "ApplicationMoveFailed", callback: (event: ApplicationMoveFailed, channel: Channel) => void): void
once(event: "ApplicationReplaced", callback: (event: Event) => void): void
once(event: "BridgeCreated", callback: (event: BridgeCreated, bridge: Bridge) => void): void
once(event: "BridgeDestroyed", callback: (event: BridgeDestroyed, bridge: Bridge) => void): void
once(event: "BridgeMerged", callback: (event: BridgeMerged, bridge: Bridge) => void): void
once(event: "BridgeVideoSourceChanged", callback: (event: BridgeVideoSourceChanged, bridge: Bridge) => void): void
once(event: "BridgeBlindTransfer", callback: (event: BridgeBlindTransfer, instances: BridgeBlindTransfer) => void): void
once(event: "BridgeAttendedTransfer", callback: (event: BridgeAttendedTransfer, instances: BridgeAttendedTransfer) => void): void
once(event: "ChannelCreated", callback: (event: ChannelCreated, channel: Channel) => void): void
once(event: "ChannelDestroyed", callback: (event: ChannelDestroyed, channel: Channel) => void): void
once(event: "ChannelEnteredBridge", callback: (event: ChannelEnteredBridge, instances: ChannelEnteredBridge) => void): void
once(event: "ChannelLeftBridge", callback: (event: ChannelLeftBridge, instances: ChannelLeftBridge) => void): void
once(event: "ChannelStateChange", callback: (event: ChannelStateChange, channel: Channel) => void): void
once(event: "ChannelDtmfReceived", callback: (event: ChannelDtmfReceived, channel: Channel) => void): void
once(event: "ChannelDialplan", callback: (event: ChannelDialplan, channel: Channel) => void): void
once(event: "ChannelCallerId", callback: (event: ChannelCallerId, channel: Channel) => void): void
once(event: "ChannelUserevent", callback: (event: ChannelUserevent, instances: ChannelUserevent) => void): void
once(event: "ChannelHangupRequest", callback: (event: ChannelHangupRequest, channel: Channel) => void): void
once(event: "ChannelVarset", callback: (event: ChannelVarset, channel: Channel) => void): void
once(event: "ChannelHold", callback: (event: ChannelHold, channel: Channel) => void): void
once(event: "ChannelUnhold", callback: (event: ChannelUnhold, channel: Channel) => void): void
once(event: "ChannelTalkingStarted", callback: (event: ChannelTalkingStarted, channel: Channel) => void): void
once(event: "ChannelTalkingFinished", callback: (event: ChannelTalkingFinished, channel: Channel) => void): void
once(event: "ContactStatusChange", callback: (event: ContactStatusChange, endpoint: Endpoint) => void): void
once(event: "PeerStatusChange", callback: (event: PeerStatusChange, endpoint: Endpoint) => void): void
once(event: "EndpointStateChange", callback: (event: EndpointStateChange, endpoint: Endpoint) => void): void
once(event: "Dial", callback: (event: Dial, channel: Channel) => void): void
once(event: "StasisEnd", callback: (event: StasisEnd, channel: Channel) => void): void
once(event: "StasisStart", callback: (event: StasisStart, channel: Channel) => void): void
once(event: "TextMessageReceived", callback: (event: TextMessageReceived, endpoint: Endpoint) => void): void
once(event: "ChannelConnectedLine", callback: (event: ChannelConnectedLine, channel: Channel) => void): void

Inherited from Resource.once
- Defined in index.d.ts:1144
Base type for errors and events.

Parameters
- event: "Message"
- callback: (event: Message, instances: Message) => void
  - - (event: Message, instances: Message): void
    - Parameters
      - event: Message
      - instances: Message
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1149
Error event sent when required params are missing.

Parameters
- event: "MissingParams"
- callback: (event: MissingParams, instances: MissingParams) => void
  - - (event: MissingParams, instances: MissingParams): void
    - Parameters
      - event: MissingParams
      - instances: MissingParams
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1154
Base type for asynchronous events from Asterisk.

Parameters
- event: "Event"
- callback: (event: Event, instances: Event) => void
  - - (event: Event, instances: Event): void
    - Parameters
      - event: Event
      - instances: Event
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1159
Detailed information about a contact on an endpoint.

Parameters
- event: "ContactInfo"
- callback: (event: ContactInfo, instances: ContactInfo) => void
  - - (event: ContactInfo, instances: ContactInfo): void
    - Parameters
      - event: ContactInfo
      - instances: ContactInfo
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1164
Detailed information about a remote peer that communicates with Asterisk.

Parameters
- event: "Peer"
- callback: (event: Peer, instances: Peer) => void
  - - (event: Peer, instances: Peer): void
    - Parameters
      - event: Peer
      - instances: Peer
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1169
Notification that a device state has changed.

Parameters
- event: "DeviceStateChanged"
- callback: (event: DeviceStateChanged, devicestate: DeviceState) => void
  - - (event: DeviceStateChanged, devicestate: DeviceState): void
    - Parameters
      - event: DeviceStateChanged
      - devicestate: DeviceState
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1177
Event showing the start of a media playback operation.

Parameters
- event: "PlaybackStarted"
- callback: (event: PlaybackStarted, playback: Playback) => void
  - - (event: PlaybackStarted, playback: Playback): void
    - Parameters
      - event: PlaybackStarted
      - playback: Playback
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1182
Event showing the continuation of a media playback operation from one media URI to the next in the list.

Parameters
- event: "PlaybackContinuing"
- callback: (event: PlaybackContinuing, playback: Playback) => void
  - - (event: PlaybackContinuing, playback: Playback): void
    - Parameters
      - event: PlaybackContinuing
      - playback: Playback
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1187
Event showing the completion of a media playback operation.

Parameters
- event: "PlaybackFinished"
- callback: (event: PlaybackFinished, playback: Playback) => void
  - - (event: PlaybackFinished, playback: Playback): void
    - Parameters
      - event: PlaybackFinished
      - playback: Playback
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1192
Event showing the start of a recording operation.

Parameters
- event: "RecordingStarted"
- callback: (event: RecordingStarted, liverecording: LiveRecording) => void
  - - (event: RecordingStarted, liverecording: LiveRecording): void
    - Parameters
      - event: RecordingStarted
      - liverecording: LiveRecording
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1200
Event showing the completion of a recording operation.

Parameters
- event: "RecordingFinished"
- callback: (event: RecordingFinished, liverecording: LiveRecording) => void
  - - (event: RecordingFinished, liverecording: LiveRecording): void
    - Parameters
      - event: RecordingFinished
      - liverecording: LiveRecording
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1208
Event showing failure of a recording operation.

Parameters
- event: "RecordingFailed"
- callback: (event: RecordingFailed, liverecording: LiveRecording) => void
  - - (event: RecordingFailed, liverecording: LiveRecording): void
    - Parameters
      - event: RecordingFailed
      - liverecording: LiveRecording
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1216
Notification that trying to move a channel to another Stasis application failed.

Parameters
- event: "ApplicationMoveFailed"
- callback: (event: ApplicationMoveFailed, channel: Channel) => void
  - - (event: ApplicationMoveFailed, channel: Channel): void
    - Parameters
      - event: ApplicationMoveFailed
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1225
Notification that another WebSocket has taken over for an application. An application may only be subscribed to by a single WebSocket at a time. If multiple WebSockets attempt to subscribe to the same application, the newer WebSocket wins, and the older one receives this event.

Parameters
- event: "ApplicationReplaced"
- callback: (event: Event) => void
  - - (event: Event): void
    - Parameters
      - event: Event
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1230
Notification that a bridge has been created.

Parameters
- event: "BridgeCreated"
- callback: (event: BridgeCreated, bridge: Bridge) => void
  - - (event: BridgeCreated, bridge: Bridge): void
    - Parameters
      - event: BridgeCreated
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1235
Notification that a bridge has been destroyed.

Parameters
- event: "BridgeDestroyed"
- callback: (event: BridgeDestroyed, bridge: Bridge) => void
  - - (event: BridgeDestroyed, bridge: Bridge): void
    - Parameters
      - event: BridgeDestroyed
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1240
Notification that one bridge has merged into another.

Parameters
- event: "BridgeMerged"
- callback: (event: BridgeMerged, bridge: Bridge) => void
  - - (event: BridgeMerged, bridge: Bridge): void
    - Parameters
      - event: BridgeMerged
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1245
Notification that the source of video in a bridge has changed.

Parameters
- event: "BridgeVideoSourceChanged"
- callback: (event: BridgeVideoSourceChanged, bridge: Bridge) => void
  - - (event: BridgeVideoSourceChanged, bridge: Bridge): void
    - Parameters
      - event: BridgeVideoSourceChanged
      - bridge: Bridge
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1253
Notification that a blind transfer has occurred.

Parameters
- event: "BridgeBlindTransfer"
- callback: (event: BridgeBlindTransfer, instances: BridgeBlindTransfer) => void
  - - (event: BridgeBlindTransfer, instances: BridgeBlindTransfer): void
    - Parameters
      - event: BridgeBlindTransfer
      - instances: BridgeBlindTransfer
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1261
Notification that an attended transfer has occurred.

Parameters
- event: "BridgeAttendedTransfer"
- callback: (event: BridgeAttendedTransfer, instances: BridgeAttendedTransfer) => void
  - - (event: BridgeAttendedTransfer, instances: BridgeAttendedTransfer): void
    - Parameters
      - event: BridgeAttendedTransfer
      - instances: BridgeAttendedTransfer
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1269
Notification that a channel has been created.

Parameters
- event: "ChannelCreated"
- callback: (event: ChannelCreated, channel: Channel) => void
  - - (event: ChannelCreated, channel: Channel): void
    - Parameters
      - event: ChannelCreated
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1274
Notification that a channel has been destroyed.

Parameters
- event: "ChannelDestroyed"
- callback: (event: ChannelDestroyed, channel: Channel) => void
  - - (event: ChannelDestroyed, channel: Channel): void
    - Parameters
      - event: ChannelDestroyed
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1279
Notification that a channel has entered a bridge.

Parameters
- event: "ChannelEnteredBridge"
- callback: (event: ChannelEnteredBridge, instances: ChannelEnteredBridge) => void
  - - (event: ChannelEnteredBridge, instances: ChannelEnteredBridge): void
    - Parameters
      - event: ChannelEnteredBridge
      - instances: ChannelEnteredBridge
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1287
Notification that a channel has left a bridge.

Parameters
- event: "ChannelLeftBridge"
- callback: (event: ChannelLeftBridge, instances: ChannelLeftBridge) => void
  - - (event: ChannelLeftBridge, instances: ChannelLeftBridge): void
    - Parameters
      - event: ChannelLeftBridge
      - instances: ChannelLeftBridge
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1295
Notification of a channels state change.

Parameters
- event: "ChannelStateChange"
- callback: (event: ChannelStateChange, channel: Channel) => void
  - - (event: ChannelStateChange, channel: Channel): void
    - Parameters
      - event: ChannelStateChange
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1300
DTMF received on a channel. This event is sent when the DTMF ends. There is no notification about the start of DTMF.

Parameters
- event: "ChannelDtmfReceived"
- callback: (event: ChannelDtmfReceived, channel: Channel) => void
  - - (event: ChannelDtmfReceived, channel: Channel): void
    - Parameters
      - event: ChannelDtmfReceived
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1305
Channel changed location in the dialplan.

Parameters
- event: "ChannelDialplan"
- callback: (event: ChannelDialplan, channel: Channel) => void
  - - (event: ChannelDialplan, channel: Channel): void
    - Parameters
      - event: ChannelDialplan
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1310
Channel changed Caller ID.

Parameters
- event: "ChannelCallerId"
- callback: (event: ChannelCallerId, channel: Channel) => void
  - - (event: ChannelCallerId, channel: Channel): void
    - Parameters
      - event: ChannelCallerId
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1315
User-generated event with additional user-defined fields in the object.

Parameters
- event: "ChannelUserevent"
- callback: (event: ChannelUserevent, instances: ChannelUserevent) => void
  - - (event: ChannelUserevent, instances: ChannelUserevent): void
    - Parameters
      - event: ChannelUserevent
      - instances: ChannelUserevent
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1323
A hangup was requested on the channel.

Parameters
- event: "ChannelHangupRequest"
- callback: (event: ChannelHangupRequest, channel: Channel) => void
  - - (event: ChannelHangupRequest, channel: Channel): void
    - Parameters
      - event: ChannelHangupRequest
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1328
Channel variable changed.

Parameters
- event: "ChannelVarset"
- callback: (event: ChannelVarset, channel: Channel) => void
  - - (event: ChannelVarset, channel: Channel): void
    - Parameters
      - event: ChannelVarset
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1333
A channel initiated a media hold.

Parameters
- event: "ChannelHold"
- callback: (event: ChannelHold, channel: Channel) => void
  - - (event: ChannelHold, channel: Channel): void
    - Parameters
      - event: ChannelHold
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1338
A channel initiated a media unhold.

Parameters
- event: "ChannelUnhold"
- callback: (event: ChannelUnhold, channel: Channel) => void
  - - (event: ChannelUnhold, channel: Channel): void
    - Parameters
      - event: ChannelUnhold
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1343
Talking was detected on the channel.

Parameters
- event: "ChannelTalkingStarted"
- callback: (event: ChannelTalkingStarted, channel: Channel) => void
  - - (event: ChannelTalkingStarted, channel: Channel): void
    - Parameters
      - event: ChannelTalkingStarted
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1351
Talking is no longer detected on the channel.

Parameters
- event: "ChannelTalkingFinished"
- callback: (event: ChannelTalkingFinished, channel: Channel) => void
  - - (event: ChannelTalkingFinished, channel: Channel): void
    - Parameters
      - event: ChannelTalkingFinished
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1359
The state of a contact on an endpoint has changed.

Parameters
- event: "ContactStatusChange"
- callback: (event: ContactStatusChange, endpoint: Endpoint) => void
  - - (event: ContactStatusChange, endpoint: Endpoint): void
    - Parameters
      - event: ContactStatusChange
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1364
The state of a peer associated with an endpoint has changed.

Parameters
- event: "PeerStatusChange"
- callback: (event: PeerStatusChange, endpoint: Endpoint) => void
  - - (event: PeerStatusChange, endpoint: Endpoint): void
    - Parameters
      - event: PeerStatusChange
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1369
Endpoint state changed.

Parameters
- event: "EndpointStateChange"
- callback: (event: EndpointStateChange, endpoint: Endpoint) => void
  - - (event: EndpointStateChange, endpoint: Endpoint): void
    - Parameters
      - event: EndpointStateChange
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1374
Dialing state has changed.

Parameters
- event: "Dial"
- callback: (event: Dial, channel: Channel) => void
  - - (event: Dial, channel: Channel): void
    - Parameters
      - event: Dial
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1379
Notification that a channel has left a Stasis application.

Parameters
- event: "StasisEnd"
- callback: (event: StasisEnd, channel: Channel) => void
  - - (event: StasisEnd, channel: Channel): void
    - Parameters
      - event: StasisEnd
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1384
Notification that a channel has entered a Stasis application.

Parameters
- event: "StasisStart"
- callback: (event: StasisStart, channel: Channel) => void
  - - (event: StasisStart, channel: Channel): void
    - Parameters
      - event: StasisStart
      - channel: Channel
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1389
A text message was received from an endpoint.

Parameters
- event: "TextMessageReceived"
- callback: (event: TextMessageReceived, endpoint: Endpoint) => void
  - - (event: TextMessageReceived, endpoint: Endpoint): void
    - Parameters
      - event: TextMessageReceived
      - endpoint: Endpoint
      Returns void
Returns void
Inherited from Resource.once
- Defined in index.d.ts:1394
Channel changed Connected Line.

Parameters
- event: "ChannelConnectedLine"
- callback: (event: ChannelConnectedLine, channel: Channel) => void
  - - (event: ChannelConnectedLine, channel: Channel): void
    - Parameters
      - event: ChannelConnectedLine
      - channel: Channel
      Returns void
Returns void

play

play(params: { lang?: string; media: string | string[]; offsetms?: number; playbackId?: string; skipms?: number }, callback: (err: Error, playback: Playback) => void): void
play(params: { lang?: string; media: string | string[]; offsetms?: number; playbackId?: string; skipms?: number }): Promise<Playback>

- Defined in index.d.ts:2970
Start playback of media on a bridge. The media URI may be any of a number of URIs. Currently sound:, recording:, number:, digits:, characters:, and tone: URIs are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.).

Parameters
- params: { lang?: string; media: string | string[]; offsetms?: number; playbackId?: string; skipms?: number }
  - Optional lang?: string
  - media: string | string[]
    
    Media URIs to play.
  - Optional offsetms?: number
  - Optional playbackId?: string
  - Optional skipms?: number
- callback: (err: Error, playback: Playback) => void
  - - (err: Error, playback: Playback): void
    - Parameters
      - err: Error
      - playback: Playback
      Returns void
Returns void
- Defined in index.d.ts:2986
Start playback of media on a bridge. The media URI may be any of a number of URIs. Currently sound:, recording:, number:, digits:, characters:, and tone: URIs are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.).

Parameters
- params: { lang?: string; media: string | string[]; offsetms?: number; playbackId?: string; skipms?: number }
  - Optional lang?: string
  - media: string | string[]
    
    Media URIs to play.
  - Optional offsetms?: number
  - Optional playbackId?: string
  - Optional skipms?: number
Returns Promise<Playback>

playWithId

playWithId(params: { lang?: string; media: string | string[]; offsetms?: number; playbackId: string; skipms?: number }, callback: (err: Error, playback: Playback) => void): void
playWithId(params: { lang?: string; media: string | string[]; offsetms?: number; playbackId: string; skipms?: number }): Promise<Playback>

- Defined in index.d.ts:3005
Start playback of media on a bridge. The media URI may be any of a number of URIs. Currently sound:, recording:, number:, digits:, characters:, and tone: URIs are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.).

Parameters
- params: { lang?: string; media: string | string[]; offsetms?: number; playbackId: string; skipms?: number }
  - Optional lang?: string
  - media: string | string[]
    
    Media URIs to play.
  - Optional offsetms?: number
  - playbackId: string
    
    Playback ID.
  - Optional skipms?: number
- callback: (err: Error, playback: Playback) => void
  - - (err: Error, playback: Playback): void
    - Parameters
      - err: Error
      - playback: Playback
      Returns void
Returns void
- Defined in index.d.ts:3021
Start playback of media on a bridge. The media URI may be any of a number of URIs. Currently sound:, recording:, number:, digits:, characters:, and tone: URIs are supported. This operation creates a playback resource that can be used to control the playback of media (pause, rewind, fast forward, etc.).

Parameters
- params: { lang?: string; media: string | string[]; offsetms?: number; playbackId: string; skipms?: number }
  - Optional lang?: string
  - media: string | string[]
    
    Media URIs to play.
  - Optional offsetms?: number
  - playbackId: string
    
    Playback ID.
  - Optional skipms?: number
Returns Promise<Playback>

record

record(params: { beep?: boolean; format: string; ifExists?: string; maxDurationSeconds?: number; maxSilenceSeconds?: number; name: string; terminateOn?: string }, recording: LiveRecording, callback: (err: Error, liverecording: LiveRecording) => void): void
record(params: { beep?: boolean; format: string; ifExists?: string; maxDurationSeconds?: number; maxSilenceSeconds?: number; name: string; terminateOn?: string }, recording: LiveRecording): Promise<LiveRecording>

- Defined in index.d.ts:3041
Start a recording. This records the mixed audio from all channels participating in this bridge.

Parameters
- params: { beep?: boolean; format: string; ifExists?: string; maxDurationSeconds?: number; maxSilenceSeconds?: number; name: string; terminateOn?: string }
  - Optional beep?: boolean
  - format: string
    
    Format to encode audio in.
  - Optional ifExists?: string
  - Optional maxDurationSeconds?: number
  - Optional maxSilenceSeconds?: number
  - name: string
    
    Recordings filename.
  - Optional terminateOn?: string
- recording: LiveRecording
- callback: (err: Error, liverecording: LiveRecording) => void
  - - (err: Error, liverecording: LiveRecording): void
    - Parameters
      - err: Error
      - liverecording: LiveRecording
      Returns void
Returns void
- Defined in index.d.ts:3067
Start a recording. This records the mixed audio from all channels participating in this bridge.

Parameters
- params: { beep?: boolean; format: string; ifExists?: string; maxDurationSeconds?: number; maxSilenceSeconds?: number; name: string; terminateOn?: string }
  - Optional beep?: boolean
  - format: string
    
    Format to encode audio in.
  - Optional ifExists?: string
  - Optional maxDurationSeconds?: number
  - Optional maxSilenceSeconds?: number
  - name: string
    
    Recordings filename.
  - Optional terminateOn?: string
- recording: LiveRecording
Returns Promise<LiveRecording>

removeAllListeners

removeAllListeners(event?: AnyEventType): void

Inherited from Resource.removeAllListeners
- Defined in index.d.ts:1695
Removes all listeners, or those of the specified event type.

Parameters
- Optional event: AnyEventType
Returns void

removeChannel

removeChannel(params: { channel: string | string[] }, callback: (err: Error) => void): void
removeChannel(params: { channel: string | string[] }): Promise<void>

- Defined in index.d.ts:2893
Remove a channel from a bridge.

Parameters
- params: { channel: string | string[] }
  - channel: string | string[]
    
    Ids of channels to remove from bridge.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:2900
Remove a channel from a bridge.

Parameters
- params: { channel: string | string[] }
  - channel: string | string[]
    
    Ids of channels to remove from bridge.
Returns Promise<void>

removeListener

removeListener(event: AnyEventType, handler: (...args: any[]) => void): void

Inherited from Resource.removeListener
- Defined in index.d.ts:1689
Removes the event listener for the specified event type.

Parameters
- event: AnyEventType
  
  The event type.
- handler: (...args: any[]) => void
  
  The event listener function.
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns void

setVideoSource

setVideoSource(params: { channelId: string }, callback: (err: Error) => void): void
setVideoSource(params: { channelId: string }): Promise<void>

- Defined in index.d.ts:2907
Set a channel as the video source in a multi-party mixing bridge. This operation has no effect on bridges with two or fewer participants.

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:2914
Set a channel as the video source in a multi-party mixing bridge. This operation has no effect on bridges with two or fewer participants.

Parameters
- params: { channelId: string }
  - channelId: string
    
    Channels id.
Returns Promise<void>

startMoh

startMoh(params: { mohClass?: string }, callback: (err: Error) => void): void
startMoh(callback: (err: Error) => void): void
startMoh(params?: { mohClass?: string }): Promise<void>

- Defined in index.d.ts:2933
Play music on hold to a bridge or change the MOH class that is playing.

Parameters
- params: { mohClass?: string }
  - Optional mohClass?: string
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:2938
Play music on hold to a bridge or change the MOH class that is playing.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:2945
Play music on hold to a bridge or change the MOH class that is playing.

Parameters
- Optional params: { mohClass?: string }
  - Optional mohClass?: string
Returns Promise<void>

stopMoh

stopMoh(callback: (err: Error) => void): void
stopMoh(): Promise<void>

- Defined in index.d.ts:2951
Stop playing music on hold to a bridge. This will only stop music on hold being played via POST bridges/{bridgeId}/moh.

Parameters
- callback: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in index.d.ts:2957
Stop playing music on hold to a bridge. This will only stop music on hold being played via POST bridges/{bridgeId}/moh.

Returns Promise<void>

Hierarchy

Index

Properties

Methods

Properties

bridge_class

bridge_type

channels

creationtime

creator

id

name

technology

Optional video_mode

Optional video_source_id

Methods

addChannel

Parameters

params: { absorbDTMF?: boolean; channel: string | string[]; mute?: boolean; role?: string }

Optional absorbDTMF?: boolean

channel: string | string[]

Optional mute?: boolean

Optional role?: string

callback: (err: Error) => void

Parameters

err: Error

Returns void

Returns void

Parameters

params: { absorbDTMF?: boolean; channel: string | string[]; mute?: boolean; role?: string }

Optional absorbDTMF?: boolean

channel: string | string[]

Optional mute?: boolean

Optional role?: string

Returns Promise<void>

addListener

Parameters

event: "Message"

callback: (event: Message, instances: Message) => void

Parameters

event: Message

instances: Message

Returns void

Returns void

Parameters

event: "MissingParams"

callback: (event: MissingParams, instances: MissingParams) => void

Parameters

event: MissingParams

instances: MissingParams

Returns void

Returns void

Parameters

event: "Event"

callback: (event: Event, instances: Event) => void

Parameters

event: Event

instances: Event

Returns void

Returns void

Parameters

event: "ContactInfo"

callback: (event: ContactInfo, instances: ContactInfo) => void

Parameters

event: ContactInfo

instances: ContactInfo

Returns void

Returns void

Parameters

event: "Peer"

callback: (event: Peer, instances: Peer) => void

Parameters

event: Peer

instances: Peer

Returns void

Returns void

Parameters

event: "DeviceStateChanged"

callback: (event: DeviceStateChanged, devicestate: DeviceState) => void

Parameters