Options
All
  • Public
  • Public/Protected
  • All
Menu

The entity responsible for creating and managing WebRTC session.
All the interactions with vidaoo-browser library go through this entity.

Hierarchy

  • Session

Index

Constructors

constructor

  • Parameters

    Returns Session

Accessors

emitter

Methods

abortFileUpload

  • abortFileUpload(fileId: string): void
  • Parameters

    • fileId: string

    Returns void

applyBlur

  • applyBlur(): void
  • Apply blur background effect to own video track.

    Returns void

applyMask

  • applyMask(imageUrl: string, metadata?: any): void
  • Apply mask effect (change background with a custom image) to own video track.

    Parameters

    • imageUrl: string

      The URL of the image to use as a background. If the URL domain of the image is different from the web application domain, the server providing the image must add the following response header "Access-Control-Allow-Origin: *".

    • metadata: any = null

      Data that will return with the MaskStarted event. Useful, for example, to keep track of the image chosen as a background.

    Returns void

deleteMessage

  • deleteMessage(id: string): void
  • Deletes a message.

    Parameters

    • id: string

    Returns void

dispose

  • dispose(): Promise<void>
  • Disposes all internal resources of the library.
    This method should always be called at the end of the session.

    Returns Promise<void>

editMessage

  • Edits a message.

    Parameters

    Returns void

joinMeeting

  • Initializes the session as a meeting.
    This method should always be called one time when joining a session.

    Parameters

    Returns void

removeBlur

  • removeBlur(): void
  • Remove blur background effect to own video track.

    Returns void

removeMask

  • removeMask(): void
  • Remove mask effect from own video track.

    Returns void

replaceAudioTrack

  • replaceAudioTrack(publisherId: string, deviceId: string): Promise<void>
  • Replaces own audio track by specifying a different device (microphone) Id.

    See also: MediaDeviceInfo

    Parameters

    • publisherId: string
    • deviceId: string

    Returns Promise<void>

replaceVideoTrack

  • replaceVideoTrack(publisherId: string, deviceId: string): Promise<void>
  • Replaces own video track by specifying a different device (camera) Id.

    See also: MediaDeviceInfo

    Parameters

    • publisherId: string
    • deviceId: string

    Returns Promise<void>

sendMessage

sendTyping

  • sendTyping(typing: boolean): void
  • Informs other participants if you are typing or not.

    Parameters

    • typing: boolean

    Returns void

toggleAudio

  • toggleAudio(publisherId: string): void
  • Toggles audio (microphone).
    This can be used to mute/unmute own microphone.

    Parameters

    • publisherId: string

    Returns void

toggleScreensharing

  • toggleScreensharing(): Promise<void>
  • Toggles screensharing.

    Returns Promise<void>

toggleVideo

  • toggleVideo(publisherId: string): void
  • Toggles video (camera).
    This can be used to show/hide own camera.

    Parameters

    • publisherId: string

    Returns void