Interface StreamSuccessAudioParameters

Interface defining the parameters required by the AudioCard component.

These parameters provide the context and state needed for audio display, participant management, and media controls.

AudioCardParameters

interface StreamSuccessAudioParameters {
    audioDecibels: AudioDecibels[];
    coHostResponsibility: CoHostResponsibility[];
    roomName: string;
    coHost: string;
    videoParams: ProducerOptions;
    localStreamScreen: MediaStream;
    canvasStream: MediaStream;
    whiteboardStarted: boolean;
    whiteboardEnded: boolean;
    connectSendTransportVideo: ConnectSendTransportVideoType;
    connectSendTransportScreen: ConnectSendTransportScreenType;
    audioProducer: Producer<AppData>;
    localAudioProducer?: Producer<AppData>;
    updateAudioProducer: ((producer: Producer<AppData>) => void);
    updateLocalAudioProducer?: ((localProducer: Producer<AppData>) => void);
    updateAudioLevel: ((level: number) => void);
    screenProducer: Producer<AppData>;
    localScreenProducer?: Producer<AppData>;
    screenParams: ProducerOptions;
    updateScreenProducer: ((producer: Producer<AppData>) => void);
    updateLocalScreenProducer?: ((localProducer: Producer<AppData>) => void);
    videoProducer: Producer<AppData>;
    localVideoProducer?: Producer<AppData>;
    updateVideoProducer: ((producer: Producer<AppData>) => void);
    updateLocalVideoProducer?: ((localProducer: Producer<AppData>) => void);
    localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>;
    device: Device;
    producerTransport: Transport<AppData>;
    localProducerTransport?: Transport<AppData>;
    localTransportCreated?: boolean;
    updateProducerTransport: ((producerTransport: Transport<AppData>) => void);
    updateLocalProducerTransport?: ((localTransport: Transport<AppData>) => void);
    updateLocalTransportCreated?: ((localTransportCreated: boolean) => void);
    connectSendTransport: ConnectSendTransportType;
    allVideoStreams: (Stream | Participant)[];
    shareScreenStarted: boolean;
    eventType: EventType;
    screenId?: string;
    forceFullDisplay: boolean;
    mainScreenFilled: boolean;
    adminOnMainScreen: boolean;
    mainScreenPerson: string;
    oldAllStreams: (Stream | Participant)[];
    checkOrientation: (() => string);
    screenForceFullDisplay: boolean;
    remoteScreenStream: Stream[];
    localStreamVideo: MediaStream;
    mainHeightWidth: number;
    isWideScreen: boolean;
    localUIMode: boolean;
    virtualStream: MediaStream;
    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);
    customVideoCard?: CustomVideoCardType;
    customAudioCard?: CustomAudioCardType;
    customMiniCard?: CustomMiniCardType;
    videoCardComponent?: ComponentType<VideoCardOptions>;
    audioCardComponent?: ComponentType<AudioCardOptions>;
    miniCardComponent?: ComponentType<MiniCardOptions>;
    prepopulateLocalUserMedia?: PrepopulateUserMediaType;
    socket: Socket<DefaultEventsMap, DefaultEventsMap>;
    participants: Participant[];
    localStream: MediaStream;
    transportCreated: boolean;
    transportCreatedAudio: boolean;
    audioAlreadyOn: boolean;
    micAction: boolean;
    audioParams: ProducerOptions;
    localStreamAudio: MediaStream;
    defAudioID: string;
    userDefaultAudioInputDevice: string;
    params: ProducerOptions;
    audioParamse?: ProducerOptions;
    aParams: ProducerOptions;
    hostLabel: string;
    islevel: string;
    member: string;
    updateMainWindow: boolean;
    lock_screen: boolean;
    shared: boolean;
    videoAlreadyOn: boolean;
    showAlert?: ShowAlert;
    updateParticipants: ((participants: Participant[]) => void);
    updateTransportCreated: ((transportCreated: boolean) => void);
    updateTransportCreatedAudio: ((transportCreatedAudio: boolean) => void);
    updateAudioAlreadyOn: ((audioAlreadyOn: boolean) => void);
    updateMicAction: ((micAction: boolean) => void);
    updateAudioParams: ((audioParams: ProducerOptions) => void);
    updateLocalStream: ((localStream: MediaStream) => void);
    updateLocalStreamAudio: ((localStreamAudio: MediaStream) => void);
    updateDefAudioID: ((defAudioID: string) => void);
    updateUserDefaultAudioInputDevice: ((userDefaultAudioInputDevice: string) => void);
    updateUpdateMainWindow: ((updateMainWindow: boolean) => void);
    createSendTransport: CreateSendTransportType;
    connectSendTransportAudio: ConnectSendTransportAudioType;
    resumeSendTransportAudio: ResumeSendTransportAudioType;
    prepopulateUserMedia: PrepopulateUserMediaType;
    getUpdatedAllParams: (() => StreamSuccessAudioParameters);
    [key: string]: any;
}

Hierarchy (view full)

Indexable

  • [key: string]: any

Properties

audioDecibels coHostResponsibility roomName coHost videoParams localStreamScreen canvasStream whiteboardStarted whiteboardEnded connectSendTransportVideo connectSendTransportScreen audioProducer localAudioProducer? updateAudioProducer updateLocalAudioProducer? updateAudioLevel screenProducer localScreenProducer? screenParams updateScreenProducer updateLocalScreenProducer? videoProducer localVideoProducer? updateVideoProducer updateLocalVideoProducer? localSocket? device producerTransport localProducerTransport? localTransportCreated? updateProducerTransport updateLocalProducerTransport? updateLocalTransportCreated? connectSendTransport allVideoStreams shareScreenStarted eventType screenId? forceFullDisplay mainScreenFilled adminOnMainScreen mainScreenPerson oldAllStreams checkOrientation screenForceFullDisplay remoteScreenStream localStreamVideo mainHeightWidth isWideScreen localUIMode virtualStream keepBackground annotateScreenStream updateMainScreenPerson updateMainScreenFilled updateAdminOnMainScreen updateMainHeightWidth updateScreenForceFullDisplay updateMainGridStream customVideoCard? customAudioCard? customMiniCard? videoCardComponent? audioCardComponent? miniCardComponent? prepopulateLocalUserMedia? socket participants localStream transportCreated transportCreatedAudio audioAlreadyOn micAction audioParams localStreamAudio defAudioID userDefaultAudioInputDevice params audioParamse? aParams hostLabel islevel member updateMainWindow lock_screen shared videoAlreadyOn showAlert? updateParticipants updateTransportCreated updateTransportCreatedAudio updateAudioAlreadyOn updateMicAction updateAudioParams updateLocalStream updateLocalStreamAudio updateDefAudioID updateUserDefaultAudioInputDevice updateUpdateMainWindow createSendTransport connectSendTransportAudio resumeSendTransportAudio prepopulateUserMedia getUpdatedAllParams

Properties

audioDecibels

audioDecibels: AudioDecibels[]

Array of audio level data for all participants (used for waveform visualization)

coHostResponsibility

coHostResponsibility: CoHostResponsibility[]

Array of responsibilities assigned to co-hosts

roomName

roomName: string

Name/ID of the current room session

coHost

coHost: string

User ID of the co-host

videoParams

videoParams: ProducerOptions

localStreamScreen

localStreamScreen: MediaStream

canvasStream

canvasStream: MediaStream

whiteboardStarted

whiteboardStarted: boolean

whiteboardEnded

whiteboardEnded: boolean

connectSendTransportVideo

connectSendTransportVideo: ConnectSendTransportVideoType

connectSendTransportScreen

connectSendTransportScreen: ConnectSendTransportScreenType

audioProducer

audioProducer: Producer<AppData>

OptionallocalAudioProducer

localAudioProducer?: Producer<AppData>

updateAudioProducer

updateAudioProducer: ((producer: Producer<AppData>) => void)

OptionalupdateLocalAudioProducer

updateLocalAudioProducer?: ((localProducer: Producer<AppData>) => void)

updateAudioLevel

updateAudioLevel: ((level: number) => void)

screenProducer

screenProducer: Producer<AppData>

OptionallocalScreenProducer

localScreenProducer?: Producer<AppData>

screenParams

screenParams: ProducerOptions

updateScreenProducer

updateScreenProducer: ((producer: Producer<AppData>) => void)

OptionalupdateLocalScreenProducer

updateLocalScreenProducer?: ((localProducer: Producer<AppData>) => void)

videoProducer

videoProducer: Producer<AppData>

OptionallocalVideoProducer

localVideoProducer?: Producer<AppData>

updateVideoProducer

updateVideoProducer: ((producer: Producer<AppData>) => void)

OptionalupdateLocalVideoProducer

updateLocalVideoProducer?: ((localProducer: Producer<AppData>) => void)

OptionallocalSocket

localSocket?: Socket<DefaultEventsMap, DefaultEventsMap>

device

device: Device

producerTransport

producerTransport: Transport<AppData>

OptionallocalProducerTransport

localProducerTransport?: Transport<AppData>

OptionallocalTransportCreated

localTransportCreated?: boolean

updateProducerTransport

updateProducerTransport: ((producerTransport: Transport<AppData>) => void)

OptionalupdateLocalProducerTransport

updateLocalProducerTransport?: ((localTransport: Transport<AppData>) => void)

OptionalupdateLocalTransportCreated

updateLocalTransportCreated?: ((localTransportCreated: boolean) => void)

connectSendTransport

connectSendTransport: ConnectSendTransportType

allVideoStreams

allVideoStreams: (Stream | Participant)[]

shareScreenStarted

shareScreenStarted: boolean

eventType

eventType: EventType

Type of event ('conference', 'webinar', 'broadcast', etc.)

OptionalscreenId

screenId?: string

forceFullDisplay

forceFullDisplay: boolean

mainScreenFilled

mainScreenFilled: boolean

adminOnMainScreen

adminOnMainScreen: boolean

mainScreenPerson

mainScreenPerson: string

oldAllStreams

oldAllStreams: (Stream | Participant)[]

checkOrientation

checkOrientation: (() => string)

screenForceFullDisplay

screenForceFullDisplay: boolean

remoteScreenStream

remoteScreenStream: Stream[]

localStreamVideo

localStreamVideo: MediaStream

mainHeightWidth

mainHeightWidth: number

isWideScreen

isWideScreen: boolean

localUIMode

localUIMode: boolean

virtualStream

virtualStream: MediaStream

keepBackground

keepBackground: boolean

annotateScreenStream

annotateScreenStream: boolean

updateMainScreenPerson

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

updateMainScreenFilled

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

updateAdminOnMainScreen

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

updateMainHeightWidth

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

updateScreenForceFullDisplay

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

updateMainGridStream

updateMainGridStream: ((components: Element[]) => void)

OptionalcustomVideoCard

customVideoCard?: CustomVideoCardType

OptionalcustomAudioCard

customAudioCard?: CustomAudioCardType

OptionalcustomMiniCard

customMiniCard?: CustomMiniCardType

OptionalvideoCardComponent

videoCardComponent?: ComponentType<VideoCardOptions>

OptionalaudioCardComponent

audioCardComponent?: ComponentType<AudioCardOptions>

OptionalminiCardComponent

miniCardComponent?: ComponentType<MiniCardOptions>

OptionalprepopulateLocalUserMedia

prepopulateLocalUserMedia?: PrepopulateUserMediaType

socket

socket: Socket<DefaultEventsMap, DefaultEventsMap>

Socket.io client instance for real-time communication

participants

participants: Participant[]

Array of all participants in the session

localStream

localStream: MediaStream

transportCreated

transportCreated: boolean

transportCreatedAudio

transportCreatedAudio: boolean

audioAlreadyOn

audioAlreadyOn: boolean

micAction

micAction: boolean

audioParams

audioParams: ProducerOptions

localStreamAudio

localStreamAudio: MediaStream

defAudioID

defAudioID: string

userDefaultAudioInputDevice

userDefaultAudioInputDevice: string

params

params: ProducerOptions

OptionalaudioParamse

audioParamse?: ProducerOptions

aParams

aParams: ProducerOptions

hostLabel

hostLabel: string

islevel

islevel: string

Current user's level/role (e.g., '0', '1', '2')

member

member: string

Current user's member ID

updateMainWindow

updateMainWindow: boolean

lock_screen

lock_screen: boolean

shared

shared: boolean

videoAlreadyOn

videoAlreadyOn: boolean

OptionalshowAlert

showAlert?: ShowAlert

Optional function to display alerts/notifications

updateParticipants

updateParticipants: ((participants: Participant[]) => void)

updateTransportCreated

updateTransportCreated: ((transportCreated: boolean) => void)

updateTransportCreatedAudio

updateTransportCreatedAudio: ((transportCreatedAudio: boolean) => void)

updateAudioAlreadyOn

updateAudioAlreadyOn: ((audioAlreadyOn: boolean) => void)

updateMicAction

updateMicAction: ((micAction: boolean) => void)

updateAudioParams

updateAudioParams: ((audioParams: ProducerOptions) => void)

updateLocalStream

updateLocalStream: ((localStream: MediaStream) => void)

updateLocalStreamAudio

updateLocalStreamAudio: ((localStreamAudio: MediaStream) => void)

updateDefAudioID

updateDefAudioID: ((defAudioID: string) => void)

updateUserDefaultAudioInputDevice

updateUserDefaultAudioInputDevice: ((userDefaultAudioInputDevice: string) => void)

updateUpdateMainWindow

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

createSendTransport

createSendTransport: CreateSendTransportType

connectSendTransportAudio

connectSendTransportAudio: ConnectSendTransportAudioType

resumeSendTransportAudio

resumeSendTransportAudio: ResumeSendTransportAudioType

prepopulateUserMedia

prepopulateUserMedia: PrepopulateUserMediaType

getUpdatedAllParams

getUpdatedAllParams: (() => StreamSuccessAudioParameters)

Function to retrieve latest parameter state

Settings

Member Visibility

On This Page

Properties
audioDecibelscoHostResponsibilityroomNamecoHostvideoParamslocalStreamScreencanvasStreamwhiteboardStartedwhiteboardEndedconnectSendTransportVideoconnectSendTransportScreenaudioProducerlocalAudioProducerupdateAudioProducerupdateLocalAudioProducerupdateAudioLevelscreenProducerlocalScreenProducerscreenParamsupdateScreenProducerupdateLocalScreenProducervideoProducerlocalVideoProducerupdateVideoProducerupdateLocalVideoProducerlocalSocketdeviceproducerTransportlocalProducerTransportlocalTransportCreatedupdateProducerTransportupdateLocalProducerTransportupdateLocalTransportCreatedconnectSendTransportallVideoStreamsshareScreenStartedeventTypescreenIdforceFullDisplaymainScreenFilledadminOnMainScreenmainScreenPersonoldAllStreamscheckOrientationscreenForceFullDisplayremoteScreenStreamlocalStreamVideomainHeightWidthisWideScreenlocalUIModevirtualStreamkeepBackgroundannotateScreenStreamupdateMainScreenPersonupdateMainScreenFilledupdateAdminOnMainScreenupdateMainHeightWidthupdateScreenForceFullDisplayupdateMainGridStreamcustomVideoCardcustomAudioCardcustomMiniCardvideoCardComponentaudioCardComponentminiCardComponentprepopulateLocalUserMediasocketparticipantslocalStreamtransportCreatedtransportCreatedAudioaudioAlreadyOnmicActionaudioParamslocalStreamAudiodefAudioIDuserDefaultAudioInputDeviceparamsaudioParamseaParamshostLabelislevelmemberupdateMainWindowlock_screensharedvideoAlreadyOnshowAlertupdateParticipantsupdateTransportCreatedupdateTransportCreatedAudioupdateAudioAlreadyOnupdateMicActionupdateAudioParamsupdateLocalStreamupdateLocalStreamAudioupdateDefAudioIDupdateUserDefaultAudioInputDeviceupdateUpdateMainWindowcreateSendTransportconnectSendTransportAudioresumeSendTransportAudioprepopulateUserMediagetUpdatedAllParams