Stay organized with collections Save and categorize content based on your preferences.
UiSettings
classpublic
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[[["\u003cp\u003e\u003ccode\u003eUiSettings\u003c/code\u003e allows publishers to customize the stream's user interface.\u003c/p\u003e\n"],["\u003cp\u003eIt provides methods to set the locale for UI elements, impacting the language displayed to users.\u003c/p\u003e\n"],["\u003cp\u003eThe locale should be configured before initializing \u003ccode\u003eStreamManager\u003c/code\u003e for it to take effect.\u003c/p\u003e\n"],["\u003cp\u003eSupported locale codes are documented in the provided link for localization.\u003c/p\u003e\n"]]],[],null,["# Class: UiSettings\n\nUiSettings\n==========\n\nclass public\n\nStream UI Settings.\n\nConstructor\n-----------\n\n### UiSettings\n\nnew\nUiSettings()\n\nConstructor.\n\nMethods\n-------\n\n### getLocale\n\ngetLocale() returns string\n\nReturns the locale set for the stream.\n\nReturns\n\n: `string`\n\n### setLocale\n\nsetLocale(locale) returns void\n\nSets the publisher provided locale. Must be called before creating\nStreamManager. The locale specifies the language\nin which to display UI elements. The supported codes can be found in\n[Localizing for Language and Locale](/ad-manager/dynamic-ad-insertion/sdk/html5/localization).\n\n| #### Parameter ||\n|--------|-----------------------------------|\n| locale | string Publisher provided locale. |\n\nReturns\n\n: `void`"]]
