Skip to content

ros_tts: configuration-node parameters

Source defaults below are not proof of installed runtime values. Secret-like parameter defaults are omitted. Runtime-only flags and edit-method expressions are preserved where declared.

scripts/tts_talker.py

Source: head-ros-nodes/ros/ros_tts/scripts/tts_talker.py

TTSTalker.init

Name Description Constructor default Min Max Options expression Runtime-only Source line
f'{slugify(lang, lowercase=False, separator='_')}' f'{voice_config.language} (lang: {lang}, count: {len(voice_config.choices)})' default_voice.voice None None self.voice_select_config_node.add_enums([Enum(name=f'{slugify(voice.voice, lowercase=False, separator='_')}', value=f'{voice.voice}', description=f'{voice.description}', type='str') for voice in voice_config.choices]) False 262

src/tts/config_nodes.py

Source: head-ros-nodes/ros/ros_tts/src/tts/config_nodes.py

TTSConfig.init

Name Description Constructor default Min Max Options expression Runtime-only Source line
'enable' 'Enable TTS' True None None `` False 64
'audio_output' 'Audio output' 'local' None None audio_output_enum False 65
'detect_language' 'Detect Language' False None None `` False 71
'lipsync_enabled' 'Enable Lipsync' True None None `` False 72
'lipsync_blender' 'Do Blender Lipsync' False None None `` False 73
'execute_marker' 'Execute markers in text' True None None `` False 74
'ignore_repeat' 'Not run TTS for the same text as the previous one when in chat' False None None `` False 75
'speech_rate' 'Set relative voice rate change (percentage)' 0 -30 20 `` False 80
'speech_pitch' 'Set relative voice pitch change (percentage)' 0 -100 100 `` False 87
'polly_gain' 'Adjust volume for Amazon Polly voice in dB' 0.0 -20.0 20.0 `` False 94
'tts_timeout' 'Timeout for audio synthesizing' 10.0 0.0 20.0 `` False 101
'tts_delay' 'Audio delay' 0.1 0.0 2.0 `` False 104
'wait_for_tts_ready' 'Wait for TTS Ready Message' False None None `` False 105
'tts_ready_delay' 'Play TTS if no tts ready is recived' 0.2 0.0 3.0 `` False 106
'fixed_playback_timing' 'Minimum amount to wait (s) for audio synth inc prepare for playback for next TTS request ONLY' 0.0 0.0 10.0 `` False 113
'emo_enabled' 'Enable emotion in tts' False None None `` False 120
'emotion' 'Emotions' 'happy' None None emotion_enum False 121
'chunk_size' 'Chunk Size' 1024 128 4096 `` False 122
'semitones' 'The number of semitones to shift' 1.0 -10.0 10.0 `` False 123
'cutfreq' "The filter's cutoff frequency in Hz" 4000.0 100.0 20000.0 `` False 126
'gain' 'The gain at the Nyquist frequency' 3.0 -20.0 20.0 `` False 129
'qfactor' "The filter's width as a Q-factor" 1.0 0.0 10.0 `` False 132
'speed' 'Tremolo speed in Hz' 8.5 1.0 100.0 `` False 133
'depth' 'Tremolo depth as a percentage of the total amplitude' 60.0 0.0 100.0 `` False 134
'tempo' 'The ratio of new tempo to the old tempo' 1.0 0.5 2.0 `` False 141
'intensity' 'Gain adjustment in decibels (dB)' 3.0 0.0 100.0 `` False 144
'parameter_control' 'Parameter Control' 1.0 0.5 2.0 `` False 147
### AudoLipsConfig.init
Name Description Constructor default Min Max Options expression Runtime-only Source line
'enabled' 'Enable' True None None `` False 158
'viseme_start_offset' 'Allosaurus viseme start offset' -0.2 -1.0 1.0 `` False 159
'random_visemes' 'Comma-separated random filler visemes. Leave empty to require recognizer output only.' ','.join(DEFAULT_AUDIO2LIPS_RANDOM_VISEMES) None None `` False 166
'random_viseme_duration' 'Random filler viseme duration' DEFAULT_RANDOM_VISEME_DURATION 0.05 0.3 `` False 171
'random_viseme_lead_duration' 'Maximum random filler lead over playback position' DEFAULT_RANDOM_VISEME_LEAD_DURATION 0.05 0.5 `` False 178
'random_viseme_max_batch_size' 'Maximum random filler visemes per tick' DEFAULT_RANDOM_VISEME_MAX_BATCH_SIZE 1 4 `` False 185
'process_elevenlabs_chunks_immediately' 'Process ElevenLabs chunks immediately' DEFAULT_PROCESS_ELEVENLABS_CHUNKS_IMMEDIATELY None None `` False 192
'elevenlabs_chunk_min_duration' '(expert) Minimum ElevenLabs chunk duration for immediate processing' DEFAULT_ELEVENLABS_CHUNK_MIN_DURATION 0.0 3.0 `` False 197
'playback_finish_tail' '(expert) Playback finish tail' DEFAULT_PLAYBACK_FINISH_TAIL 0.0 2.0 `` False 204
key f'Duration multiplier of {viseme}' DEFAULT_AUDIO2LIPS_VISEME_DURATIONS.get(key, 1.0) 0.5 4.0 `` False 213
'min_chunk_duration' '(expert) Minimum chunk duration' 1.0 0.1 10.0 `` False 220
'overlap_duration' '(expert) Overlap duration' 0.5 0.0 1.0 `` False 221
'forward_overlap_duration' '(expert) Forward overlap duration' 0.5 0.0 1.0 `` False 222

src/tts/elevenlabs_voice_manager.py

Source: head-ros-nodes/ros/ros_tts/src/tts/elevenlabs_voice_manager.py

ElevenLabsVoiceManager.setup_config_node

Name Description Constructor default Min Max Options expression Runtime-only Source line
'voice' 'Voice' 'dBYzjC7wmuKnVz2x1EaH' None None self.config_node.add_enums([Enum(name='SOPHIA_SPEAKS', value='dBYzjC7wmuKnVz2x1EaH', description='Soph Multilingual', type='str')]) False 44
'model' 'Model' 'eleven_flash_v2_5' None None [structured expression; see source] False 59
'speed' 'Speed (0.7: slowest, 1.2: fastest)' 1.0 0.7 1.2 `` False 111
'stability' 'Stability (0: most variable, 1: most stable)' 0.8 0 1 `` False 118
'similarity' 'Similarity (0: most different, 1: most similar)' 0.5 0 1 `` False 125
'seed' 'Seed (random seed for deterministic generation, 0 for random generation)' 1 0 1000 `` False 132
'previous_text' 'Previous Text (text that came before current request, used to improve prosody flow)' '' None None `` False 139
'next_text' 'Next Text (text that comes after current request, used to improve prosody flow)' '' None None `` False 144

src/tts/tts_mapping_config.py

Source: head-ros-nodes/ros/ros_tts/src/tts/tts_mapping_config.py

TTSMappingConfig.init

Name Description Constructor default Min Max Options expression Runtime-only Source line
'node_schema' 'Schema' json.dumps(self.node_schema()) None None `` False 109
'entries' 'Voice Pattern Table Entries' default_entries_json None None `` False 123

src/tts/viseme_config.py

Source: head-ros-nodes/ros/ros_tts/src/tts/viseme_config.py

TTSVisemeConfig._declare_params

Name Description Constructor default Min Max Options expression Runtime-only Source line
'node_schema' 'Schema' json.dumps(self.node_schema(), ensure_ascii=False) None None `` True 311
'mappings_state' 'Mappings State' json.dumps(self.mappings_state, ensure_ascii=False) None None `` False 317
'params_state' 'Params State' json.dumps(self.params_state, ensure_ascii=False) None None `` False 322
'mapping_provider' 'Mapping Provider' self.mapping_provider None None self.config_node.enum(sorted(self.mappings_state)) False 327
'mapping_rows' 'Mapping Rows' json.dumps(self._mapping_rows(self.mapping_provider), ensure_ascii=False) None None `` False 333
'mapping_unmapped' 'Unmapped Mapping Values' self._unmapped_csv(self.mapping_provider) None None `` True 340
'mapping_errors' 'Mapping Errors' '' None None `` True 346
'params_provider' 'Params Provider' self.params_provider None None self.config_node.enum(sorted(self.params_state)) False 352
'params_rows' 'Params Rows' json.dumps(self._params_rows(self.params_provider), ensure_ascii=False) None None `` False 358
'params_errors' 'Params Errors' '' None None `` True 363
'last_utterance' 'Last Utterance' '' None None `` True 369
'mapping_debug' 'Mapping Debug' '' None None `` True 375