(Application) Meetme

Meetme is Asterisk’s long-standing, now-being-phased-out conferencing subsystem. 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_meetme_events namespace, regardless of the modules in which they are defined.

Events

class ami.app_meetme_events.MeetmeJoin(response)

Bases: pystrix.ami.ami._Event

Indicates that a user has joined a Meetme bridge.

  • ‘Channel’ : The channel that was bridged
  • ‘Meetme’ : The ID of the Meetme bridge, typically a number formatted as a string
  • ‘Uniqueid’ : An Asterisk unique value
  • ‘Usernum’ : The bridge-specific participant ID assigned to the channel
class ami.app_meetme_events.MeetmeList(response)

Bases: pystrix.ami.ami._Event

Describes a participant in a Meetme 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
  • ‘ConnectedLineNum’ : unknown
  • ‘ConnectedLineName’ : unknown
  • ‘MarkedUser’ : ‘Yes’ or ‘No’
  • ‘Muted’ : “By admin”, “By self”, “No”
  • ‘Role’ : “Listen only”, “Talk only”, “Talk and listen”
  • ‘Talking’ : ‘Yes’, ‘No’, or ‘Not monitored’
  • ‘UserNumber’ : The ID of the participant in the conference
process()

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

Translates the ‘Talking’ header’s value into a bool, or None if not monitored.

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

class ami.app_meetme_events.MeetmeListRooms(response)

Bases: pystrix.ami.ami._Event

Describes a Meetme room.

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

  • ‘Activity’ : The duration of the conference
  • ‘Conference’ : The room’s identifier
  • ‘Creation’ : ‘Dynamic’ or ‘Static’
  • ‘Locked’ : ‘Yes’ or ‘No’
  • ‘Marked’ : The number of marked users, but not as an integer: ‘N/A’ or %.4d
  • ‘Parties’ : The number of participants
process()

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

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

class ami.app_meetme_events.MeetmeMute(response)

Bases: pystrix.ami.ami._Event

Indicates that a user has been muted in a Meetme bridge.

  • ‘Channel’ : The channel that was muted
  • ‘Meetme’ : The ID of the Meetme bridge, typically a number formatted as a string
  • ‘Status’ : ‘on’ or ‘off’, depending on whether the user was muted or unmuted
  • ‘Uniqueid’ : An Asterisk unique value
  • ‘Usernum’ : The participant ID of the user that was affected
process()

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

Aggregate Events

class ami.app_meetme_events.MeetmeList_Aggregate(action_id)

Bases: pystrix.ami.ami._Aggregate

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

Its members consist of MeetmeList events.

It is finalised by MeetmeListComplete.

class ami.app_meetme_events.MeetmeListRooms_Aggregate(action_id)

Bases: pystrix.ami.ami._Aggregate

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

Its members consist of MeetmeListRooms events.

It is finalised by MeetmeListRoomsComplete.