bigbluebutton-html-plugin-sdk/dist/cjs/extensible-areas/user-camera-dropdown-item/component.d.ts

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.

import { UserCameraDropdownItemType } from './enums';
import { OnclickFunctionCallbackArguments, UserCameraDropdownCallbackFunctionsArguments, UserCameraDropdownInterface, UserCameraDropdownOptionProps, UserCameraDropdownSeparatorProps } from './types';
export declare class UserCameraDropdownOption implements UserCameraDropdownInterface {
    id: string;
    type: UserCameraDropdownItemType;
    label: string;
    icon: string;
    onClick: (args: OnclickFunctionCallbackArguments) => void;
    displayFunction?: (args: UserCameraDropdownCallbackFunctionsArguments) => boolean;
    /**
     * Returns object to be used in the setter for User Camera Dropdown. In this case
     * an option.
     *
     * @param label - label to be displayed in the option.
     * @param icon - icon to be displayed in the option. Left side of it.
     * @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, onClick, displayFunction, }: UserCameraDropdownOptionProps);
    setItemId: (id: string) => void;
}
export declare class UserCameraDropdownSeparator implements UserCameraDropdownInterface {
    id: string;
    type: UserCameraDropdownItemType;
    displayFunction?: (args: UserCameraDropdownCallbackFunctionsArguments) => boolean;
    /**
     * Returns object to be used in the setter for User Camera Dropdown. In this case
     * a separator.
     *
     * @returns Object that will be interpreted by the core of Bigbluebutton (HTML5)
     */
    constructor({ displayFunction, }?: UserCameraDropdownSeparatorProps);
    setItemId: (id: string) => void;
}