Class: UiSettings

  • Stream UI settings can be accessed and configured using the UiSettings class.

  • The locale for the stream's UI elements can be retrieved or set using the getLocale and setLocale methods respectively.

  • The setLocale method must be called before creating a StreamManager to specify the language of UI elements.

  • Supported locale codes can be found in the Localizing for Language and Locale documentation.

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