Broadcast API | Guidde Help Center

Open the Widget API

Use the following API functions to open the widget in different ways:

guidde.open (customizationParams) - Opens the widget manually.
guidde.openVideo (videoId, customizationParams) - Opens a specific video.

guidde.openPlaylist (playlistId, customizationParams) - Opens a specific playlist.

You can copy the videoID or playlistID from the Guidde URL, see example below:

guidde.openQuerySearch (querySearchString, customizationParams) - Opens the widget with search results from a configured Channel.

When opening the widget, you can define how it looks and behaves using customization parameters (see below).

Close the Widget API

guidde.close(controlButtonCustomizationParams) - Manually closes the widget.
guidde.setControlButtonView(controlButtonCustomizationParams) - Adjusts the control button appearance. Useful when a user modifies a page and the previous position no longer aligns with the new layout.
guidde.toggleOpen(customizationParams) - Detects whether the widget is open or closed, then toggles it. Great for “Knowledge Center” buttons on your site.

Customization Parameters

Customization parameters can be used across different API functions. General Customization Params include control button settings and widget position.

Note: content that you want to open on-demand should be added to the configured Channels under the widget settings

General Customization Params

widgetSize = ‘mini’ | ‘medium’ | ‘theater’ - Controls the widget open form factor. The default value is ‘mini’ as can be seen in the following example on a Salesforce page.
isExpandedView = true | false
Opens the widget in expanded playlist view or single video view. Works only with 'mini' or 'medium'.
playState = 'play' | 'pause'
Determines if the video plays automatically after opening. Default is 'pause'.
widgetPosition — Control the horizontal placement of the widget using the new setWidgetPosition API.

Set Widget Position

You can control the horizontal placement of the Broadcast widget using the guidde.setWidgetPosition(widgetPosition) API. This allows you to fine-tune the widget’s left or right position on the page.

widgetPosition = {   widgetLeftPosition?: 'Xpx' | 'Xvw' | number,
  widgetRightPosition?: 'Xpx' | 'Xvw' | number }

widgetLeftPosition - Sets the distance from the left edge of the viewport.
widgetRightPosition - Sets the distance from the right edge of the viewport.
Accepts pixels ('20px'), viewport width ('10vw'), or a numeric value (20).

Control Button - Customization Parameters

The control button lets users open the widget from your page. You can customize where this button appears and how it behaves to fit your website layout.

controlButtonCustomizationParams = {   
controlButtonForm: 'bottom' | 'right' | 'none', // optional   controlButtonBottomPosition: 'Ypx' | 'Yvh' | number // optional }

Bottom - Button appears at the bottom right with your logo and text.
Right — Button appears on the right side of the page.
You can adjust its vertical placement using controlButtonBottomPosition.
- controlButtonBottomPosition defines the distance from the bottom of the screen.
- Accepts three types of values:
  - 'Ypx' — Fixed position in pixels, e.g., '50px'.
  - 'Yvh' — Position as a percentage of the viewport height, e.g., '10vh'.
  - number — Equivalent to pixels, e.g., 50.
None - Button is hidden after the widget is closed.

This ensures your control button fits naturally with your page layout, regardless of screen size.

With these API functions and customization options, you can fully control how and where the Broadcast widget appears, ensuring a seamless, tailored experience for your users on any page.