getPlatform

Returns the platform declared by the host application during SDK configuration.

Overview

Use getPlatform to read back the platform value that was passed to configure. If configure was called without a platform parameter, this method returns 'bbd' (the default).

Method Signature

getPlatform(): MaestroPlatform

Parameters

This method takes no parameters.

Return Value

The platform the SDK is running on, as a MaestroPlatform value.

type MaestroPlatform = 'bbd' | 'desktop_web';

Value	Description
'bbd'	Big-screen / broadcast display (TV UI).
'desktop_web'	Desktop web browser (web-optimized UI).

Example

import SDK from "@maestro_io/maestro-web-sdk";

SDK.configure({
  siteID: "<your-site-id>",
  platform: "desktop_web",
});

const platform = SDK.getPlatform(); // 'desktop_web'

Notes

• The platform defaults to 'bbd' if not specified in configure.
• See configure for the full list of configuration options.