Set-CsMediaConfiguration
Modifies an existing collection of media settings. This cmdlet was introduced in Lync Server 2010.
Syntax
Identity
Set-CsMediaConfiguration
[[-Identity] <XdsIdentity>]
-EnableServerFecForVideoInterop
[-EnableQoS <Boolean>]
[-EnableSiren <Boolean>]
[-EncryptionLevel <EncryptionLevel>]
[-MaxVideoRateAllowed <MaxVideoRateAllowed>]
[-Force]
[-WhatIf]
[-Confirm]
[-EnableAdaptiveBandWidthEstimation <Boolean>]
[-EnableG722StereoCodec <Boolean>]
[-EnableH264Codec <Boolean>]
[-EnableInCallQoS <Boolean>]
[-EnableRtpRtcpMultiplexing <Boolean>]
[-InCallQoSIntervalSeconds <UInt16>]
[-EnableVideoBasedSharing <Boolean>]
[-EnableDtls <Boolean>]
[-EnableSilkForAudioVideoConferences <Boolean>]
[-WaitIceCompletedToAddDialOutUser]
[-EnableRtx <Boolean>]
[-EnableAVBundling <Boolean>]
[-EnableReceiveAgc <Boolean>]
[<CommonParameters>]
Instance
Set-CsMediaConfiguration
-EnableServerFecForVideoInterop
[-Instance <PSObject>]
[-EnableQoS <Boolean>]
[-EnableSiren <Boolean>]
[-EncryptionLevel <EncryptionLevel>]
[-MaxVideoRateAllowed <MaxVideoRateAllowed>]
[-Force]
[-WhatIf]
[-Confirm]
[-EnableAdaptiveBandWidthEstimation <Boolean>]
[-EnableG722StereoCodec <Boolean>]
[-EnableH264Codec <Boolean>]
[-EnableInCallQoS <Boolean>]
[-EnableRtpRtcpMultiplexing <Boolean>]
[-InCallQoSIntervalSeconds <UInt16>]
[-EnableVideoBasedSharing <Boolean>]
[-EnableDtls <Boolean>]
[-EnableSilkForAudioVideoConferences <Boolean>]
[-WaitIceCompletedToAddDialOutUser]
[-EnableRtx <Boolean>]
[-EnableAVBundling <Boolean>]
[-EnableReceiveAgc <Boolean>]
[<CommonParameters>]
Description
This cmdlet modifies a collection of settings that define media configuration. These actions relate to audio and video calls between client endpoints.
Examples
Example 1
Set-CsMediaConfiguration -Identity site:Redmond1 -MaxVideoRateAllowed hd720p15m
Example 1 modifies the media configuration collection with the Identity site:Redmond1; 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
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).
Parameters
-Confirm
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Prompts you for confirmation before executing the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableAdaptiveBandWidthEstimation
Applicable: Lync Server 2013
When set to True (the default value) Microsoft Lync Server will select the bandwidth rate at which to play a video stream. This selection will be based on such factors as the network congestion and the client's quality of the client's current network connection. This parameter was removed starting Lync Server Cumulative Update 3.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableAVBundling
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableDtls
Applicable: Skype for Business Server 2019
Enables the use of Datagram Transport Layer Security (DTLS) for ICE
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableG722StereoCodec
Applicable: Lync Server 2013
When set to True (the default value) allows the use of the G.722 wideband speech codec. G.722 is a standard voice codec commonly used with Voice over IP applications; with a sampling rate of 16 KHz G.722 provides higher voice quality and clarity than many other commonly-used speech codecs.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableH264Codec
Applicable: Lync Server 2013
When set to True (the default value) allows the use of the H.264/MPEG-4 AVC video codec. H.264 is a standard codec commonly used for recording, compressing and distributing high-definition video.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableInCallQoS
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Enables or disables the ability of Skype for Business clients to send the raw data that's required to generate InCallQuality messages.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableQoS
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
QoS monitors the quality of voice signals over a network. When set to True, enables call Quality of Service (QoS) settings.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableReceiveAgc
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableRtpRtcpMultiplexing
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Enables or disables the use of RTP/RTCP Multiplexing, if enabled, when negotiating, only one candidate will be used for both RTP and RTCP.
Parameter properties
| Type: | Boolean |
| Default value: | True |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableRtx
This parameter is reserved for internal Microsoft use.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableServerFecForVideoInterop
Applicable: Skype for Business Server 2019
Enables the use of server Forward Error Correction for video interoperability
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableSilkForAudioVideoConferences
Applicable: Skype for Business Server 2019
Enables the use of SILK codec for A/V conferences
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableSiren
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
By default, the Mediation Server does not negotiate Siren as a possible codec for calls between itself and other clients. If this setting is True, Siren will be included as a possible codec for use between the Mediation Server and other clients.
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EnableVideoBasedSharing
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Enables the use of Video Based Sharing, for more information, see Video based Screen Sharing for Skype for Business Server
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-EncryptionLevel
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
The level of encryption between unified communications devices.
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
Parameter properties
| Type: | EncryptionLevel |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Force
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Suppresses any confirmation prompts that would otherwise be displayed before making changes.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
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).
Parameter properties
| Type: | XdsIdentity |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Identity
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-InCallQoSIntervalSeconds
Applicable: Skype for Business Server 2015, Skype for Business Server 2019
Specifies the interval between call QoS actions.
Parameter properties
| Type: | UInt16 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Instance
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
An instance of the Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings object.
You can retrieve this object by calling the Get-CsMediaConfiguration cmdlet 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 the Set-CsMediaConfiguration cmdlet.
Parameter properties
| Type: | PSObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
Instance
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-MaxVideoRateAllowed
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
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
Parameter properties
| Type: | MaxVideoRateAllowed |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WaitIceCompletedToAddDialOutUser
Applicable: Skype for Business Server 2019
Waits until ICE negotiation is complete to dial out other people
Parameter properties
| Type: | Boolean |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-WhatIf
Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019
Describes what would happen if you executed the command without actually executing the command.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings
Accepts pipelined input of media configuration objects.