(Application) Confbridge

Confbridge is Asterisk’s new conferencing subsystem, providing far greater functionality than Meetme, with better performance and structural design. While technically a part of Asterisk’s core, it’s specialised enough that pystrix treats it as a module.

Members

All of the following objects should be accessed as part of the ami.app_confbirdge namespace, regardless of the modules in which they are defined.

Actions

class ami.app_confbridge.ConfbridgeKick(conference, channel)

Bases: _Request

Kicks a participant from a ConfBridge room.

__init__(conference, channel)

channel is the channel to be kicked from conference.

class ami.app_confbridge.ConfbridgeList(conference)

Bases: _Request

Lists all participants in a ConfBridge room.

A series of ‘ConfbridgeList’ events follow, with one ‘ConfbridgeListComplete’ event at the end.

__init__(conference)

conference is the identifier of the bridge.

class ami.app_confbridge.ConfbridgeListRooms

Bases: _Request

Lists all ConfBridge rooms.

A series of ‘ConfbridgeListRooms’ events follow, with one ‘ConfbridgeListRoomsComplete’ event at the end.

__init__()

action is the type of action being requested of the Asterisk server.

class ami.app_confbridge.ConfbridgeLock(conference)

Bases: _Request

Locks a ConfBridge room, disallowing access to non-administrators.

__init__(conference)

conference is the identifier of the bridge.

class ami.app_confbridge.ConfbridgeUnlock(conference)

Bases: _Request

Unlocks a ConfBridge room, allowing access to non-administrators.

__init__(conference)

conference is the identifier of the bridge.

class ami.app_confbridge.ConfbridgeMoHOn(conference, channel)

Bases: _Request

Forces MoH to a participant in a ConfBridge room.

This action does not mute audio coming from the participant.

Depends on <path>.

__init__(conference, channel)

channel is the channel to which MoH should be started in conference.

class ami.app_confbridge.ConfbridgeMoHOff(conference, channel)

Bases: _Request

Stops forcing MoH to a participant in a ConfBridge room.

This action does not unmute audio coming from the participant.

Depends on <path>.

__init__(conference, channel)

channel is the channel to which MoH should be stopped in conference.

class ami.app_confbridge.ConfbridgeMute(conference, channel)

Bases: _Request

Mutes a participant in a ConfBridge room.

__init__(conference, channel)

channel is the channel to be muted in conference.

class ami.app_confbridge.ConfbridgeUnmute(conference, channel)

Bases: _Request

Unmutes a participant in a ConfBridge room.

__init__(conference, channel)

channel is the channel to be unmuted in conference.

class ami.app_confbridge.ConfbridgePlayFile(file, conference, channel=None)

Bases: _Request

Plays a file to individuals or an entire conference.

Note: This implementation is built upon the not-yet-accepted patch under https://issues.asterisk.org/jira/browse/ASTERISK-19571

__init__(file, conference, channel=None)

file, resolved like other Asterisk media, is played to conference or, if specified, a specific channel therein.

class ami.app_confbridge.ConfbridgeStartRecord(conference, filename=None)

Bases: _Request

Starts recording a ConfBridge conference.

A ‘VarSet’ event will be generated to indicate the absolute path of the recording. To identify it, match its ‘Channel’ key against “ConfBridgeRecorder/conf-?-…”, where “…” is Asterisk-generated identification data that can be discarded and “?” is the room ID. The ‘Variable’ key must be “MIXMONITOR_FILENAME”, with the ‘Value’ key holding the file’s path.

__init__(conference, filename=None)

conference is the room to be recorded, and filename, optional, is the path, Asterisk-resolved or absolute, of the file to write.

class ami.app_confbridge.ConfbridgeStopRecord(conference)

Bases: _Request

Stops recording a ConfBridge conference.

A ‘Hangup’ event will be generated when the recorder detaches from the conference. To identify it, match its ‘Channel’ key against “ConfBridgeRecorder/conf-?-…”, where “…” is Asterisk-generated identification data that can be discarded and “?” is the room ID.

__init__(conference)

conference is the room being recorded.

class ami.app_confbridge.ConfbridgeSetSingleVideoSrc(conference, channel)

Bases: _Request

Sets the video source for the conference to a single channel’s stream.

__init__(conference, channel)

channel is the video source in conference.