Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Bridges

Hierarchy

  • Bridges

Index

Methods

Methods

addChannel

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

  • Add a channel to a bridge.

    Parameters

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

        Bridges id.

      • 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

  • Add a channel to a bridge.

    Parameters

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

        Bridges id.

      • channel: string | string[]

        Ids of channels to add to bridge.

      • Optional mute?: boolean
      • Optional role?: string

    Returns Promise<void>

clearVideoSource

  • clearVideoSource(params: { bridgeId: string }, callback: (err: Error) => void): void
  • clearVideoSource(params: { bridgeId: string }): Promise<void>

  • 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

    • params: { bridgeId: string }
      • bridgeId: string

        Bridges id.

    • callback: (err: Error) => void
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns void

  • 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

    • params: { bridgeId: string }
      • bridgeId: string

        Bridges id.

    Returns Promise<void>

create

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

  • Create a new bridge. This bridge persists until it has been shut down, or Asterisk has been shut down.

    Parameters

    • params: { bridgeId?: string; name?: string; type?: string }
      • Optional bridgeId?: string
      • Optional name?: string
      • Optional type?: string
    • callback: (err: Error, bridge: Bridge) => void
        • (err: Error, bridge: Bridge): void

        • Parameters

          Returns void

    Returns void

  • 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

          Returns void

    Returns void

  • Create a new bridge. This bridge persists until it has been shut down, or Asterisk has been shut down.

    Parameters

    • Optional params: { bridgeId?: string; name?: string; type?: string }
      • Optional bridgeId?: string
      • Optional name?: string
      • Optional type?: string

    Returns Promise<Bridge>

createWithId

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

  • 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: { bridgeId: string; name?: string; type?: string }
      • bridgeId: string

        Unique ID to give to the bridge being created.

      • Optional name?: string
      • Optional type?: string
    • callback: (err: Error, bridge: Bridge) => void
        • (err: Error, bridge: Bridge): void

        • Parameters

          Returns void

    Returns void

  • 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: { bridgeId: string; name?: string; type?: string }
      • bridgeId: string

        Unique ID to give to the bridge being created.

      • Optional name?: string
      • Optional type?: string

    Returns Promise<Bridge>

destroy

  • destroy(params: { bridgeId: string }, callback: (err: Error) => void): void
  • destroy(params: { bridgeId: string }): Promise<void>

  • Shut down a bridge. If any channels are in this bridge, they will be removed and resume whatever they were doing beforehand.

    Parameters

    • params: { bridgeId: string }
      • bridgeId: string

        Bridges id.

    • callback: (err: Error) => void
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns void

  • Shut down a bridge. If any channels are in this bridge, they will be removed and resume whatever they were doing beforehand.

    Parameters

    • params: { bridgeId: string }
      • bridgeId: string

        Bridges id.

    Returns Promise<void>

get

  • get(params: { bridgeId: string }, callback: (err: Error, bridge: Bridge) => void): void
  • get(params: { bridgeId: string }): Promise<Bridge>

  • Get bridge details.

    Parameters

    • params: { bridgeId: string }
      • bridgeId: string

        Bridges id.

    • callback: (err: Error, bridge: Bridge) => void
        • (err: Error, bridge: Bridge): void

        • Parameters

          Returns void

    Returns void

  • Get bridge details.

    Parameters

    • params: { bridgeId: string }
      • bridgeId: string

        Bridges id.

    Returns Promise<Bridge>

list

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

  • 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

  • List all active bridges in Asterisk.

    Returns Promise<Bridge[]>

play

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

  • 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: { bridgeId: string; lang?: string; media: string | string[]; offsetms?: number; playbackId?: string; skipms?: number }
      • bridgeId: string

        Bridges id.

      • 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

          Returns void

    Returns void

  • 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: { bridgeId: string; lang?: string; media: string | string[]; offsetms?: number; playbackId?: string; skipms?: number }
      • bridgeId: string

        Bridges id.

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

  • 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: { bridgeId: string; lang?: string; media: string | string[]; offsetms?: number; playbackId: string; skipms?: number }
      • bridgeId: string

        Bridges id.

      • 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

          Returns void

    Returns void

  • 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: { bridgeId: string; lang?: string; media: string | string[]; offsetms?: number; playbackId: string; skipms?: number }
      • bridgeId: string

        Bridges id.

      • 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; bridgeId: string; format: string; ifExists?: string; maxDurationSeconds?: number; maxSilenceSeconds?: number; name: string; terminateOn?: string }, callback: (err: Error, liverecording: LiveRecording) => void): void
  • record(params: { beep?: boolean; bridgeId: string; format: string; ifExists?: string; maxDurationSeconds?: number; maxSilenceSeconds?: number; name: string; terminateOn?: string }): Promise<LiveRecording>

  • Start a recording. This records the mixed audio from all channels participating in this bridge.

    Parameters

    • params: { beep?: boolean; bridgeId: string; format: string; ifExists?: string; maxDurationSeconds?: number; maxSilenceSeconds?: number; name: string; terminateOn?: string }
      • Optional beep?: boolean
      • bridgeId: string

        Bridges id.

      • format: string

        Format to encode audio in.

      • Optional ifExists?: string
      • Optional maxDurationSeconds?: number
      • Optional maxSilenceSeconds?: number
      • name: string

        Recordings filename.

      • Optional terminateOn?: string
    • callback: (err: Error, liverecording: LiveRecording) => void

    Returns void

  • Start a recording. This records the mixed audio from all channels participating in this bridge.

    Parameters

    • params: { beep?: boolean; bridgeId: string; format: string; ifExists?: string; maxDurationSeconds?: number; maxSilenceSeconds?: number; name: string; terminateOn?: string }
      • Optional beep?: boolean
      • bridgeId: string

        Bridges id.

      • format: string

        Format to encode audio in.

      • Optional ifExists?: string
      • Optional maxDurationSeconds?: number
      • Optional maxSilenceSeconds?: number
      • name: string

        Recordings filename.

      • Optional terminateOn?: string

    Returns Promise<LiveRecording>

removeChannel

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

  • Remove a channel from a bridge.

    Parameters

    • params: { bridgeId: string; channel: string | string[] }
      • bridgeId: string

        Bridges id.

      • channel: string | string[]

        Ids of channels to remove from bridge.

    • callback: (err: Error) => void
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns void

  • Remove a channel from a bridge.

    Parameters

    • params: { bridgeId: string; channel: string | string[] }
      • bridgeId: string

        Bridges id.

      • channel: string | string[]

        Ids of channels to remove from bridge.

    Returns Promise<void>

setVideoSource

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

  • 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: { bridgeId: string; channelId: string }
      • bridgeId: string

        Bridges id.

      • channelId: string

        Channels id.

    • callback: (err: Error) => void
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns void

  • 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: { bridgeId: string; channelId: string }
      • bridgeId: string

        Bridges id.

      • channelId: string

        Channels id.

    Returns Promise<void>

startMoh

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

  • Play music on hold to a bridge or change the MOH class that is playing.

    Parameters

    • params: { bridgeId: string; mohClass?: string }
      • bridgeId: string

        Bridges id.

      • Optional mohClass?: string
    • callback: (err: Error) => void
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns void

  • Play music on hold to a bridge or change the MOH class that is playing.

    Parameters

    • params: { bridgeId: string; mohClass?: string }
      • bridgeId: string

        Bridges id.

      • Optional mohClass?: string

    Returns Promise<void>

stopMoh

  • stopMoh(params: { bridgeId: string }, callback: (err: Error) => void): void
  • stopMoh(params: { bridgeId: string }): Promise<void>

  • Stop playing music on hold to a bridge. This will only stop music on hold being played via POST bridges/{bridgeId}/moh.

    Parameters

    • params: { bridgeId: string }
      • bridgeId: string

        Bridges id.

    • callback: (err: Error) => void
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns void

  • Stop playing music on hold to a bridge. This will only stop music on hold being played via POST bridges/{bridgeId}/moh.

    Parameters

    • params: { bridgeId: string }
      • bridgeId: string

        Bridges id.

    Returns Promise<void>

Generated using TypeDoc