Interface RealtimeControllerFacade
interface RealtimeControllerFacade { transcriptionController?: TranscriptionController; realtimeCanUnmuteLocalAudio(): boolean; realtimeIsLocalAudioMuted(): boolean; realtimeMuteLocalAudio(): void; realtimeSendDataMessage( topic: string, data: any, lifetimeMs?: number, ): void; realtimeSetCanUnmuteLocalAudio(canUnmute: boolean): void; realtimeSubscribeToAttendeeIdPresence( callback: ( attendeeId: string, present: boolean, externalUserId?: string, dropped?: boolean, posInFrame?: RealtimeAttendeePositionInFrame, ) => void, ): void; realtimeSubscribeToFatalError(callback: (error: Error) => void): void; realtimeSubscribeToLocalSignalStrengthChange( callback: (signalStrength: number) => void, ): void; realtimeSubscribeToMuteAndUnmuteLocalAudio( callback: (muted: boolean) => void, ): void; realtimeSubscribeToReceiveDataMessage( topic: string, callback: (dataMessage: DataMessage) => void, ): void; realtimeSubscribeToSetCanUnmuteLocalAudio( callback: (canUnmute: boolean) => void, ): void; realtimeSubscribeToVolumeIndicator( attendeeId: string, callback: VolumeIndicatorCallback, ): void; realtimeUnmuteLocalAudio(): boolean; realtimeUnsubscribeFromReceiveDataMessage(topic: string): void; realtimeUnsubscribeFromVolumeIndicator( attendeeId: string, callback?: VolumeIndicatorCallback, ): void; realtimeUnsubscribeToAttendeeIdPresence( callback: ( attendeeId: string, present: boolean, externalUserId?: string, dropped?: boolean, posInFrame?: RealtimeAttendeePositionInFrame, ) => void, ): void; realtimeUnsubscribeToFatalError(callback: (error: Error) => void): void; realtimeUnsubscribeToLocalSignalStrengthChange( callback: (signalStrength: number) => void, ): void; realtimeUnsubscribeToMuteAndUnmuteLocalAudio( callback: (muted: boolean) => void, ): void; realtimeUnsubscribeToSetCanUnmuteLocalAudio( callback: (canUnmute: boolean) => void, ): void;} Properties
Optional ReadonlytranscriptionController
Methods
realtimeCanUnmuteLocalAudio
realtimeCanUnmuteLocalAudio(): boolean
realtimeIsLocalAudioMuted
realtimeIsLocalAudioMuted(): boolean
realtimeMuteLocalAudio
realtimeMuteLocalAudio(): void
realtimeSendDataMessage
realtimeSendDataMessage(topic: string, data: any, lifetimeMs?: number): void Parameters
- topic: string
- data: any
OptionallifetimeMs: number
Returns void
realtimeSetCanUnmuteLocalAudio
realtimeSetCanUnmuteLocalAudio(canUnmute: boolean): void
realtimeSubscribeToAttendeeIdPresence
realtimeSubscribeToAttendeeIdPresence( callback: ( attendeeId: string, present: boolean, externalUserId?: string, dropped?: boolean, posInFrame?: RealtimeAttendeePositionInFrame, ) => void,): void
realtimeSubscribeToFatalError
realtimeSubscribeToFatalError(callback: (error: Error) => void): void Parameters
- callback: (error: Error) => void
Returns void
realtimeSubscribeToLocalSignalStrengthChange
realtimeSubscribeToLocalSignalStrengthChange( callback: (signalStrength: number) => void,): void Parameters
- callback: (signalStrength: number) => void
Returns void
realtimeSubscribeToMuteAndUnmuteLocalAudio
realtimeSubscribeToMuteAndUnmuteLocalAudio( callback: (muted: boolean) => void,): void Parameters
- callback: (muted: boolean) => void
Returns void
realtimeSubscribeToReceiveDataMessage
realtimeSubscribeToReceiveDataMessage( topic: string, callback: (dataMessage: DataMessage) => void,): void Parameters
- topic: string
- callback: (dataMessage: DataMessage) => void
Returns void
realtimeSubscribeToSetCanUnmuteLocalAudio
realtimeSubscribeToSetCanUnmuteLocalAudio( callback: (canUnmute: boolean) => void,): void Parameters
- callback: (canUnmute: boolean) => void
Returns void
realtimeSubscribeToVolumeIndicator
realtimeUnmuteLocalAudio
realtimeUnmuteLocalAudio(): boolean
realtimeUnsubscribeFromReceiveDataMessage
realtimeUnsubscribeFromReceiveDataMessage(topic: string): void
realtimeUnsubscribeFromVolumeIndicator
realtimeUnsubscribeToAttendeeIdPresence
realtimeUnsubscribeToAttendeeIdPresence( callback: ( attendeeId: string, present: boolean, externalUserId?: string, dropped?: boolean, posInFrame?: RealtimeAttendeePositionInFrame, ) => void,): void
realtimeUnsubscribeToFatalError
realtimeUnsubscribeToFatalError(callback: (error: Error) => void): void Parameters
- callback: (error: Error) => void
Returns void
realtimeUnsubscribeToLocalSignalStrengthChange
realtimeUnsubscribeToLocalSignalStrengthChange( callback: (signalStrength: number) => void,): void Parameters
- callback: (signalStrength: number) => void
Returns void
realtimeUnsubscribeToMuteAndUnmuteLocalAudio
realtimeUnsubscribeToMuteAndUnmuteLocalAudio( callback: (muted: boolean) => void,): void Parameters
- callback: (muted: boolean) => void
Returns void
realtimeUnsubscribeToSetCanUnmuteLocalAudio
realtimeUnsubscribeToSetCanUnmuteLocalAudio( callback: (canUnmute: boolean) => void,): void Parameters
- callback: (canUnmute: boolean) => void
Returns void