Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RoomScreenShare

Hierarchy

  • RoomScreenShareMethods
  • BaseConnection
    • RoomScreenShare

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    Returns RoomScreenShare

Properties

direction

direction: "inbound" | "outbound"

id

id: string

nodeId

nodeId: string

options

options: BaseConnectionOptions

peer

peer: default

Accessors

active

  • get active(): boolean

  • Returns boolean

cameraId

  • get cameraId(): string

  • Returns string

cameraLabel

  • get cameraLabel(): string

  • Returns string

localAudioTrack

  • get localAudioTrack(): MediaStreamTrack

  • Returns MediaStreamTrack

localStream

  • get localStream(): MediaStream

  • Returns MediaStream

localVideoTrack

  • get localVideoTrack(): MediaStreamTrack

  • Returns MediaStreamTrack

memberId

  • get memberId(): string

  • Returns string

microphoneId

  • get microphoneId(): string

  • Returns string

microphoneLabel

  • get microphoneLabel(): string

  • Returns string

remoteStream

  • get remoteStream(): MediaStream

  • Returns MediaStream

roomId

  • get roomId(): string

  • Returns string

roomSessionId

  • get roomSessionId(): string

  • Returns string

trying

  • get trying(): boolean

  • Returns boolean

Methods

audioMute

  • audioMute(): Promise<void>

audioUnmute

  • audioUnmute(): Promise<void>

destroy

  • destroy(): void

  • Returns void

hangup

  • hangup(): Promise<void>

  • Returns Promise<void>

join

  • join(): Promise<unknown>

leave

  • leave(): Promise<void>

off

  • off(...params: [event: string | symbol, fn?: (...args: any[]) => void, context?: any, once?: boolean]): EventEmitter<string | symbol, any>

  • Parameters

    • Rest ...params: [event: string | symbol, fn?: (...args: any[]) => void, context?: any, once?: boolean]

    Returns EventEmitter<string | symbol, any>

on

  • on(...params: [event: string | symbol, fn: (...args: any[]) => void, context?: any]): EventEmitter<string | symbol, any>

  • Parameters

    • Rest ...params: [event: string | symbol, fn: (...args: any[]) => void, context?: any]

    Returns EventEmitter<string | symbol, any>

once

  • once(...params: [event: string | symbol, fn: (...args: any[]) => void, context?: any]): EventEmitter<string | symbol, any>

  • Parameters

    • Rest ...params: [event: string | symbol, fn: (...args: any[]) => void, context?: any]

    Returns EventEmitter<string | symbol, any>

removeAllListeners

  • removeAllListeners(...params: [event?: string | symbol]): EventEmitter<string | symbol, any>

  • Parameters

    • Rest ...params: [event?: string | symbol]

    Returns EventEmitter<string | symbol, any>

setInputSensitivity

  • setInputSensitivity(params: { value: number }): Promise<void>

setMicrophoneVolume

  • setMicrophoneVolume(params: { volume: number }): Promise<void>

updateCamera

  • updateCamera(constraints: MediaTrackConstraints): Promise<void>

  • Parameters

    • constraints: MediaTrackConstraints

    Returns Promise<void>

updateMicrophone

  • updateMicrophone(constraints: MediaTrackConstraints): Promise<void>

  • Parameters

    • constraints: MediaTrackConstraints

    Returns Promise<void>

videoMute

  • videoMute(): Promise<void>

videoUnmute

  • videoUnmute(): Promise<void>