Env microphone: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
mNo edit summary
m (Robot: fixing template case.)
Line 70: Line 70:
* {{i targetname}}
* {{i targetname}}
* {{i parentname}}
* {{i parentname}}
* {{i enabledisable}}
* {{I EnableDisable}}
* '''SetSpeakerName <target_destination>'''
* '''SetSpeakerName <target_destination>'''
: Set the microphone to output through a different speaker entity.
: Set the microphone to output through a different speaker entity.

Revision as of 19:28, 19 January 2009

Template:Wrongtitle Template:Base point

Entity description

Env microphone.png

Broadcasts sound from a location for either playback or monitoring.

See Also

Keyvalues

<target_destination> If the speaker is in Measuring mode, this is the name of the entity where the sound level is to be measured.
  • SpeakerName
<target_destination> The name of a speaker entity through which to play any sounds heard by this microphone. If specified, the microphone will consider itself in Speaker mode. Cannot be an env_speaker!
  • ListenFilter
<filterclass> The name of an filter entity which specifies the only entities the microphone can hear. Sounds emitted by other entities will not be heard.
  • speaker_dsp_preset
<choices> Only useful in Speaker mode. If specified, when the microphone is enabled, it'll set the global dsp_speaker preset to this value. Sounds played back through speakers will then be affected by the selected DSP.
Literal Value Description
0 Use Default
50 1 NO EFFECT
51 2 (DUPLICATE OF 1)
52 3 (DUPLICATE OF 1)
53 4 (DUPLICATE OF 1)
54 5 (DUPLICATE OF 1)
55 6 SPEAKER, LOUDER
56 7 SPEAKER VERY SMALL
57 8 LOUDSPEAKER, ECHO
58 9 SPEAKER SMALL
59 10 SPEAKER TINY
  • Sensitivity
<float> (0-10) If the speaker is being used to monitor sound levels, this keyvalue dictates its sensitivity.
Literal Value Description
0 Deaf
1 Normal
2-10 Increasing Sensitivity
  • MaxRange
<float> (0-∞) Sounds beyond this range won't be heard, irrelevant of attenuation.
Warning.pngWarning:setting this to zero (or a value > 1024) when the microphone is in Speaker mode can be very bad for performance!!

Inputs

Enable / Disable
Enable/disable this entity from performing its task. It might also disappear from view.
  • SetSpeakerName <target_destination>
Set the microphone to output through a different speaker entity.

Outputs

Fired in Measuring mode whenever the sound level changes.
  • OnRoutedSound
Fired whenever a sound is routed out through the specified speaker (if any).
  • OnHeardSound
Fired whenever this microphone hears any sound it cares about.