MediaSFU ReactJS
    Preparing search index...

    Interface ClickAudioParameters

    interface ClickAudioParameters {
        audioDecibels: AudioDecibels[];
        coHostResponsibility: CoHostResponsibility[];
        coHost: string;
        videoParams: ProducerOptions;
        canvasStream: MediaStream | null;
        connectSendTransportVideo: ConnectSendTransportVideoType;
        connectSendTransportScreen: ConnectSendTransportScreenType;
        updateAudioLevel: (level: number) => void;
        screenProducer: Producer<AppData> | null;
        localScreenProducer?: Producer<AppData> | null;
        screenParams: ProducerOptions;
        updateScreenProducer: (producer: Producer<AppData> | null) => void;
        updateLocalScreenProducer?: (
            localProducer: Producer<AppData> | null,
        ) => void;
        videoProducer: Producer<AppData> | null;
        localVideoProducer?: Producer<AppData> | null;
        updateVideoProducer: (producer: Producer<AppData> | null) => void;
        updateLocalVideoProducer?: (
            localProducer: Producer<AppData> | null,
        ) => void;
        device: Device | null;
        producerTransport: Transport<AppData> | null;
        localProducerTransport?: Transport<AppData> | null;
        localTransportCreated?: boolean;
        updateProducerTransport: (
            producerTransport: Transport<AppData> | null,
        ) => void;
        updateLocalProducerTransport?: (
            localTransport: Transport<AppData> | null,
        ) => void;
        updateLocalTransportCreated?: (localTransportCreated: boolean) => void;
        connectSendTransport: ConnectSendTransportType;
        audioProducer: Producer<AppData> | null;
        localAudioProducer?: Producer<AppData> | null;
        videoAlreadyOn: boolean;
        lock_screen: boolean;
        shared: boolean;
        updateMainWindow: boolean;
        hostLabel: string;
        updateAudioProducer: (audioProducer: Producer<AppData> | null) => void;
        updateLocalAudioProducer?: (
            localAudioProducer: Producer<AppData> | null,
        ) => void;
        updateUpdateMainWindow: (updateMainWindow: boolean) => void;
        prepopulateUserMedia: PrepopulateUserMediaType;
        allVideoStreams: (Stream | Participant)[];
        shareScreenStarted: boolean;
        eventType: EventType;
        screenId?: string;
        forceFullDisplay: boolean;
        mainScreenFilled: boolean;
        adminOnMainScreen: boolean;
        mainScreenPerson: string;
        oldAllStreams: (Stream | Participant)[];
        checkOrientation: () => string;
        screenForceFullDisplay: boolean;
        localStreamScreen: MediaStream | null;
        remoteScreenStream: Stream[];
        localStreamVideo: MediaStream | null;
        mainHeightWidth: number;
        isWideScreen: boolean;
        localUIMode: boolean;
        whiteboardStarted: boolean;
        whiteboardEnded: boolean;
        virtualStream: MediaStream | null;
        keepBackground: boolean;
        annotateScreenStream: boolean;
        updateMainScreenPerson: (person: string) => void;
        updateMainScreenFilled: (filled: boolean) => void;
        updateAdminOnMainScreen: (admin: boolean) => void;
        updateMainHeightWidth: (heightWidth: number) => void;
        updateScreenForceFullDisplay: (force: boolean) => void;
        updateMainGridStream: (components: Element[]) => void;
        isDarkModeValue?: boolean;
        showSubtitlesOnCards?: boolean;
        liveSubtitles?: Map<string, LiveSubtitle>;
        customVideoCard?: CustomVideoCardType;
        customAudioCard?: CustomAudioCardType;
        customMiniCard?: CustomMiniCardType;
        videoCardComponent?: ComponentType<VideoCardOptions>;
        audioCardComponent?: ComponentType<AudioCardOptions>;
        miniCardComponent?: ComponentType<MiniCardOptions>;
        prepopulateLocalUserMedia?: PrepopulateUserMediaType;
        audioParams: ProducerOptions;
        localStreamAudio: MediaStream | null;
        defAudioID: string;
        params: ProducerOptions;
        audioParamse?: ProducerOptions;
        aParams: ProducerOptions;
        updateAudioParams: (audioParams: ProducerOptions) => void;
        updateLocalStreamAudio: (localStreamAudio: MediaStream | null) => void;
        updateDefAudioID: (defAudioID: string) => void;
        updateUserDefaultAudioInputDevice: (
            userDefaultAudioInputDevice: string,
        ) => void;
        createSendTransport: CreateSendTransportType;
        connectSendTransportAudio: ConnectSendTransportAudioType;
        checkMediaPermission: boolean;
        hasAudioPermission: boolean;
        audioPaused: boolean;
        audioAlreadyOn: boolean;
        audioOnlyRoom: boolean;
        recordStarted: boolean;
        recordResumed: boolean;
        recordPaused: boolean;
        recordStopped: boolean;
        recordingMediaOptions: string;
        islevel: string;
        youAreCoHost: boolean;
        adminRestrictSetting: boolean;
        audioRequestState: string | null;
        audioRequestTime: number;
        member: string;
        socket: Socket;
        localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>;
        roomName: string;
        userDefaultAudioInputDevice: string;
        micAction: boolean;
        localStream: MediaStream | null;
        audioSetting: string;
        videoSetting: string;
        screenshareSetting: string;
        chatSetting: string;
        permissionConfig?: PermissionConfig | null;
        updateRequestIntervalSeconds: number;
        participants: Participant[];
        mediaDevices: MediaDevices;
        transportCreated: boolean;
        transportCreatedAudio: boolean;
        supportFlexRoom?: boolean;
        supportMaxRoom?: boolean;
        updateAudioAlreadyOn: (status: boolean) => void;
        updateAudioRequestState: (state: string | null) => void;
        updateAudioPaused: (status: boolean) => void;
        updateLocalStream: (stream: MediaStream | null) => void;
        updateParticipants: (participants: Participant[]) => void;
        updateTransportCreated: (status: boolean) => void;
        updateTransportCreatedAudio: (status: boolean) => void;
        updateMicAction: (action: boolean) => void;
        showAlert?: ShowAlert;
        checkPermission: CheckPermissionType;
        streamSuccessAudio: StreamSuccessAudioType;
        disconnectSendTransportAudio: DisconnectSendTransportAudioType;
        requestPermissionAudio: RequestPermissionAudioType;
        resumeSendTransportAudio: ResumeSendTransportAudioType;
        getUpdatedAllParams: () => ClickAudioParameters;
        [key: string]: any;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: any
    Index

    Properties

    audioDecibels coHostResponsibility coHost videoParams canvasStream connectSendTransportVideo connectSendTransportScreen updateAudioLevel screenProducer localScreenProducer? screenParams updateScreenProducer updateLocalScreenProducer? videoProducer localVideoProducer? updateVideoProducer updateLocalVideoProducer? device producerTransport localProducerTransport? localTransportCreated? updateProducerTransport updateLocalProducerTransport? updateLocalTransportCreated? connectSendTransport audioProducer localAudioProducer? videoAlreadyOn lock_screen shared updateMainWindow hostLabel updateAudioProducer updateLocalAudioProducer? updateUpdateMainWindow prepopulateUserMedia allVideoStreams shareScreenStarted eventType screenId? forceFullDisplay mainScreenFilled adminOnMainScreen mainScreenPerson oldAllStreams checkOrientation screenForceFullDisplay localStreamScreen remoteScreenStream localStreamVideo mainHeightWidth isWideScreen localUIMode whiteboardStarted whiteboardEnded virtualStream keepBackground annotateScreenStream updateMainScreenPerson updateMainScreenFilled updateAdminOnMainScreen updateMainHeightWidth updateScreenForceFullDisplay updateMainGridStream isDarkModeValue? showSubtitlesOnCards? liveSubtitles? customVideoCard? customAudioCard? customMiniCard? videoCardComponent? audioCardComponent? miniCardComponent? prepopulateLocalUserMedia? audioParams localStreamAudio defAudioID params audioParamse? aParams updateAudioParams updateLocalStreamAudio updateDefAudioID updateUserDefaultAudioInputDevice createSendTransport connectSendTransportAudio checkMediaPermission hasAudioPermission audioPaused audioAlreadyOn audioOnlyRoom recordStarted recordResumed recordPaused recordStopped recordingMediaOptions islevel youAreCoHost adminRestrictSetting audioRequestState audioRequestTime member socket localSocket? roomName userDefaultAudioInputDevice micAction localStream audioSetting videoSetting screenshareSetting chatSetting permissionConfig? updateRequestIntervalSeconds participants mediaDevices transportCreated transportCreatedAudio supportFlexRoom? supportMaxRoom? updateAudioAlreadyOn updateAudioRequestState updateAudioPaused updateLocalStream updateParticipants updateTransportCreated updateTransportCreatedAudio updateMicAction showAlert? checkPermission streamSuccessAudio disconnectSendTransportAudio requestPermissionAudio resumeSendTransportAudio getUpdatedAllParams

    Properties

    audioDecibels: AudioDecibels[]
    coHostResponsibility: CoHostResponsibility[]
    coHost: string
    videoParams: ProducerOptions
    canvasStream: MediaStream | null
    connectSendTransportVideo: ConnectSendTransportVideoType
    connectSendTransportScreen: ConnectSendTransportScreenType
    updateAudioLevel: (level: number) => void
    screenProducer: Producer<AppData> | null
    localScreenProducer?: Producer<AppData> | null
    screenParams: ProducerOptions
    updateScreenProducer: (producer: Producer<AppData> | null) => void
    updateLocalScreenProducer?: (localProducer: Producer<AppData> | null) => void
    videoProducer: Producer<AppData> | null
    localVideoProducer?: Producer<AppData> | null
    updateVideoProducer: (producer: Producer<AppData> | null) => void
    updateLocalVideoProducer?: (localProducer: Producer<AppData> | null) => void
    device: Device | null
    producerTransport: Transport<AppData> | null
    localProducerTransport?: Transport<AppData> | null
    localTransportCreated?: boolean
    updateProducerTransport: (producerTransport: Transport<AppData> | null) => void
    updateLocalProducerTransport?: (
        localTransport: Transport<AppData> | null,
    ) => void
    updateLocalTransportCreated?: (localTransportCreated: boolean) => void
    connectSendTransport: ConnectSendTransportType
    audioProducer: Producer<AppData> | null
    localAudioProducer?: Producer<AppData> | null
    videoAlreadyOn: boolean
    lock_screen: boolean
    shared: boolean
    updateMainWindow: boolean
    hostLabel: string
    updateAudioProducer: (audioProducer: Producer<AppData> | null) => void
    updateLocalAudioProducer?: (
        localAudioProducer: Producer<AppData> | null,
    ) => void
    updateUpdateMainWindow: (updateMainWindow: boolean) => void
    prepopulateUserMedia: PrepopulateUserMediaType
    allVideoStreams: (Stream | Participant)[]
    shareScreenStarted: boolean
    eventType: EventType
    screenId?: string
    forceFullDisplay: boolean
    mainScreenFilled: boolean
    adminOnMainScreen: boolean
    mainScreenPerson: string
    oldAllStreams: (Stream | Participant)[]
    checkOrientation: () => string
    screenForceFullDisplay: boolean
    localStreamScreen: MediaStream | null
    remoteScreenStream: Stream[]
    localStreamVideo: MediaStream | null
    mainHeightWidth: number
    isWideScreen: boolean
    localUIMode: boolean
    whiteboardStarted: boolean
    whiteboardEnded: boolean
    virtualStream: MediaStream | null
    keepBackground: boolean
    annotateScreenStream: boolean
    updateMainScreenPerson: (person: string) => void
    updateMainScreenFilled: (filled: boolean) => void
    updateAdminOnMainScreen: (admin: boolean) => void
    updateMainHeightWidth: (heightWidth: number) => void
    updateScreenForceFullDisplay: (force: boolean) => void
    updateMainGridStream: (components: Element[]) => void
    isDarkModeValue?: boolean
    showSubtitlesOnCards?: boolean
    liveSubtitles?: Map<string, LiveSubtitle>
    customVideoCard?: CustomVideoCardType
    customAudioCard?: CustomAudioCardType
    customMiniCard?: CustomMiniCardType
    videoCardComponent?: ComponentType<VideoCardOptions>
    audioCardComponent?: ComponentType<AudioCardOptions>
    miniCardComponent?: ComponentType<MiniCardOptions>
    prepopulateLocalUserMedia?: PrepopulateUserMediaType
    audioParams: ProducerOptions
    localStreamAudio: MediaStream | null
    defAudioID: string
    params: ProducerOptions
    audioParamse?: ProducerOptions
    aParams: ProducerOptions
    updateAudioParams: (audioParams: ProducerOptions) => void
    updateLocalStreamAudio: (localStreamAudio: MediaStream | null) => void
    updateDefAudioID: (defAudioID: string) => void
    updateUserDefaultAudioInputDevice: (userDefaultAudioInputDevice: string) => void
    createSendTransport: CreateSendTransportType
    connectSendTransportAudio: ConnectSendTransportAudioType
    checkMediaPermission: boolean
    hasAudioPermission: boolean
    audioPaused: boolean
    audioAlreadyOn: boolean
    audioOnlyRoom: boolean
    recordStarted: boolean
    recordResumed: boolean
    recordPaused: boolean
    recordStopped: boolean
    recordingMediaOptions: string
    islevel: string
    youAreCoHost: boolean
    adminRestrictSetting: boolean
    audioRequestState: string | null
    audioRequestTime: number
    member: string
    socket: Socket
    localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>
    roomName: string
    userDefaultAudioInputDevice: string
    micAction: boolean
    localStream: MediaStream | null
    audioSetting: string
    videoSetting: string
    screenshareSetting: string
    chatSetting: string
    permissionConfig?: PermissionConfig | null
    updateRequestIntervalSeconds: number
    participants: Participant[]
    mediaDevices: MediaDevices
    transportCreated: boolean
    transportCreatedAudio: boolean
    supportFlexRoom?: boolean
    supportMaxRoom?: boolean
    updateAudioAlreadyOn: (status: boolean) => void
    updateAudioRequestState: (state: string | null) => void
    updateAudioPaused: (status: boolean) => void
    updateLocalStream: (stream: MediaStream | null) => void
    updateParticipants: (participants: Participant[]) => void
    updateTransportCreated: (status: boolean) => void
    updateTransportCreatedAudio: (status: boolean) => void
    updateMicAction: (action: boolean) => void
    showAlert?: ShowAlert
    checkPermission: CheckPermissionType
    streamSuccessAudio: StreamSuccessAudioType
    disconnectSendTransportAudio: DisconnectSendTransportAudioType
    requestPermissionAudio: RequestPermissionAudioType
    resumeSendTransportAudio: ResumeSendTransportAudioType
    getUpdatedAllParams: () => ClickAudioParameters