Provider
Synchronous
No Custom Parameters
Changes one or more properties of a connection in a conference. There are a number of properties unique to a connection in a conference, which can be set as the connection is joined into the conference or when the connection is already in the conference. SetConfereeAttribute is used in the case that the connection is already in a conference.
Any connection in the conference can be muted or unmuted at anytime. Use the Mute boolean to indicate whether to mute or unmute the connection in the conference.
Any connection in the conference can have a tone played at a regular interval, or not, by using the TariffTone boolean field.
Coach-Pupil relationships can be created among participants in the conference by using the Coach and Pupil boolean fields.
There can only be one coach and pupil per conference. A pupil can not be a coach.
A special consideration for the SetConfereeAttribute is when the action is invoked on a 2-party hairpin conference (a conference that uses no conference resources). The use of Coach or Pupil causes a 2-party hairpin conference to promote to a true conference and therefore use a conference resource per participant. The use of TariffTone while the conference is a 2-party hairpin results in no promotion of the conference and no tariff tone on the connection; however, if the conference is at any time promoted to a true conference, then the tariff tone property is respected as the connection moves to conference. The use of Mute takes effect immediately in a 2-party hairpin conference; there are no special considerations for Mute.
| Parameter Name | .NET Type | Default | Description |
|---|---|---|---|
| Coach | System.Boolean | Causes this connection to only be audible by the connection marked as a pupil. If a coach has already been designated for this conference, the coach designation moves to this connection. | |
| Pupil | System.Boolean | Indicates whether this connection can hear audio originating from the coach. | |
| ConnectionId * | System.String | The connection to change conference attributes on. | |
| ConferenceId * | System.String | The conference that contains the ConnectionId specified. | |
| Mute | System.Boolean | Indicates whether this connection should be muted. | |
| TariffTone | System.Boolean | Indicates whether this connection should hear a periodic tone while in a true, on non-hairpinned, conference. | |
| Timeout | System.Int32 | The Timeout property specifies to the Application Runtime Environment how long
to wait for a response from the provider for the current action.
The ReturnValue returned in this case is Timeout. The value must be a literal value in milliseconds. |
| Parameter Name | .NET Type | Description |
|---|---|---|
| ResultCode | System.String | A numeric code indicating the result status of the operation. A '0' indicates success; a positive number indicates an error. Please reference the Media Control Error Codes table for descriptions on specific error codes. |
Branch Conditions
No description.
No description.
No description.