Skip to end of metadata
Go to start of metadata

Broadcast()

Synopsis

Transmit or receive audio to or from multiple channels simultaneously

Description

This application can be used to broadcast audio to multiple channels at once. Any audio received on this channel will be transmitted to all of the specified channels and, optionally, their bridged peers.

It can also be used to aggregate audio from multiple channels at once. Any audio on any of the specified channels, and optionally their bridged peers, will be transmitted to this channel.

Execution of the application continues until either the broadcasting channel hangs up or all specified channels have hung up.

This application is used for one-to-many and many-to-one audio applications where bridge mixing cannot be done synchronously on all the involved channels. This is primarily useful for injecting the same audio stream into multiple channels at once, or doing the reverse, combining the audio from multiple channels into a single stream. This contrasts with using a separate injection channel for each target channel and/or using a conference bridge.

The channel running the Broadcast application must do so synchronously. The specified channels, however, may be doing other things.

Example: Broadcast received audio to three channels and their bridged peers
Example: Broadcast received audio to three channels, only
Example: Combine audio from three channels and their bridged peers to us
Example: Combine audio from three channels to us
Example: Two-way audio with a bunch of channels

Note that in the last example above, this is NOT the same as a conference bridge. The specified channels are not audible to each other, only to the channel running the Broadcast application. The two-way audio is only between the broadcasting channel and each of the specified channels, individually.

Syntax

Broadcast([options,]channels)
Arguments
  • options
    • b - In addition to broadcasting to target channels, also broadcast to any channels to which target channels are bridged.
    • l - Allow usage of a long queue to store audio frames.
    • o - Do not mix streams when combining audio from target channels (only applies with s option).
    • r - Feed frames to barge channels in "reverse" by injecting them into the primary channel's read queue instead.
      This option is required for barge to work in a n-party bridge (but not for 2-party bridges). Alternately, you can add an intermediate channel by using a non-optimized Local channel, so that the target channel is bridged with a single channel that is connected to the bridge, but it is recommended this option be used instead.
      Note that this option will always feed injected audio to the other party, regardless of whether the target channel is bridged or not.
    • s - Rather than broadcast audio to a bunch of channels, receive the combined audio from the target channels.
    • w - Broadcast audio received on this channel to other channels.
  • channels - List of channels for broadcast targets.
    Channel names must be the full channel names, not merely device names.
    Broadcasting will continue until the broadcasting channel hangs up or all target channels have hung up.

See Also

Import Version

This documentation was imported from Asterisk Version GIT-20-d33bd6d

  • No labels