[This is preliminary documentation and is subject to change. Blank topics are included as placeholders.]

Modifies the DTMF (Dual Tone Multi-Frequency) signaling settings used for dial-in conferencing. DTMF enables users who dial in to a conference to control conference settings (such as muting and unmuting themselves or locking and unlocking the conference) by using the keypad on their telephone.

Syntax


Set-CsDialInConferencingDtmfConfiguration [-Identity <XdsIdentity>] [-AdmitAll <String>] [-AudienceMuteCommand <String>] [-CommandCharacter <String>] [-Confirm [<SwitchParameter>]] [-EnableDisableAnnouncementsCommand <String>] [-Force <SwitchParameter>] [-HelpCommand <String>] [-LockUnlockConferenceCommand <String>] [-MuteUnmuteCommand <String>] [-PrivateRollCallCommand <String>] [-WhatIf [<SwitchParameter>]]

Set-CsDialInConferencingDtmfConfiguration [-Identity <XdsIdentity>] [-AdmitAll <String>] [-AudienceMuteCommand <String>] [-CommandCharacter <String>] [-Confirm [<SwitchParameter>]] [-EnableDisableAnnouncementsCommand <String>] [-Force <SwitchParameter>] [-HelpCommand <String>] [-LockUnlockConferenceCommand <String>] [-MuteUnmuteCommand <String>] [-PrivateRollCallCommand <String>] [-WhatIf [<SwitchParameter>]]


Set-CsDialInConferencingDtmfConfiguration [-AdmitAll <String>] [-AudienceMuteCommand <String>] [-CommandCharacter <String>] [-Confirm [<SwitchParameter>]] [-EnableDisableAnnouncementsCommand <String>] [-Force <SwitchParameter>] [-HelpCommand <String>] [-Instance <PSObject>] [-LockUnlockConferenceCommand <String>] [-MuteUnmuteCommand <String>] [-PrivateRollCallCommand <String>] [-WhatIf [<SwitchParameter>]]

Set-CsDialInConferencingDtmfConfiguration [-AdmitAll <String>] [-AudienceMuteCommand <String>] [-CommandCharacter <String>] [-Confirm [<SwitchParameter>]] [-EnableDisableAnnouncementsCommand <String>] [-Force <SwitchParameter>] [-HelpCommand <String>] [-Instance <PSObject>] [-LockUnlockConferenceCommand <String>] [-MuteUnmuteCommand <String>] [-PrivateRollCallCommand <String>] [-WhatIf [<SwitchParameter>]]

Parameters

Parameter	Required	Type	Description
Identity	Optional	String	Indicates the unique identifier for the collection of DTMF settings you want to modify. To refer to the global settings use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. Note that you cannot use wildcards when specifying an Identity If this parameter is not specified then Set-CsDialInConferencingDtmfConfiguration will modify the global DTMF settings.
Instance	Optional	DialInConferencingDtmfConfiguration object	Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values.
CommandCharacter	Optional	String	Indicates the key to be pressed at the beginning of a command. The default key is the asterisk (*).
MuteUnmuteCommand	Optional	String	Indicates the key to be pressed to mute or unmute itself (use the same key to toggle back and forth between muting and unmuting). The default key is 6.
AudienceMute	Optional	String	Indicates the key a presenter can press to mute or unmute everyone else in the conference (that is, everyone other than the presenter will be muted or unmuted). The default key is 4.
LockUnlockConferenceCommand	Optional	String	Indicates the key to be pressed to lock or unlock a conference. If a conference is locked then no new participants will be allowed to join that conference, at least not until the conference has been unlocked. The default key is 7.
HelpCommand	Optional	String	Indicates the key to be pressed in order to privately play a description of all the DTMF commands. The default key is 1.
PrivateRollCallCommand	Optional	String	Indicates the key to be pressed to privately play the name of each conference participant. The default key is 3.
EnableDisableAnnouncementsCommand	Optional	String	Indicates the key to be pressed to enable or disable announcements each time someone joins or leaves the conference. The default key is 9.
AdmitAll	Optional	String	Indicates the key to be pressed in order to allow all the users in the lobby to immediately join the conference.
Force		Switch Parameter	Describes what would happen if you executed the command without actually executing the command.
WhatIf	Optional	Switch Parameter	Describes what would happen if you executed the command without actually executing the command.
Confirm	Optional	Switch Parameter	Prompts you for confirmation before executing the command.

Detailed Description

Microsoft Communications Server 2010 enables users to join conferences by dialing in over the telephone. Dial-in users are not able to view video or exchange instant messages with other conference attendees, but they are able to fully participate in the audio portion of the meeting.

In addition to being able to join a conference, users are also able to manage selected portions of that conference using their telephone keypad. (The specific conference settings users can and cannot manage depend on whether or not the user is a presenter.) For example, by default users can press the 6 key on their keypad to mute or unmute themselves. Participants can privately play the names of all the other people attending the meeting, while presenters can do such things as mute and unmute all the meeting participants and enable/disable the announcement that is played any time someone joins or leaves a conference.

The ability to make selections like these using a telephone keypad is known as DTMF (dual-tone multi-frequency) signaling: if you have ever dialed a phone number and been instructed to do something along the order of "Press 1 for English or press 2 for Spanish" then you have used DTMF signaling. The Set-CsDialInConferencingDtmfConfiguration cmdlet enables you to modify the keys used to trigger the commands supported in a Communications Server 2010 dial-in conference.

When modifying the DTMF commands keep two things in mind. First, you can only use the numeric keys 0 through 9 and the asterisk (*); any other keys that might be found on your keypad (such as the # key) are not allowed. Second, commands must be assigned unique keys; for example, the 4 key cannot be used both to mute and unmute yourself and to lock and unlock a conference. That means that, when modifying the keys assigned to a command, you might want to swap the keys used by two different commands. For example, if you want to assign the 4 to key EnableDisableAnnouncementsCommand (default value: 9) you should, in the same command, assign the 9 key to MuteUnmuteAllCommand.

To disable a command, set its value to Null ($Null).

Return Types

Set-CsDialInConferencingDtmfConfiguration does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration object.

Examples

-------------------------- Example 1 ------------------------

	Copy Code
Set-CsDialInConferencingDtmfConfiguration -EnableDisableAnnouncementsCommand 4 -MuteUnmuteAllCommand 9

The command shown in Example 1 swaps the keypad keys assigned to the command for enabling and disabling announcements (default value: 9) and the command for muting and unmuting all participants (default value: 4). To do this two different parameters are used: EnableDisableAnnoucementsCommand, which is given the parameter value 4; and MuteUnmuteAllCommand, which is given the value 9. Because no Identity is specified, these changes will affect the global DTMF settings.

-------------------------- Example 2 ------------------------

	Copy Code
Set-CsDialInConferencingDtmfConfiguration -Identity site:Redmond -EnableDisableAnnouncementsCommand 4 -MuteUnmuteAllCommand 9

The command shown in Example 2 is a variation of the command shown in the first example. In this case, however, the changes affect the DTMF settings that have the Identity site:Redmond.

-------------------------- Example 3 ------------------------

	Copy Code
Set-CsDialInConferencingDtmfConfiguration -Identity "site:Redmond" -PrivateRollCallCommand $Null

The command shown in Example 3 disables the roll call command: the ability to play back a list of all the people participating in the conference. To disable this command, the -PrivateRollCallCommand parameter is included, with the parameter value set to $Null. This means that no keypad key will be associated with the command, which, in turn, makes that command unavailable to users. The command changes the DTMF settings for the Redmond site.

-------------------------- Example 4 ------------------------

	Copy Code
Get-CsDialInConferencingDtmfConfiguration -Filter "site:*" \| Set-CsDialInConferencingDtmfConfiguration -PrivateRollCallCommand $Null

Example 4 is a variation on Example 3: in this example, the roll call command is disabled for all the DTMF settings that have been configured at the site scope. To do this, the command first uses Get-CsDialInConferencingDtmConfiguration and the -Filter parameter to return a collection of all the settings configured at the site scope; the filter value "site:" limits the returned data to those settings where the Identity begins with the characters "site:". (By definition, any settings that meet that criterion are settings configured at the site scope.) This filtered collection is then piped to Set-CsDialInConferencingDtmfConfiguration, which sets the value of the PrivateRollCallCommand property to null ($Null).