Interface ConsumerResumeParameters

interface ConsumerResumeParameters {
    nStream: null | MediaStream;
    allAudioStreams: (Participant | Stream)[];
    streamNames: Stream[];
    audStreamNames: Stream[];
    updateMainWindow: boolean;
    meetingDisplayType: string;
    mainScreenFilled: boolean;
    first_round: boolean;
    lock_screen: boolean;
    audioOnlyStreams: RenderableComponent<Record<string, unknown>>[];
    gotAllVids: boolean;
    defer_receive: boolean;
    firstAll: boolean;
    remoteScreenStream: Stream[];
    hostLabel: string;
    whiteboardStarted: boolean;
    whiteboardEnded: boolean;
    participants: Participant[];
    eventType: EventType;
    member: string;
    shareScreenStarted: boolean;
    shared: boolean;
    screenId?: string;
    updateUpdateMainWindow: ((value: boolean) => void);
    updateAllAudioStreams: ((streams: (Participant | Stream)[]) => void);
    updateAllVideoStreams: ((streams: (Participant | Stream)[]) => void);
    updateStreamNames: ((streams: Stream[]) => void);
    updateAudStreamNames: ((streams: Stream[]) => void);
    updateNStream: ((stream: null | MediaStream) => void);
    updateMainHeightWidth: ((value: number) => void);
    updateLock_screen: ((value: boolean) => void);
    updateFirstAll: ((value: boolean) => void);
    updateRemoteScreenStream: ((streams: Stream[]) => void);
    updateOldAllStreams: ((streams: (Participant | Stream)[]) => void);
    updateAudioOnlyStreams: ((components: RenderableComponent<Record<string, unknown>>[]) => void);
    updateShareScreenStarted: ((value: boolean) => void);
    updateGotAllVids: ((value: boolean) => void);
    updateScreenId: ((value: string) => void);
    updateDefer_receive: ((value: boolean) => void);
    reorderStreams: ((options: ReorderStreamsOptions) => Promise<void>);
    prepopulateUserMedia: PrepopulateUserMediaType;
    miniAudioComponent?: any;
    miniAudioPlayerComponent?: any;
    getUpdatedAllParams: (() => ConsumerResumeParameters);
    allVideoStreams: (Participant | Stream)[];
    islevel: string;
    forceFullDisplay: boolean;
    adminOnMainScreen: boolean;
    mainScreenPerson: string;
    videoAlreadyOn: boolean;
    audioAlreadyOn: boolean;
    oldAllStreams: (Participant | Stream)[];
    checkOrientation: (() => string);
    screenForceFullDisplay: boolean;
    localStreamScreen: null | MediaStream;
    localStreamVideo: null | MediaStream;
    mainHeightWidth: number;
    isWideScreen: boolean;
    localUIMode: boolean;
    virtualStream: null | MediaStream;
    keepBackground: boolean;
    annotateScreenStream: boolean;
    updateMainScreenPerson: ((person: string) => void);
    updateMainScreenFilled: ((filled: boolean) => void);
    updateAdminOnMainScreen: ((admin: boolean) => void);
    updateScreenForceFullDisplay: ((force: boolean) => void);
    updateMainGridStream: ((components: RenderableComponent<Record<string, unknown>>[]) => void);
    customVideoCard?: unknown;
    customAudioCard?: unknown;
    customMiniCard?: unknown;
    videoCardComponent?: any;
    audioCardComponent?: any;
    miniCardComponent?: any;
}

Hierarchy (view full)

Properties

nStream allAudioStreams streamNames audStreamNames updateMainWindow meetingDisplayType mainScreenFilled first_round lock_screen audioOnlyStreams gotAllVids defer_receive firstAll remoteScreenStream hostLabel whiteboardStarted whiteboardEnded participants eventType member shareScreenStarted shared screenId? updateUpdateMainWindow updateAllAudioStreams updateAllVideoStreams updateStreamNames updateAudStreamNames updateNStream updateMainHeightWidth updateLock_screen updateFirstAll updateRemoteScreenStream updateOldAllStreams updateAudioOnlyStreams updateShareScreenStarted updateGotAllVids updateScreenId updateDefer_receive reorderStreams prepopulateUserMedia miniAudioComponent? miniAudioPlayerComponent? getUpdatedAllParams allVideoStreams islevel forceFullDisplay adminOnMainScreen mainScreenPerson videoAlreadyOn audioAlreadyOn oldAllStreams checkOrientation screenForceFullDisplay localStreamScreen localStreamVideo mainHeightWidth isWideScreen localUIMode virtualStream keepBackground annotateScreenStream updateMainScreenPerson updateMainScreenFilled updateAdminOnMainScreen updateScreenForceFullDisplay updateMainGridStream customVideoCard? customAudioCard? customMiniCard? videoCardComponent? audioCardComponent? miniCardComponent?

Properties

nStream

nStream: null | MediaStream

allAudioStreams

allAudioStreams: (Participant | Stream)[]

streamNames

streamNames: Stream[]

audStreamNames

audStreamNames: Stream[]

updateMainWindow

updateMainWindow: boolean

meetingDisplayType

meetingDisplayType: string

mainScreenFilled

mainScreenFilled: boolean

first_round

first_round: boolean

lock_screen

lock_screen: boolean

audioOnlyStreams

audioOnlyStreams: RenderableComponent<Record<string, unknown>>[]

gotAllVids

gotAllVids: boolean

defer_receive

defer_receive: boolean

firstAll

firstAll: boolean

remoteScreenStream

remoteScreenStream: Stream[]

hostLabel

hostLabel: string

whiteboardStarted

whiteboardStarted: boolean

whiteboardEnded

whiteboardEnded: boolean

participants

participants: Participant[]

eventType

eventType: EventType

member

member: string

shareScreenStarted

shareScreenStarted: boolean

shared

shared: boolean

OptionalscreenId

screenId?: string

updateUpdateMainWindow

updateUpdateMainWindow: ((value: boolean) => void)

updateAllAudioStreams

updateAllAudioStreams: ((streams: (Participant | Stream)[]) => void)

updateAllVideoStreams

updateAllVideoStreams: ((streams: (Participant | Stream)[]) => void)

updateStreamNames

updateStreamNames: ((streams: Stream[]) => void)

updateAudStreamNames

updateAudStreamNames: ((streams: Stream[]) => void)

updateNStream

updateNStream: ((stream: null | MediaStream) => void)

updateMainHeightWidth

updateMainHeightWidth: ((value: number) => void)

updateLock_screen

updateLock_screen: ((value: boolean) => void)

updateFirstAll

updateFirstAll: ((value: boolean) => void)

updateRemoteScreenStream

updateRemoteScreenStream: ((streams: Stream[]) => void)

updateOldAllStreams

updateOldAllStreams: ((streams: (Participant | Stream)[]) => void)

updateAudioOnlyStreams

updateAudioOnlyStreams: ((components: RenderableComponent<Record<string, unknown>>[]) => void)

updateShareScreenStarted

updateShareScreenStarted: ((value: boolean) => void)

updateGotAllVids

updateGotAllVids: ((value: boolean) => void)

updateScreenId

updateScreenId: ((value: string) => void)

updateDefer_receive

updateDefer_receive: ((value: boolean) => void)

reorderStreams

reorderStreams: ((options: ReorderStreamsOptions) => Promise<void>)

prepopulateUserMedia

prepopulateUserMedia: PrepopulateUserMediaType

OptionalminiAudioComponent

miniAudioComponent?: any

OptionalminiAudioPlayerComponent

miniAudioPlayerComponent?: any

getUpdatedAllParams

getUpdatedAllParams: (() => ConsumerResumeParameters)

allVideoStreams

allVideoStreams: (Participant | Stream)[]

islevel

islevel: string

forceFullDisplay

forceFullDisplay: boolean

adminOnMainScreen

adminOnMainScreen: boolean

mainScreenPerson

mainScreenPerson: string

videoAlreadyOn

videoAlreadyOn: boolean

audioAlreadyOn

audioAlreadyOn: boolean

oldAllStreams

oldAllStreams: (Participant | Stream)[]

checkOrientation

checkOrientation: (() => string)

screenForceFullDisplay

screenForceFullDisplay: boolean

localStreamScreen

localStreamScreen: null | MediaStream

localStreamVideo

localStreamVideo: null | MediaStream

mainHeightWidth

mainHeightWidth: number

isWideScreen

isWideScreen: boolean

localUIMode

localUIMode: boolean

virtualStream

virtualStream: null | MediaStream

keepBackground

keepBackground: boolean

annotateScreenStream

annotateScreenStream: boolean

updateMainScreenPerson

updateMainScreenPerson: ((person: string) => void)

updateMainScreenFilled

updateMainScreenFilled: ((filled: boolean) => void)

updateAdminOnMainScreen

updateAdminOnMainScreen: ((admin: boolean) => void)

updateScreenForceFullDisplay

updateScreenForceFullDisplay: ((force: boolean) => void)

updateMainGridStream

updateMainGridStream: ((components: RenderableComponent<Record<string, unknown>>[]) => void)

OptionalcustomVideoCard

customVideoCard?: unknown

OptionalcustomAudioCard

customAudioCard?: unknown

OptionalcustomMiniCard

customMiniCard?: unknown

OptionalvideoCardComponent

videoCardComponent?: any

OptionalaudioCardComponent

audioCardComponent?: any

OptionalminiCardComponent

miniCardComponent?: any

Settings

Member Visibility

On This Page

Properties
nStreamallAudioStreamsstreamNamesaudStreamNamesupdateMainWindowmeetingDisplayTypemainScreenFilledfirst_roundlock_screenaudioOnlyStreamsgotAllVidsdefer_receivefirstAllremoteScreenStreamhostLabelwhiteboardStartedwhiteboardEndedparticipantseventTypemembershareScreenStartedsharedscreenIdupdateUpdateMainWindowupdateAllAudioStreamsupdateAllVideoStreamsupdateStreamNamesupdateAudStreamNamesupdateNStreamupdateMainHeightWidthupdateLock_screenupdateFirstAllupdateRemoteScreenStreamupdateOldAllStreamsupdateAudioOnlyStreamsupdateShareScreenStartedupdateGotAllVidsupdateScreenIdupdateDefer_receivereorderStreamsprepopulateUserMediaminiAudioComponentminiAudioPlayerComponentgetUpdatedAllParamsallVideoStreamsislevelforceFullDisplayadminOnMainScreenmainScreenPersonvideoAlreadyOnaudioAlreadyOnoldAllStreamscheckOrientationscreenForceFullDisplaylocalStreamScreenlocalStreamVideomainHeightWidthisWideScreenlocalUIModevirtualStreamkeepBackgroundannotateScreenStreamupdateMainScreenPersonupdateMainScreenFilledupdateAdminOnMainScreenupdateScreenForceFullDisplayupdateMainGridStreamcustomVideoCardcustomAudioCardcustomMiniCardvideoCardComponentaudioCardComponentminiCardComponent