Class: UiSettings

  • UiSettings allows publishers to customize the stream's user interface.

  • It provides methods to set the locale for UI elements, impacting the language displayed to users.

  • The locale should be configured before initializing StreamManager for it to take effect.

  • Supported locale codes are documented in the provided link for localization.

UiSettings

class   public

Stream UI Settings.

Constructor

UiSettings

new UiSettings()

Constructor.

Methods

getLocale

getLocale() returns string

Returns the locale set for the stream.

Returns

string 

setLocale

setLocale(locale) returns void

Sets the publisher provided locale. Must be called before creating StreamManager. The locale specifies the language in which to display UI elements. The supported codes can be found in Localizing for Language and Locale.

Parameter

locale

string

Publisher provided locale.
Returns

void