SetMute

Description

Allows the user to mute or unmute the line.

Applies to

PhoneCall objects

Syntax

objectname.SetMute ( mutestate )

Argument

Description

objectname

The name of the PhoneCall object

mutestate

A boolean that indicates whether the line is to be muted or unmuted. Values are:

  • true Mute the line

  • false Unmute the line

Returns

Integer. Returns a value that indicates the state of the phone line before SetMute is called if it succeeds and a negative value if an error occurs. Values are:

Examples

Example 1

The following script for a Mute button mutes a line if it was muted and unmutes it if it was not muted:

// Global variable: Long g_phInit = 0
// set to 1 in pcall_1 constructor
// Global variable gb_mutestate
integer li_ret
if ( g_phInit > 0) then
   li_ret = pcall_1.SetMute( gb_mutestate)
   if (gb_mutestate = true) then
      gb_mutestate = false
   else
      gb_mutestate = true
   end if
else
   sle_1.text = "Call not initialized"
end if

See also