(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_confbridge_events namespace, regardless of the modules in which they are defined.

Events

class ami.app_confbridge_events.ConfbridgeEnd(response)

Bases: ami.ami._Event

Indicates that a ConfBridge has ended.

• ‘Conference’ : The room’s identifier

class ami.app_confbridge_events.ConfbridgeJoin(response)

Bases: ami.ami._Event

Indicates that a participant has joined a ConfBridge room.

NameRecordingPath blocks on <path>

• ‘CallerIDname’ (optional) : The name, on supporting channels, of the participant
• ‘CallerIDnum’ : The (often) numeric address of the participant
• ‘Channel’ : The channel that joined
• ‘Conference’ : The identifier of the room that was joined
• ‘NameRecordingPath’ (optional) : The path at which the user’s name-recording is kept
• ‘Uniqueid’ : An Asterisk unique value

class ami.app_confbridge_events.ConfbridgeLeave(response)

Bases: ami.ami._Event

Indicates that a participant has left a ConfBridge room.

• ‘CallerIDname’ (optional) : The name, on supporting channels, of the participant
• ‘CallerIDnum’ : The (often) numeric address of the participant
• ‘Channel’ : The channel that left
• ‘Conference’ : The identifier of the room that was left
• ‘Uniqueid’ : An Asterisk unique value

class ami.app_confbridge_events.ConfbridgeList(response)

Bases: ami.ami._Event

Describes a participant in a ConfBridge room.

• ‘Admin’ : ‘Yes’ or ‘No’
• ‘CallerIDNum’ : The (often) numeric address of the participant
• ‘CallerIDName’ (optional) : The name of the participant on supporting channels
• ‘Channel’ : The Asterisk channel in use by the participant
• ‘Conference’ : The room’s identifier
• ‘MarkedUser’ : ‘Yes’ or ‘No’
• ‘NameRecordingPath’ (optional) : The path at which the user’s name-recording is kept

process()

Translates the ‘Admin’ and ‘MarkedUser’ headers’ values into bools.

class ami.app_confbridge_events.ConfbridgeListComplete(response)

Bases: ami.ami._Event

Indicates that all participants in a ConfBridge room have been enumerated.

• ‘ListItems’ : The number of items returned prior to this event

process()

Translates the ‘ListItems’ header’s value into an int, or -1 on failure.

class ami.app_confbridge_events.ConfbridgeListRooms(response)

Bases: ami.ami._Event

Describes a ConfBridge room.

And, yes, it’s plural in Asterisk, too.

• ‘Conference’ : The room’s identifier
• ‘Locked’ : ‘Yes’ or ‘No’
• ‘Marked’ : The number of marked users
• ‘Parties’ : The number of participants

process()

Translates the ‘Marked’ and ‘Parties’ headers’ values into ints, or -1 on failure.

Translates the ‘Locked’ header’s value into a bool.

class ami.app_confbridge_events.ConfbridgeListRoomsComplete(response)

Bases: ami.ami._Event

Indicates that all ConfBridge rooms have been enumerated.

• ‘ListItems’ : The number of items returned prior to this event

process()

Translates the ‘ListItems’ header’s value into an int, or -1 on failure.

class ami.app_confbridge_events.ConfbridgeStart(response)

Bases: ami.ami._Event

Indicates that a ConfBridge has started.

• ‘Conference’ : The room’s identifier

class ami.app_confbridge_events.ConfbridgeTalking(response)

Bases: ami.ami._Event

Indicates that a participant has started or stopped talking.

• ‘Channel’ : The Asterisk channel in use by the participant
• ‘Conference’ : The room’s identifier
• ‘TalkingStatus’ : ‘on’ or ‘off’
• ‘Uniqueid’ : An Asterisk unique value

process()

Translates the ‘TalkingStatus’ header’s value into a bool.

Aggregate Events

class ami.app_confbridge_events.ConfbridgeList_Aggregate(action_id)

Bases: ami.ami._Aggregate

Emitted after all conference participants have been received in response to a ConfbridgeList request.

Its members consist of ConfbridgeList events.

It is finalised by ConfbridgeListComplete.

class ami.app_confbridge_events.ConfbridgeListRooms_Aggregate(action_id)

Bases: ami.ami._Aggregate

Emitted after all conference rooms have been received in response to a ConfbridgeListRooms request.

Its members consist of ConfbridgeListRooms events.

It is finalised by ConfbridgeListRoomsComplete.