controllers / clientsettings.phpClientSettings
Controller
Manages global OpenBroadcaster settings. Does NOT manage settings for individual users, but is called Client Settings to differentiate from Settings, which manages media-related settings.
public
get_login_message
(
)
public
get_login_message
(
)
Get the login message.
Returns
client_login_message
API Route
GET
/api/v2/clientsettings/login-message
public
get_welcome_page
(
)
public
get_welcome_page
(
)
Get the welcome page. Returns a string in HTML format.
Returns
client_welcome_page
API Route
GET
/api/v2/clientsettings/welcome-page
public
set_login_message
(
)
public
set_login_message
(
)
Set a login message.
Parameters
client_login_message |
Returns
setting_result
API Route
POST
/api/v2/clientsettings/login-message
public
set_welcome_page
(
)
public
set_welcome_page
(
)
Set the welcome page.
Parameters
client_welcome_page |
The HTML welcome page to display. |
Returns
setting_result
API Route
POST
/api/v2/clientsettings/welcome-page