homeTheater > setOptions

Use setOptions in the homeTheater namespace to set homeTheaterOptions such as nightMode and enhanceDialog. See the homeTheaterOptions type for details.



Request Parameters

Set player settings using the following parameters in the body. These are all optional.

Parameter Type Value
nightMode Boolean Night mode enhances quiet sounds and reduces the intensity of loud sounds. Turn on to reduce the volume of loud sounds while still experiencing proper balance and range. Set to true to turn on night mode or false to turn it off.
enhanceDialog Boolean Speech enhancement boosts the audio frequencies associated with the human voice. Turn on to make dialogue easier to hear. Set to true to turn on speech enhancement or false to turn it off.

This command requires a playerId to determine the target of the command. See Control for details.


Returns a homeTheaterOptions object representing the state of the group.

If not successful, returns a globalError.