@selfcommunity/react-ui/lib/esm/components/LiveStreamRoom/LiveStreamRoom.d.ts

React UI Components to integrate a Community created with SelfCommunity Platform.

import { BoxProps } from '@mui/material';
import { SCLiveStreamType } from '@selfcommunity/types';
import { LocalUserChoices } from '@livekit/components-react';
import React from 'react';
import { ConnectionDetails } from './types';
import { LiveStreamVideoConferenceProps } from './LiveStreamVideoConference';
import '@livekit/components-styles';
export interface LiveStreamRoomProps extends BoxProps {
    /**
     * Overrides or extends the styles applied to the component.
     * @default null
     */
    className?: string;
    /**
     * Event Object
     * @default null
     */
    liveStream?: SCLiveStreamType;
    /**
     * Id of the liveStream for filter the feed
     * @default null
     */
    liveStreamId?: number;
    /**
     * Element to be inserted before title
     */
    startPrejoinContent?: React.ReactNode | null;
    /**
     * Element to be inserted after title
     */
    endPrejoinContent?: React.ReactNode | null;
    /**
     * Show title of livestream in prejoin
     */
    showPrejoinTitle?: boolean;
    /**
     * Show description of livestream in prejoin
     */
    showPrejoinDescription?: boolean;
    /**
     * ConnectionDetails Object
     * @default null
     */
    presetConnectionDetails?: ConnectionDetails;
    /**
     * LocalUserChoices Object
     * @default null
     */
    presetPreJoinChoices?: LocalUserChoices;
    /**
     * Props to spread to LiveStreamVideoConference Component
     * @default {}
     */
    LiveStreamVideoConferenceComponentProps?: LiveStreamVideoConferenceProps;
    /**
     * Any other properties
     */
    [p: string]: any;
}
/**
 *> API documentation for the Community-JS LiveStreamRoom component. Learn about the available props and the CSS API.
 *
 #### Import
 ```jsx
 import {LiveStreamRoom} from '@selfcommunity/react-ui';
 ```

 #### Component Name
 The name `LiveStreamRoom` can be used when providing style overrides in the theme.

 #### CSS

 |Rule Name|Global class|Description|
 |---|---|---|
 |root|.SCLiveStreamRoom-root|Styles applied to the root element.|
 |title|.SCLiveStreamRoom-title|Styles applied to the title element.|
 |description|.SCLiveStreamRoom-description|Styles applied to the description element.|
 |content|.SCLiveStreamRoom-content|Styles applied to the content.|
 |prejoin|.SCLiveStreamRoom-prejoin|Styles applied to the prejoin.|
 |conference|.SCLiveStreamRoom-conference|Styles applied to the conference.|
 |error|.SCLiveStreamRoom-error|Styles applied to the error elements.|

 * @param inProps
 */
export default function LiveStreamRoom(inProps: LiveStreamRoomProps): JSX.Element;