Class E2EEcontext

constructor

• new E2EEcontext(__namedParameters?: boolean): E2EEcontext

  Build a new E2EE context instance, which will be used in a given conference.

  Parameters

  • Optional__namedParameters: boolean = {}

  Returns E2EEcontext

_worker

cleanup

• cleanup(participantId: string): void

  Cleans up all state associated with the given participant. This is needed when a participant leaves the current conference.

  Parameters

  • participantId: string

    The participant that just left.

  Returns void

cleanupAll

• cleanupAll(): void

  Cleans up all state associated with all participants in the conference. This is needed when disabling e2ee.

  Returns void

handleReceiver

• handleReceiver(
      receiver: RTCRtpReceiver,
      kind: string,
      participantId: string,
  ): void

  Handles the given {@code RTCRtpReceiver} by creating a {@code TransformStream} which will inject a frame decoder.

  Parameters

  • receiver: RTCRtpReceiver

    The receiver which will get the decoding function injected.
  • kind: string

    The kind of track this receiver belongs to.
  • participantId: string

    The participant id that this receiver belongs to.

  Returns void

handleSender

• handleSender(sender: RTCRtpSender, kind: string, participantId: string): void

  Handles the given {@code RTCRtpSender} by creating a {@code TransformStream} which will inject a frame encoder.

  Parameters

  • sender: RTCRtpSender

    The sender which will get the encoding function injected.
  • kind: string

    The kind of track this sender belongs to.
  • participantId: string

    The participant id that this sender belongs to.

  Returns void

setEnabled

• setEnabled(enabled: boolean): void

  Set the E2EE enabled state.

  Parameters

  • enabled: boolean

    whether E2EE is enabled or not.

  Returns void

setKey

• setKey(
      participantId: string,
      key: boolean | Uint8Array<ArrayBufferLike>,
      keyIndex: number,
  ): void

  Set the E2EE key for the specified participant.

  Parameters

  • participantId: string

    the ID of the participant who's key we are setting.
  • key: boolean | Uint8Array<ArrayBufferLike>

    they key for the given participant.
  • keyIndex: number

    the key index.

  Returns void