Class VoiceSettings

Inheritance

System.Object

VoiceSettings

Namespace: Adrenak.UniVoice

Assembly: cs.temp.dll.dll

Syntax

public class VoiceSettings

Fields

deafenAll

If true, we don't want any peer to listen to us

Declaration

public bool deafenAll

Field Value

Type	Description
System.Boolean

deafenedPeers

The peers we don't want listening to us

Declaration

public List<int> deafenedPeers

Field Value

Type	Description
System.Collections.Generic.List<System.Int32>

muteAll

If true, we don't want to listen to any peer

Declaration

public bool muteAll

Field Value

Type	Description
System.Boolean

mutedPeers

The peers we don't want to listen to

Declaration

public List<int> mutedPeers

Field Value

Type	Description
System.Collections.Generic.List<System.Int32>

Properties

deafenedTags

List of tags deafened by this client. Use AddDeafenedTag(String) and RemoveDeafenedTag(String) to add or remove tags.

Declaration

public List<string> deafenedTags { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

mutedTags

List of tags muted by this client. Use AddMutedTag(String) and RemoveMutedTag(String) to add or remove tags.

Declaration

public List<string> mutedTags { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

myTags

List of tags associated with this client. Use AddMyTag(String) and RemoveMyTag(String) to add or remove tags.

Declaration

public List<string> myTags { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

Methods

AddDeafenedTag(String)

Adds a tag to the deafenedTags list. Commas (',') and null/empty values are not allowed!

Declaration

public bool AddDeafenedTag(string tag)

Parameters

Type	Name	Description
System.String	tag	The tag to add.

Returns

Type	Description
System.Boolean	TRUE: If the tag was accepted and added. FALSE: If tag wasn't added because the tag is not allowed or was already in the deafenedTags list

AddMutedTag(String)

Adds a tag to the mutedTags list. Commas (',') and null/empty values are not allowed!

Declaration

public bool AddMutedTag(string tag)

Parameters

Type	Name	Description
System.String	tag	The tag to add.

Returns

Type	Description
System.Boolean	TRUE: If the tag was accepted and added. FALSE: If tag wasn't added because the tag is not allowed or was already in the mutedTags list

AddMyTag(String)

Adds a tag to the myTags list. Commas (',') and null/empty values are not allowed!

Declaration

public bool AddMyTag(string tag)

Parameters

Type	Name	Description
System.String	tag	The tag to add.

Returns

Type	Description
System.Boolean	TRUE: If the tag was accepted and added. FALSE: If tag wasn't added because the tag is not allowed or was already in the myTags list

RemoveDeafenedTag(String)

Removes a tag from the deafenedTags list.

Declaration

public bool RemoveDeafenedTag(string tag)

Parameters

Type	Name	Description
System.String	tag	The tag to be removed.

Returns

Type	Description
System.Boolean	TRUE: If the tag was removed. FALSE: If the tag was not removed because it's not in the deafenedTags list

RemoveMutedTag(String)

Removes a tag from the mutedTags list.

Declaration

public bool RemoveMutedTag(string tag)

Parameters

Type	Name	Description
System.String	tag	The tag to be removed.

Returns

Type	Description
System.Boolean	TRUE: If the tag was removed. FALSE: If the tag was not removed because it's not in the mutedTags list

RemoveMyTag(String)

Removes a tag from the myTags list.

Declaration

public bool RemoveMyTag(string tag)

Parameters

Type	Name	Description
System.String	tag	The tag to be removed.

Returns

Type	Description
System.Boolean	TRUE: If the tag was removed. FALSE: If the tag was not removed because it's not in the myTags list

SetDeaf(Int32, Boolean)

Sets the deaf status of a peer

Declaration

public void SetDeaf(int peerId, bool state)

Parameters

Type	Name	Description
System.Int32	peerId
System.Boolean	state

SetDeafenedTag(String, Boolean)

Adds/Removes a tag from deafenedTags list

Declaration

public bool SetDeafenedTag(string tag, bool enable)

Parameters

Type	Name	Description
System.String	tag
System.Boolean	enable

Returns

Type	Description
System.Boolean

SetMute(Int32, Boolean)

Sets the mute status of a peer

Declaration

public void SetMute(int peerId, bool state)

Parameters

Type	Name	Description
System.Int32	peerId
System.Boolean	state

SetMutedTag(String, Boolean)

Adds/Removes a tag from mutedTags list

Declaration

public bool SetMutedTag(string tag, bool enable)

Parameters

Type	Name	Description
System.String	tag
System.Boolean	enable

Returns

Type	Description
System.Boolean

SetMyTag(String, Boolean)

Adds/Removes a tag from myTags list

Declaration

public bool SetMyTag(string tag, bool enable)

Parameters

Type	Name	Description
System.String	tag
System.Boolean	enable

Returns

Type	Description
System.Boolean

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.Object.ToString()