Conference Lifetime ControlΒΆ

class UASCallChannel
class ConferenceLifetimeControl(start_on_entry=True, destroy_on_exit=False)

Conference lifetime control. The options are to start the conference when the caller enters the conference room, and to destroy the conference room when the caller exits the room.

Optional arguments:
  • start_on_entry:

    whether the conference should start when this party enters the room. Default is True.

  • destroy_on_exit:

    whether the conference room should be destroyed when this party exits the room. Default is False.

The argument start_on_entry indicates whether the conference should start when this party enters the room. All other callers will hear a ring tone until the conference has started. So, if only one participant can cause the conference to start, all others will hear ringing (and not be able to talk to each other) until he enters the room.

Usage example:

conf_media_settings = channel.ConferencePartyMediaSettings(exit_on_dtmf_digit='#')
conf_media_settings.MuteOnDTMFDigits.set_digits(mute='0', unmute='1')
conf_media_settings.PrefixMedia.text_to_say('george')
conf_media_settings.OnEntryMedia.text_to_say('has joined')
conf_media_settings.OnExitMedia.text_to_say('has left')

conf_lifetime_settings = channel.ConferenceLifetimeControl(start_on_entry=True, destroy_on_exit=True)

if channel.transfer_to_conference_room(other_call, conference_room_name,
                                       conference_lifetime_control=conf_lifetime_settings,
                                       conference_party_media_settings=conf_media_settings) != channel.State.TRANSFERRED:
    print("could not transfer the call to the conference")