Options
All
  • Public
  • Public/Protected
  • All
Menu

amazon-chime-sdk-js

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Type aliases

AGCOptions

AGCOptions: EnabledAGCOptions | DisabledAGCOptions

AudioInputDevice

AudioInputDevice: Device | AudioTransformDevice | null

ContentShareSimulcastEncodingParameters

ContentShareSimulcastEncodingParameters: { high?: VideoEncodingParameters; low?: VideoEncodingParameters }

Type declaration

Device

Device: string | MediaTrackConstraints | MediaStream

A specifier for how to obtain a media stream from the browser. This can be a MediaStream itself, a set of constraints, a device ID.

EventName

EventName: "meetingStartRequested" | "meetingStartSucceeded" | "meetingReconnected" | "meetingStartFailed" | "meetingEnded" | "meetingFailed" | "attendeePresenceReceived" | "audioInputSelected" | "audioInputUnselected" | "audioInputFailed" | "videoInputSelected" | "videoInputUnselected" | "videoInputFailed" | "signalingDropped" | "receivingAudioDropped"

MeetingHistoryState

MeetingHistoryState: EventName

MeetingHistoryState describes user actions and events, including all event names in EventName.

RealtimeSubscribeToAttendeeIdPresenceCallback

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

Type declaration

    • Realtime attendee presence callback that listens to changes in attendee presence.

      Parameters

      • attendeeId: string

        Internal Amazon Chime AttendeeId created by CreateAttendee API.

      • present: boolean

        Indicates the attendee's presence in a meeting.

      • Optional externalUserId: string

        Indicates the attendee's externalUserId provided while joining a meeting.

      • Optional dropped: boolean

        Indicates whether the attendee dropped from the meeting.

        The Amazon Chime SDK for JavaScript reconnects a meeting session in below scenarios:

        • No audio packets (WebRTC)
        • Bad audio delay (WebRTC)
        • No pong reply (WebSocket)

        This value is provided by the Amazon Chime backend when an attendee is dropped and could not join the same meeting again due to re-connection issues. It is also provided to differentiate the scenarios between normal attendee leave and the attendee dropping due to re-connection issues.

        In re-connection scenarios, if an attendee drops and could never join back successfully, the JS SDK will call this callback setting the dropped value to a boolean value received from Amazon Chime backend, and it will set the present parameter to false.

      • Optional posInFrame: RealtimeAttendeePositionInFrame | null

        This object indicates which attendee out of how many total attendees the update is for. For example, if you were to join on a call with 3 total attendees, you would get presence callbacks for attendeeIndex 0, attendeeIndex 1, attendeeIndex 2 out of the total attendeesInFrame of 3. You will receive callback for each attendee present in the meeting after you join the meeting. Later, you will receive callback as attendees leave or join the meeting.

      Returns void

TranscriptEvent

TranscriptEvent: Transcript | TranscriptionStatus

VideoEncodingParameters

VideoEncodingParameters: { maxBitrateKbps?: number; maxFramerate?: number; scaleResolutionDownBy?: number }

Type declaration

  • Optional maxBitrateKbps?: number
  • Optional maxFramerate?: number
  • Optional scaleResolutionDownBy?: number

VideoInputDevice

VideoInputDevice: Device | VideoTransformDevice

VoiceFocusConfig

VoiceFocusConfig: SupportedVoiceFocusConfig | Unsupported

VoiceFocusModelComplexity

VoiceFocusModelComplexity: "c100" | "c50" | "c20" | "c10"

VoiceFocusModelName

VoiceFocusModelName: "default" | "ns_es"

VolumeIndicatorCallback

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

Type declaration

    • (attendeeId: string, volume: number | null, muted: boolean | null, signalStrength: number | null, externalUserId?: string): void
    • RealtimeVolumeIndicator functions that listen to changes in attendees volume.

      Parameters

      • attendeeId: string
      • volume: number | null
      • muted: boolean | null
      • signalStrength: number | null
      • Optional externalUserId: string

      Returns void

Variables

Const BackgroundBlurStrength

BackgroundBlurStrength: { HIGH: number; LOW: number; MEDIUM: number } = ...

The numbers below indicate the amount of blur to apply. Larger numbers will produce more blur.

Type declaration

  • HIGH: number
  • LOW: number
  • MEDIUM: number

Functions

isAudioTransformDevice

isDestroyable

isVideoTransformDevice

Generated using TypeDoc