VoiceChat.getPreprocessingParam: Difference between revisions

From RAGE Multiplayer Wiki
No edit summary
(see also)
 
(2 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{ClientsideJsFunction}}
{{ClientsideJsFunction}}
 
'''Crash warning: It is worth noting some settings will return an array and can crash the game.'''
'''Crash warning: It is worth noting some settings will return an array and can crash the game.```


== Description ==
== Description ==
Line 7: Line 6:


==Parameters==
==Parameters==
* '''setting''' - the int representing the setting you wish to check (For example SPEEX_PREPROCESS_SET_NOISE_SUPPRESS would be 18) [https://github.com/xiph/speexdsp/blob/master/include/speex/speex_preprocess.h#L98-L212 SpeexDSP PreProcess Source].
* '''setting''' - the int representing the setting you wish to check (For example SPEEX_PREPROCESS_GET_DEREVERB would be 9) [https://github.com/xiph/speexdsp/blob/master/include/speex/speex_preprocess.h#L98-L212 SpeexDSP PreProcess Source].


(The setting you wish to checkcan also be confirmed in the following documentation: [https://www.speex.org/docs/api/speex-api-reference/group__SpeexPreprocessState.html#g55d8537631ed5b7e49ec60b79ca6e98f Speex])
(The setting you wish to checkcan also be confirmed in the following documentation: [https://www.speex.org/docs/api/speex-api-reference/group__SpeexPreprocessState.html#g55d8537631ed5b7e49ec60b79ca6e98f Speex])
Line 15: Line 14:


<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
mp.voiceChat.getPreprocessingParam(10);
mp.voiceChat.getPreprocessingParam(9);
</syntaxhighlight>
</syntaxhighlight>




'''This might require some more examples to show you the benefits of using a Pre Processor on the Voice Chat'''
'''This might require some more examples to show you the benefits of using a Pre Processor on the Voice Chat'''
==See Also==
{{Voicechat}}

Latest revision as of 13:15, 13 August 2024

Client-Side
Function

 JavaScript



Crash warning: It is worth noting some settings will return an array and can crash the game.

Description

This function is for getting Audio Pre-Processing on the Voicechat. This function is utilized by the Speexdsp library therefore for any setting you wish to check would be best referred to the documentation.

Parameters

  • setting - the int representing the setting you wish to check (For example SPEEX_PREPROCESS_GET_DEREVERB would be 9) SpeexDSP PreProcess Source.

(The setting you wish to checkcan also be confirmed in the following documentation: Speex)

Example

This example calling clientside event

mp.voiceChat.getPreprocessingParam(9);


This might require some more examples to show you the benefits of using a Pre Processor on the Voice Chat

See Also