AudioVideoFacade | amazon-chime-sdk-js

Inherited from DeviceController.chooseAudioInputDevice
- Defined in src/devicecontroller/DeviceController.ts:64
Selects an audio input device to use. The constraint may be a device id, MediaTrackConstraint, MediaStream (containing audio track), or null to indicate no device. The promise always resolves with a DevicePermission result indicating whether access was granted or denied.

Parameters
- device: Device
Returns Promise<DevicePermission>

chooseAudioOutputDevice

chooseAudioOutputDevice(deviceId: string | null): Promise<void>

Inherited from DeviceController.chooseAudioOutputDevice
- Defined in src/devicecontroller/DeviceController.ts:77
Selects an audio output device for use. Null specifies the default device.

Parameters
- deviceId: string | null
Returns Promise<void>

chooseVideoInputDevice

chooseVideoInputDevice(device: Device): Promise<DevicePermission>

Inherited from DeviceController.chooseVideoInputDevice
- Defined in src/devicecontroller/DeviceController.ts:72
Selects an video input device to use. The constraint may be a device id, MediaTrackConstraint, MediaStream (containing video track), or null to indicate no device. The promise always resolves with a DevicePermission result indicating whether access was granted or denied.

Parameters
- device: Device
Returns Promise<DevicePermission>

chooseVideoInputQuality

chooseVideoInputQuality(width: number, height: number, frameRate: number, maxBandwidthKbps: number): void

Inherited from DeviceController.chooseVideoInputQuality
- Defined in src/devicecontroller/DeviceController.ts:128
Sets the video input quality parameters to request when enabling video. These settings take effect the next time a video input device is chosen. The default is 960x540 @ 15 fps with a max bandwidth of 1400 kbps.

Parameters
- width: number
- height: number
- frameRate: number
- maxBandwidthKbps: number
Returns void

createAnalyserNodeForAudioInput

createAnalyserNodeForAudioInput(): AnalyserNode | null

Inherited from DeviceController.createAnalyserNodeForAudioInput
- Defined in src/devicecontroller/DeviceController.ts:94
Gets an AnalyserNode from the current audio input. This node can be used to generate the display for a mic indicator. Null is returned if no audio input has been selected.

Returns AnalyserNode | null

enableWebAudio

enableWebAudio(flag: boolean): void

Inherited from DeviceController.enableWebAudio
- Defined in src/devicecontroller/DeviceController.ts:143
Sets the flag in DeviceController on whether to enable WebAudio-based device management.

Parameters
- flag: boolean
Returns void

getAllRemoteVideoTiles

getAllRemoteVideoTiles(): VideoTile[]

Inherited from VideoTileControllerFacade.getAllRemoteVideoTiles
- Defined in src/videotilecontroller/VideoTileControllerFacade.ts:17
Returns VideoTile[]

getAllVideoTiles

getAllVideoTiles(): VideoTile[]

Inherited from VideoTileControllerFacade.getAllVideoTiles
- Defined in src/videotilecontroller/VideoTileControllerFacade.ts:18
Returns VideoTile[]

getLocalVideoTile

getLocalVideoTile(): VideoTile | null

Inherited from VideoTileControllerFacade.getLocalVideoTile
- Defined in src/videotilecontroller/VideoTileControllerFacade.ts:13
Returns VideoTile | null

getRTCPeerConnectionStats

getRTCPeerConnectionStats(selector?: MediaStreamTrack): Promise<RTCStatsReport>

Inherited from AudioVideoControllerFacade.getRTCPeerConnectionStats
- Defined in src/audiovideocontroller/AudioVideoControllerFacade.ts:11
Parameters
- Optional selector: MediaStreamTrack
Returns Promise<RTCStatsReport>

getVideoInputQualitySettings

getVideoInputQualitySettings(): VideoQualitySettings | null

Inherited from DeviceController.getVideoInputQualitySettings
- Defined in src/devicecontroller/DeviceController.ts:138
Get the current video input quality settings to request when enabling video.

Returns VideoQualitySettings | null

getVideoTile

getVideoTile(tileId: number): VideoTile | null

Inherited from VideoTileControllerFacade.getVideoTile
- Defined in src/videotilecontroller/VideoTileControllerFacade.ts:16
Parameters
- tileId: number
Returns VideoTile | null

hasStartedLocalVideoTile

hasStartedLocalVideoTile(): boolean

Inherited from VideoTileControllerFacade.hasStartedLocalVideoTile
- Defined in src/videotilecontroller/VideoTileControllerFacade.ts:11
Returns boolean

listAudioInputDevices

listAudioInputDevices(): Promise<MediaDeviceInfo[]>

Inherited from DeviceController.listAudioInputDevices
- Defined in src/devicecontroller/DeviceController.ts:46
Lists currently available audio input devices.

Returns Promise<MediaDeviceInfo[]>

listAudioOutputDevices

listAudioOutputDevices(): Promise<MediaDeviceInfo[]>

Inherited from DeviceController.listAudioOutputDevices
- Defined in src/devicecontroller/DeviceController.ts:56
Lists currently available audio output devices.

Returns Promise<MediaDeviceInfo[]>

listVideoInputDevices

listVideoInputDevices(): Promise<MediaDeviceInfo[]>

Inherited from DeviceController.listVideoInputDevices
- Defined in src/devicecontroller/DeviceController.ts:51
Lists currently available video input devices.

Returns Promise<MediaDeviceInfo[]>

mixIntoAudioInput

mixIntoAudioInput(stream: MediaStream): MediaStreamAudioSourceNode

Inherited from DeviceController.mixIntoAudioInput
- Defined in src/devicecontroller/DeviceController.ts:121
Mixes the audio from the given media stream into the main audio input stream.

Parameters
- stream: MediaStream
Returns MediaStreamAudioSourceNode

pauseContentShare

pauseContentShare(): void

Inherited from ContentShareControllerFacade.pauseContentShare
- Defined in src/contentsharecontroller/ContentShareControllerFacade.ts:20
Pause content sharing

Returns void

pauseVideoTile

pauseVideoTile(tileId: number): void

Inherited from VideoTileControllerFacade.pauseVideoTile
- Defined in src/videotilecontroller/VideoTileControllerFacade.ts:14
Parameters
- tileId: number
Returns void

realtimeCanUnmuteLocalAudio

realtimeCanUnmuteLocalAudio(): boolean

Inherited from RealtimeControllerFacade.realtimeCanUnmuteLocalAudio
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:29
Returns boolean

realtimeIsLocalAudioMuted

realtimeIsLocalAudioMuted(): boolean

Inherited from RealtimeControllerFacade.realtimeIsLocalAudioMuted
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:34
Returns boolean

realtimeMuteLocalAudio

realtimeMuteLocalAudio(): void

Inherited from RealtimeControllerFacade.realtimeMuteLocalAudio
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:30
Returns void

realtimeSendDataMessage

realtimeSendDataMessage(topic: string, data: Uint8Array | string | any, lifetimeMs?: number): void

Inherited from RealtimeControllerFacade.realtimeSendDataMessage
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:48
Parameters
- topic: string
- data: Uint8Array | string | any
- Optional lifetimeMs: number
Returns void

realtimeSetCanUnmuteLocalAudio

realtimeSetCanUnmuteLocalAudio(canUnmute: boolean): void

Inherited from RealtimeControllerFacade.realtimeSetCanUnmuteLocalAudio
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:26
Parameters
- canUnmute: boolean
Returns void

realtimeSubscribeToAttendeeIdPresence

realtimeSubscribeToAttendeeIdPresence(callback: (attendeeId: string, present: boolean, externalUserId?: string, dropped?: boolean, posInFrame?: RealtimeAttendeePositionInFrame | null) => void): void

Inherited from RealtimeControllerFacade.realtimeSubscribeToAttendeeIdPresence
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:8
Parameters
- callback: (attendeeId: string, present: boolean, externalUserId?: string, dropped?: boolean, posInFrame?: RealtimeAttendeePositionInFrame | null) => void
  - - (attendeeId: string, present: boolean, externalUserId?: string, dropped?: boolean, posInFrame?: RealtimeAttendeePositionInFrame | null): void
    - Parameters
      - attendeeId: string
      - present: boolean
      - Optional externalUserId: string
      - Optional dropped: boolean
      - Optional posInFrame: RealtimeAttendeePositionInFrame | null
      Returns void
Returns void

realtimeSubscribeToFatalError

realtimeSubscribeToFatalError(callback: (error: Error) => void): void

Inherited from RealtimeControllerFacade.realtimeSubscribeToFatalError
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:58
Parameters
- callback: (error: Error) => void
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns void

realtimeSubscribeToLocalSignalStrengthChange

realtimeSubscribeToLocalSignalStrengthChange(callback: (signalStrength: number) => void): void

Inherited from RealtimeControllerFacade.realtimeSubscribeToLocalSignalStrengthChange
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:46
Parameters
- callback: (signalStrength: number) => void
  - - (signalStrength: number): void
    - Parameters
      - signalStrength: number
      Returns void
Returns void

realtimeSubscribeToMuteAndUnmuteLocalAudio

realtimeSubscribeToMuteAndUnmuteLocalAudio(callback: (muted: boolean) => void): void

Inherited from RealtimeControllerFacade.realtimeSubscribeToMuteAndUnmuteLocalAudio
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:32
Parameters
- callback: (muted: boolean) => void
  - - (muted: boolean): void
    - Parameters
      - muted: boolean
      Returns void
Returns void

realtimeSubscribeToReceiveDataMessage

realtimeSubscribeToReceiveDataMessage(topic: string, callback: (dataMessage: DataMessage) => void): void

Inherited from RealtimeControllerFacade.realtimeSubscribeToReceiveDataMessage
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:53
Parameters
- topic: string
- callback: (dataMessage: DataMessage) => void
  - - (dataMessage: DataMessage): void
    - Parameters
      - dataMessage: DataMessage
      Returns void
Returns void

realtimeSubscribeToSetCanUnmuteLocalAudio

realtimeSubscribeToSetCanUnmuteLocalAudio(callback: (canUnmute: boolean) => void): void

Inherited from RealtimeControllerFacade.realtimeSubscribeToSetCanUnmuteLocalAudio
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:27
Parameters
- callback: (canUnmute: boolean) => void
  - - (canUnmute: boolean): void
    - Parameters
      - canUnmute: boolean
      Returns void
Returns void

realtimeSubscribeToVolumeIndicator

realtimeSubscribeToVolumeIndicator(attendeeId: string, callback: (attendeeId: string, volume: number | null, muted: boolean | null, signalStrength: number | null, externalUserId?: string) => void): void

Inherited from RealtimeControllerFacade.realtimeSubscribeToVolumeIndicator
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:35
Parameters
- attendeeId: string
- callback: (attendeeId: string, volume: number | null, muted: boolean | null, signalStrength: number | null, externalUserId?: string) => void
  - - (attendeeId: string, volume: number | null, muted: boolean | null, signalStrength: number | null, externalUserId?: string): void
    - Parameters
      - attendeeId: string
      - volume: number | null
      - muted: boolean | null
      - signalStrength: number | null
      - Optional externalUserId: string
      Returns void
Returns void

realtimeUnmuteLocalAudio

realtimeUnmuteLocalAudio(): boolean

Inherited from RealtimeControllerFacade.realtimeUnmuteLocalAudio
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:31
Returns boolean

realtimeUnsubscribeFromReceiveDataMessage

realtimeUnsubscribeFromReceiveDataMessage(topic: string): void

Inherited from RealtimeControllerFacade.realtimeUnsubscribeFromReceiveDataMessage
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:57
Parameters
- topic: string
Returns void

realtimeUnsubscribeFromVolumeIndicator

realtimeUnsubscribeFromVolumeIndicator(attendeeId: string): void

Inherited from RealtimeControllerFacade.realtimeUnsubscribeFromVolumeIndicator
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:45
Parameters
- attendeeId: string
Returns void

realtimeUnsubscribeToAttendeeIdPresence

realtimeUnsubscribeToAttendeeIdPresence(callback: (attendeeId: string, present: boolean, externalUserId?: string, dropped?: boolean, posInFrame?: RealtimeAttendeePositionInFrame | null) => void): void

Inherited from RealtimeControllerFacade.realtimeUnsubscribeToAttendeeIdPresence
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:17
Parameters
- callback: (attendeeId: string, present: boolean, externalUserId?: string, dropped?: boolean, posInFrame?: RealtimeAttendeePositionInFrame | null) => void
  - - (attendeeId: string, present: boolean, externalUserId?: string, dropped?: boolean, posInFrame?: RealtimeAttendeePositionInFrame | null): void
    - Parameters
      - attendeeId: string
      - present: boolean
      - Optional externalUserId: string
      - Optional dropped: boolean
      - Optional posInFrame: RealtimeAttendeePositionInFrame | null
      Returns void
Returns void

realtimeUnsubscribeToFatalError

realtimeUnsubscribeToFatalError(callback: (error: Error) => void): void

Inherited from RealtimeControllerFacade.realtimeUnsubscribeToFatalError
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:59
Parameters
- callback: (error: Error) => void
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns void

realtimeUnsubscribeToLocalSignalStrengthChange

realtimeUnsubscribeToLocalSignalStrengthChange(callback: (signalStrength: number) => void): void

Inherited from RealtimeControllerFacade.realtimeUnsubscribeToLocalSignalStrengthChange
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:47
Parameters
- callback: (signalStrength: number) => void
  - - (signalStrength: number): void
    - Parameters
      - signalStrength: number
      Returns void
Returns void

realtimeUnsubscribeToMuteAndUnmuteLocalAudio

realtimeUnsubscribeToMuteAndUnmuteLocalAudio(callback: (muted: boolean) => void): void

Inherited from RealtimeControllerFacade.realtimeUnsubscribeToMuteAndUnmuteLocalAudio
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:33
Parameters
- callback: (muted: boolean) => void
  - - (muted: boolean): void
    - Parameters
      - muted: boolean
      Returns void
Returns void

realtimeUnsubscribeToSetCanUnmuteLocalAudio

realtimeUnsubscribeToSetCanUnmuteLocalAudio(callback: (canUnmute: boolean) => void): void

Inherited from RealtimeControllerFacade.realtimeUnsubscribeToSetCanUnmuteLocalAudio
- Defined in src/realtimecontroller/RealtimeControllerFacade.ts:28
Parameters
- callback: (canUnmute: boolean) => void
  - - (canUnmute: boolean): void
    - Parameters
      - canUnmute: boolean
      Returns void
Returns void

removeAllVideoTiles

removeAllVideoTiles(): void

Inherited from VideoTileControllerFacade.removeAllVideoTiles
- Defined in src/videotilecontroller/VideoTileControllerFacade.ts:22
Returns void

removeContentShareObserver

removeContentShareObserver(observer: ContentShareObserver): void

Inherited from ContentShareControllerFacade.removeContentShareObserver
- Defined in src/contentsharecontroller/ContentShareControllerFacade.ts:40
Remove an observer

Parameters
- observer: ContentShareObserver
Returns void

removeDeviceChangeObserver

removeDeviceChangeObserver(observer: DeviceChangeObserver): void

Inherited from DeviceController.removeDeviceChangeObserver
- Defined in src/devicecontroller/DeviceController.ts:87
Removes an observer to stop receiving callbacks about device changes.

Parameters
- observer: DeviceChangeObserver
Returns void

removeLocalVideoTile

removeLocalVideoTile(): void

Inherited from VideoTileControllerFacade.removeLocalVideoTile
- Defined in src/videotilecontroller/VideoTileControllerFacade.ts:12
Returns void

removeObserver

removeObserver(observer: AudioVideoObserver): void

Inherited from AudioVideoControllerFacade.removeObserver
- Defined in src/audiovideocontroller/AudioVideoControllerFacade.ts:8
Parameters
- observer: AudioVideoObserver
Returns void

removeVideoTile

removeVideoTile(tileId: number): void

Inherited from VideoTileControllerFacade.removeVideoTile
- Defined in src/videotilecontroller/VideoTileControllerFacade.ts:20
Parameters
- tileId: number
Returns void

removeVideoTilesByAttendeeId

removeVideoTilesByAttendeeId(attendeeId: string): number[]

Inherited from VideoTileControllerFacade.removeVideoTilesByAttendeeId
- Defined in src/videotilecontroller/VideoTileControllerFacade.ts:21
Parameters
- attendeeId: string
Returns number[]

setDeviceLabelTrigger

setDeviceLabelTrigger(trigger: () => Promise<MediaStream>): void

Inherited from DeviceController.setDeviceLabelTrigger
- Defined in src/devicecontroller/DeviceController.ts:116
Sets the device label trigger to use in the case where media device labels are not present due to privacy restrictions in the browser. See above for an explanation of how this works.

Parameters
- trigger: () => Promise<MediaStream>
  - - (): Promise<MediaStream>
    - Returns Promise<MediaStream>
Returns void

start

start(): void

Inherited from AudioVideoControllerFacade.start
- Defined in src/audiovideocontroller/AudioVideoControllerFacade.ts:9
Returns void

startContentShare

startContentShare(stream: MediaStream): Promise<void>

Inherited from ContentShareControllerFacade.startContentShare
- Defined in src/contentsharecontroller/ContentShareControllerFacade.ts:10
Start content sharing

Parameters
- stream: MediaStream
Returns Promise<void>

startContentShareFromScreenCapture

startContentShareFromScreenCapture(sourceId?: string, frameRate?: number): Promise<MediaStream>

Inherited from ContentShareControllerFacade.startContentShareFromScreenCapture
- Defined in src/contentsharecontroller/ContentShareControllerFacade.ts:15
Start screen sharing

Parameters
- Optional sourceId: string
- Optional frameRate: number
Returns Promise<MediaStream>

startLocalVideoTile

startLocalVideoTile(): number

Inherited from VideoTileControllerFacade.startLocalVideoTile
- Defined in src/videotilecontroller/VideoTileControllerFacade.ts:9
Returns number

startVideoPreviewForVideoInput

startVideoPreviewForVideoInput(element: HTMLVideoElement): void

Inherited from DeviceController.startVideoPreviewForVideoInput
- Defined in src/devicecontroller/DeviceController.ts:103
Starts a video preview of the currently selected video and binds it a video element to be displayed before a meeting begins. Make sure to call stopVideoPreviewForVideoInput when the preview is no longer necessary so that the stream can be released and turn off the camera if it is not being used anymore.

Parameters
- element: HTMLVideoElement
Returns void

stop

stop(): void

Inherited from AudioVideoControllerFacade.stop
- Defined in src/audiovideocontroller/AudioVideoControllerFacade.ts:10
Returns void

stopContentShare

stopContentShare(): void

Inherited from ContentShareControllerFacade.stopContentShare
- Defined in src/contentsharecontroller/ContentShareControllerFacade.ts:30
Stop content sharing

Returns void

stopLocalVideoTile

stopLocalVideoTile(): void

Inherited from VideoTileControllerFacade.stopLocalVideoTile
- Defined in src/videotilecontroller/VideoTileControllerFacade.ts:10
Returns void

stopVideoPreviewForVideoInput

stopVideoPreviewForVideoInput(element: HTMLVideoElement): void

Inherited from DeviceController.stopVideoPreviewForVideoInput
- Defined in src/devicecontroller/DeviceController.ts:109
Stops the stream for a previously bound video preview and unbinds it from the video element.

Parameters
- element: HTMLVideoElement
Returns void

subscribeToActiveSpeakerDetector

subscribeToActiveSpeakerDetector(policy: ActiveSpeakerPolicy, callback: (activeSpeakers: string[]) => void, scoresCallback?: (scores: {}) => void, scoresCallbackIntervalMs?: number): void

Inherited from ActiveSpeakerDetectorFacade.subscribeToActiveSpeakerDetector
- Defined in src/activespeakerdetector/ActiveSpeakerDetectorFacade.ts:13
Parameters
- policy: ActiveSpeakerPolicy
- callback: (activeSpeakers: string[]) => void
  - - (activeSpeakers: string[]): void
    - Parameters
      - activeSpeakers: string[]
      Returns void
- Optional scoresCallback: (scores: {}) => void
  - - (scores: {}): void
    - Parameters
      - scores: {}
        
        [attendeeId: string]: number
      Returns void
- Optional scoresCallbackIntervalMs: number
Returns void

unbindAudioElement

unbindAudioElement(): void

Inherited from AudioMixControllerFacade.unbindAudioElement
- Defined in src/audiomixcontroller/AudioMixControllerFacade.ts:6
Returns void

unbindVideoElement

unbindVideoElement(tileId: number): void

Inherited from VideoTileControllerFacade.unbindVideoElement
- Defined in src/videotilecontroller/VideoTileControllerFacade.ts:8
Parameters
- tileId: number
Returns void

unpauseContentShare

unpauseContentShare(): void

Inherited from ContentShareControllerFacade.unpauseContentShare
- Defined in src/contentsharecontroller/ContentShareControllerFacade.ts:25
Unpause content sharing

Returns void

unpauseVideoTile

unpauseVideoTile(tileId: number): void

Inherited from VideoTileControllerFacade.unpauseVideoTile
- Defined in src/videotilecontroller/VideoTileControllerFacade.ts:15
Parameters
- tileId: number
Returns void

unsubscribeFromActiveSpeakerDetector

unsubscribeFromActiveSpeakerDetector(callback: (activeSpeakers: string[]) => void): void

Inherited from ActiveSpeakerDetectorFacade.unsubscribeFromActiveSpeakerDetector
- Defined in src/activespeakerdetector/ActiveSpeakerDetectorFacade.ts:24
Parameters
- callback: (activeSpeakers: string[]) => void
  - - (activeSpeakers: string[]): void
    - Parameters
      - activeSpeakers: string[]
      Returns void
Returns void

Hierarchy

Implemented by

Index

Methods

Methods

addContentShareObserver

Parameters

observer: ContentShareObserver

Returns void

addDeviceChangeObserver

Parameters

observer: DeviceChangeObserver

Returns void

addObserver

Parameters

observer: AudioVideoObserver

Returns void

addVideoTile

Returns VideoTile

bindAudioElement

Parameters

element: HTMLAudioElement

Returns boolean

bindVideoElement

Parameters

tileId: number

videoElement: HTMLVideoElement

Returns void

captureVideoTile

Parameters

tileId: number

Returns ImageData | null

chooseAudioInputDevice

Parameters

device: Device

Returns Promise<DevicePermission>

chooseAudioOutputDevice

Parameters

deviceId: string | null

Returns Promise<void>

chooseVideoInputDevice

Parameters

device: Device

Returns Promise<DevicePermission>

chooseVideoInputQuality

Parameters

width: number

height: number

frameRate: number

maxBandwidthKbps: number

Returns void

createAnalyserNodeForAudioInput

Returns AnalyserNode | null

enableWebAudio

Parameters

flag: boolean

Returns void

getAllRemoteVideoTiles

Returns VideoTile[]

getAllVideoTiles

Returns VideoTile[]

getLocalVideoTile

Returns VideoTile | null

getRTCPeerConnectionStats

Parameters

Optional selector: MediaStreamTrack

Returns Promise<RTCStatsReport>

getVideoInputQualitySettings

Returns VideoQualitySettings | null

getVideoTile

Parameters

tileId: number

Returns VideoTile | null

hasStartedLocalVideoTile

Returns boolean

listAudioInputDevices

Returns Promise<MediaDeviceInfo[]>

listAudioOutputDevices

Returns Promise<MediaDeviceInfo[]>

listVideoInputDevices