docs.unity3d.com
    Show / Hide Table of Contents

    Struct VoiceParticipant

    Represents data for a participant connected to a voice service

    Inherited Members
    ValueType.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Namespace: Unity.Cloud.Presence
    Syntax
    public struct VoiceParticipant : IEquatable<VoiceParticipant>

    Constructors

    VoiceParticipant(String, VoiceId, Boolean, Boolean, Double)

    Declaration
    public VoiceParticipant(string displayName, VoiceId voiceId, bool isMutedForAll, bool speechDetected, double audioIntensity)
    Parameters
    Type Name Description
    String displayName
    VoiceId voiceId
    Boolean isMutedForAll
    Boolean speechDetected
    Double audioIntensity

    Properties

    AudioIntensity

    Sets the normalized audio intensity. Goes from 0.0 to 1.0.

    Declaration
    public readonly double AudioIntensity { get; }
    Property Value
    Type Description
    Double

    DisplayName

    Gets the participant display name. Matches Vivox.IParticipant.Account.DisplayName.

    Declaration
    public readonly string DisplayName { get; }
    Property Value
    Type Description
    String

    IsMutedForAll

    Sets to TRUE if the participant is muted.

    Declaration
    public readonly bool IsMutedForAll { get; }
    Property Value
    Type Description
    Boolean

    SpeechDetected

    Sets to TRUE if the participant is talking.

    Declaration
    public bool SpeechDetected { get; set; }
    Property Value
    Type Description
    Boolean

    VoiceId

    Gets the Vivox Participant.Id.

    Declaration
    public readonly VoiceId VoiceId { get; }
    Property Value
    Type Description
    VoiceId

    Methods

    Equals(Object)

    Declaration
    public override bool Equals(object obj)
    Parameters
    Type Name Description
    Object obj
    Returns
    Type Description
    Boolean
    Overrides
    ValueType.Equals(Object)

    Equals(VoiceParticipant)

    Declaration
    public bool Equals(VoiceParticipant other)
    Parameters
    Type Name Description
    VoiceParticipant other
    Returns
    Type Description
    Boolean
    Implements
    IEquatable<T>.Equals(T)

    GetHashCode()

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32
    Overrides
    ValueType.GetHashCode()

    Extension Methods

    GenericDataExtensions.SerializeToByteArray(Object)
    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023