Class ChannelOptions

Options to set behaviour on a channel join - like making the channel the Active channel being spoken into, or having Vivox log in automatically without a seperate LoginAsync call

Inheritance

object

ChannelOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Unity.Services.Vivox

Assembly: Unity.Services.Vivox.dll

Syntax

public sealed class ChannelOptions

Properties

IsLargeText

When true, the SDK will mark the channel as a "large text" channel when joining. Large text channels allow a significantly higher number of text participants (for example, up to ~2000 users instead of the default ~200) and require server-side support and entitlement. This is an enterprise-only feature; to enable it for your project, contact Vivox customer support or your Vivox representative.

If enabled, the SDK will ensure the channel name used for the join includes the special "(t-largetext)" suffix (appending it if it is not already present). The SDK surface will continue to expose the human-friendly channel name (the suffix is removed for display/lookup); the large text designation is handled internally by the SDK and the Vivox service.

Declaration

public bool IsLargeText { get; set; }

Property Value

Type	Description
bool

MakeActiveChannelUponJoining

Makes the current channel being joined the active channel being spoken into.

Declaration

public bool MakeActiveChannelUponJoining { get; set; }

Property Value

Type	Description
bool