Options
All
  • Public
  • Public/Protected
  • All
Menu

amazon-chime-sdk-js

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AudioInputDevice

AudioInputDevice: Device | AudioTransformDevice

DetectorCallback

DetectorCallback: (attendeeIds: string[]) => void

Implements the DefaultActiveSpeakerDetector with the ActiveSpeakerPolicy

Type declaration

    • (attendeeIds: string[]): void
    • Parameters

      • attendeeIds: string[]

      Returns void

DetectorHandler

DetectorHandler: (attendeeId: string, present: boolean) => void

Type declaration

    • (attendeeId: string, present: boolean): void
    • Parameters

      • attendeeId: string
      • present: boolean

      Returns void

Device

Device: string | MediaTrackConstraints | MediaStream | null

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, or null to use the null device.

EventName

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

ListenerFunction

ListenerFunction: (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions) => any

Type declaration

    • (type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): any
    • Parameters

      • type: string
      • listener: EventListenerOrEventListenerObject
      • Optional options: boolean | AddEventListenerOptions

      Returns any

MeetingHistoryState

MeetingHistoryState: EventName

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

RawMetricReport

RawMetricReport: any

RealtimeSubscribeToAttendeeIdPresenceCallback

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

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

Type declaration

    • 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

StatsReportItem

StatsReportItem: any

Thunk

Thunk: () => void

Type declaration

    • (): void
    • Returns void

TranscriptEvent

TranscriptEvent: Transcript | TranscriptionStatus

VideoInputDevice

VideoInputDevice: Device | VideoTransformDevice

VolumeIndicatorCallback

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

RealtimeVolumeIndicator functions that listen to changes in attendees volume.

Type declaration

    • (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

Variables

Const DEFAULT_FRAMERATE

DEFAULT_FRAMERATE: 15 = 15

Const TRANSCRIPTION_DATA_MESSAGE_TOPIC

TRANSCRIPTION_DATA_MESSAGE_TOPIC: "aws:chime:transcription" = "aws:chime:transcription"

Functions

fillSMPTEColorBars

  • fillSMPTEColorBars(canvas: HTMLCanvasElement, xShift: number): void

Const flattenEventAttributes

isAudioTransformDevice

  • isAudioTransformDevice(device: any): device is AudioTransformDevice

isDefaultDevice

  • isDefaultDevice(device: Device): boolean

isDestroyable

  • isDestroyable(x: any): x is Destroyable
  • Type guard for Destroyable.

    Parameters

    • x: any

      A value that might implement the Destroyable interface.

    Returns x is Destroyable

    Whether the value implements Destroyable.

isIFramed

  • isIFramed(): boolean

isMediaDeviceInfo

  • isMediaDeviceInfo(device: unknown): device is MediaDeviceInfo

isVideoTransformDevice

  • isVideoTransformDevice(device: unknown): device is VideoTransformDevice

makeColorBars

  • makeColorBars(canvas: HTMLCanvasElement, colorOrPattern: string): undefined | { listener: Thunk; scheduler: IntervalScheduler; stream: MediaStream }

toLowerCasePropertyNames

  • toLowerCasePropertyNames(input: any): any

wait

  • wait(waitTimeMs: number): Promise<void>

Object literals

Const TranscriptionStatusTypes

TranscriptionStatusTypes: object

[SdkTranscriptionStatus.Type.FAILED]

[SdkTranscriptionStatus.Type.FAILED]: TranscriptionStatusType = TranscriptionStatusType.FAILED

[SdkTranscriptionStatus.Type.INTERRUPTED]

[SdkTranscriptionStatus.Type.INTERRUPTED]: TranscriptionStatusType = TranscriptionStatusType.INTERRUPTED

[SdkTranscriptionStatus.Type.RESUMED]

[SdkTranscriptionStatus.Type.RESUMED]: TranscriptionStatusType = TranscriptionStatusType.RESUMED

[SdkTranscriptionStatus.Type.STARTED]

[SdkTranscriptionStatus.Type.STARTED]: TranscriptionStatusType = TranscriptionStatusType.STARTED

[SdkTranscriptionStatus.Type.STOPPED]

[SdkTranscriptionStatus.Type.STOPPED]: TranscriptionStatusType = TranscriptionStatusType.STOPPED

Generated using TypeDoc