See Also
Topic Last Modified: 2011-04-12
Modifies an existing collection of media settings.
Syntax
Set-CsMediaConfiguration [-Identity <XdsIdentity>]
[-Confirm [<SwitchParameter>]] [-EnableQoS <$true |
$false>] [-EnableSiren <$true | $false>] [-EncryptionLevel
<SupportEncryption | RequireEncryption |
DoNotSupportEncryption>] [-Force <SwitchParameter>]
[-MaxVideoRateAllowed <CIF250K | VGA600K | Hd720p15M>]
[-WhatIf [<SwitchParameter>]]
|
Set-CsMediaConfiguration [-Confirm
[<SwitchParameter>]] [-EnableQoS <$true | $false>]
[-EnableSiren <$true | $false>] [-EncryptionLevel
<SupportEncryption | RequireEncryption |
DoNotSupportEncryption>] [-Force <SwitchParameter>]
[-Instance <PSObject>] [-MaxVideoRateAllowed <CIF250K |
VGA600K | Hd720p15M>] [-WhatIf [<SwitchParameter>]]
|
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
XdsIdentity |
The unique identifier of the media configuration settings you want to change. This identifier specifies the scope at which this configuration is applied (global, site, or service). |
|
Instance |
Optional |
MediaSettings |
An instance of the Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings object. You can retrieve this object by calling Get-CsMediaConfiguration with a specific Identity. You can then assign new values to the properties of that object, and then save those changes by passing the object to Set-CsMediaConfiguration. |
|
EnableQoS |
Optional |
Boolean |
QoS monitors the quality of voice signals over a network. |
|
EnableSiren |
Optional |
Boolean |
By default, the Mediation Server does not negotiate Siren as a possible codec for calls between itself and other Microsoft Lync 2010 clients. If this setting is True, Siren will be included as a possible codec for use between the Mediation Server and other Lync 2010 clients. |
|
EncryptionLevel |
Optional |
EncryptionLevel |
The level of encryption between Unified Communications entities. Valid values: SupportEncryption - secure real-time transport protocol (SRTP) will be used if it can be negotiated. RequireEncryption - SRTP must be negotiated. DoNotSupportEncryption - SRTP must not be used. This value is not case sensitive. (For details, see the Examples in this topic.) Default: RequireEncryption |
|
MaxVideoRateAllowed |
Optional |
MaxVideoRateAllowed |
The maximum rate at which video signals will be transferred at the client endpoints. Valid values: Hd720p15M, VGA600K, CIF250K Hd720p15M - High definition, with a resolution of 1280 x 720 and aspect ratio 16:9. VGA600K - VGA, with a resolution of 640 x 480, 25 fps with the aspect ratio 4:3. CIF250K - Common Intermediate Format (CIF) video format, 15 fps with a resolution of 352 x 288. Note that these values are not case sensitive; values will be converted to appropriate casing when the configuration is created. (For details, see the Examples in this topic.) Default: VGA600K |
|
Force |
Optional |
SwitchParameter |
Suppresses any confirmation prompts that would otherwise be displayed before making changes. |
|
WhatIf |
Optional |
SwitchParameter |
Describes what would happen if you executed the command without actually executing the command. |
|
Confirm |
Optional |
SwitchParameter |
Prompts you for confirmation before executing the command. |
Detailed Description
This cmdlet modifies a collection of settings that define media configuration. These actions relate to audio and video calls between client endpoints.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Set-CsMediaConfiguration cmdlet locally: RTCUniversalServerAdmins. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt:
Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Set-CsMediaConfiguration"}
Input Types
Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings object. Accepts pipelined input of media configuration objects.
Return Types
Set-CsMediaConfiguration does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings object.
Example
-------------------------- Example 1 --------------------------
 Copy Code |
|
|---|---|
Set-CsMediaConfiguration -Identity site:Redmond1 -MaxVideoRateAllowed hd720p15m |
|
The example shown above modifies the media configuration collection with the Identity site:co1; in particular, the command sets the value of the MaxVideoRateAllowed property to Hd720p15M. Note that the value passed to the MaxVideoRateAllowed parameter must be one of the values specified in the parameter description. Also note that the values are not case sensitive; the value entered here as hd720p15m will be automatically converted to the appropriate casing (in this instance, to Hd720p15M).
-------------------------- Example 2 --------------------------
| Copy Code |
|
|---|---|
Set-CsMediaConfiguration site:Redmond1 -EncryptionLevel donotsupportencryption |
|
This example modifies the media configuration collection with the Identity site:Redmond1 to have an EncryptionLevel value of DoNotSupportEncryption. Note that this value is not case sensitive; the value was entered as donotsupportencryption, but that value will be accepted as a valid value and will be automatically changed to mixed case (DoNotSupportEncryption).