Options
All
  • Public
  • Public/Protected
  • All
Menu

amazon-chime-sdk-js

Index

Namespaces

Enumerations

Classes

Interfaces

Type aliases

Variables

Functions

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" | "meetingStartFailed" | "meetingEnded" | "meetingFailed" | "attendeePresenceReceived" | "audioInputSelected" | "audioInputUnselected" | "audioInputFailed" | "videoInputSelected" | "videoInputUnselected" | "videoInputFailed"

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 | "meetingReconnected" | "signalingDropped" | "receivingAudioDropped"

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

RawMetricReport

RawMetricReport: any

StatsReportItem

StatsReportItem: any

Thunk

Thunk: () => void

Type declaration

    • (): void
    • Returns void

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

Functions

fillSMPTEColorBars

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

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.

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 }

Generated using TypeDoc