Conference party media settings

class UASCallChannel

class UASCallChannel.ConferencePartyMediaSettings(ringback_tone=None, on_conference_stopped_file=None, beep_on_entry=True, exit_on_dtmf_digit=None, two_party_optimisation=False, start_muted=False)

Conference media control. This class defines several parameters that let you fine-tune the behaviour of your conference.

Optional arguments:

• ringback_tone:

  to play a tone to the party while waiting to enter the conference room. Default is RINGBACK.

• on_conference_stopped_file:

  on the party entering a conference room, play a file (in an endless loop) until the conference has started.

• beep_on_entry:

  option to play a beep to the conference when this party enters. Default is True.

• exit_on_dtmf_digit:

  option to leave the conference by hitting a DTMF digit. Default is None which disables this option.

• start_muted:

  option to join the conference room in muted state. Default is False.

• two_party_optimisation:

  If True, indicates that the conference room that this party is entering should be optimised for two talking parties. If the conference room will not have more than two talkers, then having optimisation turned on will enhance the quality of the audio. Other parties can enter as listeners without affecting the optimisation. This option should not be used if more than two talking parties will be entering the conference room as this can have adverse affects on the audio quality. Default is False.

The argument ringback_tone defines the audio played to the party while waiting to enter the conference room. Valid options for ringback_tone are listed in the ToneManager resource; or the argument can be left at its default value.

This class exposes the public properties OnEntryMedia, OnExitMedia and PrefixMedia which are classes of the type PlayableMedia. Use the functions provided by PlayableMedia to set some audio to play on entering and leaving the conference room. The audio can be either some text to say as TTS or the name of a file. The audio provided by PrefixMedia will be played before OnEntryMedia and after OnExitMedia.

This class exposes the public property MuteOnDTMFDigits to optionally set DTMF digits for muting and unmuting a party when the corresponding digit is pressed.

Usage example:

conf_media_settings = channel.ConferencePartyMediaSettings(exit_on_dtmf_digit='#', start_muted=True)
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")

class UASCallChannel.ConferencePartyMediaSettings.MuteControl

Conference mute control. Allows the user to set the DTMF digits that will mute or unmute the party.

UASCallChannel.ConferencePartyMediaSettings.MuteControl.set_digits(mute, unmute=None)

Two DTMF characters can be supplied. The set of individual DTMF digits permitted is: 1234567890*#. If unmute is not supplied, it will be the same digit as mute.