Struct MuteStreamsRequest.MuteStreamsConfiguration

Namespace

Vonage.Video.Moderation.MuteStreams

Assembly

Vonage.dll

Represents a configuration for muting streams.

public struct MuteStreamsRequest.MuteStreamsConfiguration

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

MuteStreamsConfiguration(bool, string[])

Creates a configuration.

public MuteStreamsConfiguration(bool active, string[] excludedStreamIds)

Parameters

active bool

Whether to mute streams in the session (true) and enable the mute state of the session, or to disable the mute state of the session (false). With the mute state enabled (true), all current and future streams published to the session (with the exception of streams in the excludedStreamIds array) are muted. When you call this method with the active property set to false, future streams published to the session are not muted (but any existing muted streams remain muted).

excludedStreamIds string[]

The stream IDs for streams that should not be muted. This is an optional property. If you omit this property, all streams in the session will be muted. This property only applies when the active property is set to true. When the active property is set to false, it is ignored. The elements in the excludedStreamIds array are stream IDs (strings) for the streams you wish to exclude from being muted. If you do not wish to include an array of excluded streams, do not include any body content.

Properties

Active

Whether to mute streams in the session (true) and enable the mute state of the session, or to disable the mute state of the session (false). With the mute state enabled (true), all current and future streams published to the session (with the exception of streams in the excludedStreamIds array) are muted. When you call this method with the active property set to false, future streams published to the session are not muted (but any existing muted streams remain muted).

public bool Active { readonly get; set; }

Property Value

bool

ExcludedStreamIds

The stream IDs for streams that should not be muted. This is an optional property. If you omit this property, all streams in the session will be muted. This property only applies when the active property is set to true. When the active property is set to false, it is ignored. The elements in the excludedStreamIds array are stream IDs (strings) for the streams you wish to exclude from being muted. If you do not wish to include an array of excluded streams, do not include any body content.

public string[] ExcludedStreamIds { readonly get; set; }

Property Value

string[]