bigbluebutton-html-plugin-sdk
Version:
This repository contains the SDK for developing BigBlueButton plugins. Plugins are React components that can be loaded from external sources by the BigBlueButton HTML5 client to extend its functionalities.
39 lines (38 loc) • 1.62 kB
TypeScript
import { CameraSettingsDropdownItemType } from './enums';
import { CameraSettingsDropdownInterface, CameraSettingsDropdownOptionProps } from './types';
export declare class CameraSettingsDropdownOption implements CameraSettingsDropdownInterface {
id: string;
type: CameraSettingsDropdownItemType;
label: string;
icon: string;
dataTest: string;
onClick: () => void;
/**
* Returns object to be used in the setter for the camera settings dropdown. In this case,
* an option.
*
* @param label - label to be displayed in camera settings dropdown option.
* @param icon - icon to be used in the option for the dropdown. It goes in the left side of it.
* @param dataTest - data-test attribute to be used in the option for the dropdown.
* @param onClick - function to be called when clicking the button.
*
* @returns Object that will be interpreted by the core of Bigbluebutton (HTML5).
*/
constructor({ id, label, icon, dataTest, onClick, }: CameraSettingsDropdownOptionProps);
setItemId: (id: string) => void;
}
export declare class CameraSettingsDropdownSeparator implements CameraSettingsDropdownInterface {
id: string;
type: CameraSettingsDropdownItemType;
/**
* Returns object to be used in the setter for the camera settings dropdown. In this case,
* a separator.
*
* @remarks
* It will display a horizontal thin black line inside the dropdown.
*
* @returns Object that will be interpreted by the core of Bigbluebutton (HTML5)
*/
constructor();
setItemId: (id: string) => void;
}