Voiceclass

Records and transmits voice/microphone input to other players.

objectComponentVoice
Namespace
Sandbox
Assembly
Sandbox.Engine
Declaration
public class Sandbox.Voice : Sandbox.Component

Constructors1

Showing 1 constructors

public Voice()PUBLICCONSTRUCTOR

Methods3

Showing 3 methods

protected virtual System.Collections.Generic.IEnumerable`1<Sandbox.Connection> ExcludeFilter()PROTECTEDVIRTUAL

Exclude these connection from hearing our voice.

Returns:IEnumerable<Connection>

protected virtual sealed void OnUpdate()PROTECTEDVIRTUALPER-FRAME

Returns:void

protected virtual bool ShouldHearVoice(Sandbox.Connection connection)PROTECTEDVIRTUAL

Whether we want to hear voice from a particular connection.

ParameterTypeDescription
connectionConnection
Returns:bool

Properties19

Showing 19 properties

public float Sandbox.Voice.Amplitude { get; set; }PUBLICGETSET

Measure of audio loudness.

Returns:float

public float Sandbox.Voice.Distance { get; set; }PUBLICGETSET

Returns:float

public Sandbox.Curve Sandbox.Voice.Falloff { get; set; }PUBLICGETSET

Returns:Curve

public bool Sandbox.Voice.IsListening { get; set; }PUBLICGETSET

Returns true if the mic is listening. Even if it's listening, it might not be playing - because it will only record and transmit if it can hear sound.

Returns:bool

public bool Sandbox.Voice.IsRecording { get; set; }PUBLICGETSET

Returns:bool

public float Sandbox.Voice.LaughterScore { get; set; }PUBLICGETSET

Laughter score for the current audio frame, between 0 and 1

Returns:float

public bool Sandbox.Voice.LipSync { get; set; }PUBLICGETSET

Returns:bool

public bool Sandbox.Voice.Loopback { get; set; }PUBLICGETSET

Returns:bool

public float Sandbox.Voice.MorphScale { get; set; }PUBLICGETSET

Returns:float

public float Sandbox.Voice.MorphSmoothTime { get; set; }PUBLICGETSET

Returns:float

public string Sandbox.Voice.PushToTalkInput { get; set; }PUBLICGETSETINGEST

Returns:string

public Sandbox.Audio.Mixer Sandbox.Voice.TargetMixer { get; set; }PUBLICGETSET

Returns:Mixer

public System.Collections.Generic.IReadOnlyList`1<float> Sandbox.Voice.Visemes { get; set; }PUBLICGETSET

A list of 15 lipsync viseme weights. Requires `Sandbox.Voice.LipSync` to be enabled.

Returns:IReadOnlyList<float>

public Sandbox.Audio.MixerHandle Sandbox.Voice.VoiceMixer { get; set; }PUBLICGETSET

Which mixer to target. Must be a descendant of the Voice mixer. Defaults to the Voice mixer if not set or invalid.

Returns:MixerHandle

public float Sandbox.Voice.Volume { get; set; }PUBLICGETSET

Returns:float

public bool Sandbox.Voice.WorldspacePlayback { get; set; }PUBLICGETSET

Returns:bool

On this page