Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface VideoTile

VideoTile is a binding of attendee id, a video stream, and a video element that sends out updates to session observers whenever one of its properties changes.

Hierarchy

  • VideoTile

Implemented by

Index

Methods

bindVideoElement

  • bindVideoElement(videoElement: HTMLVideoElement | null): void
  • Binds the video element to the tile and sends out updates. This must also be called anytime the display of the video element changes, for example, when changing its dimensions or hiding it. To unbind the video element from the tile pass null.

    Parameters

    • videoElement: HTMLVideoElement | null

    Returns void

bindVideoStream

  • bindVideoStream(attendeeId: string, localTile: boolean, mediaStream: MediaStream | null, contentWidth: number | null, contentHeight: number | null, streamId: number | null, externalUserId?: string): void
  • Binds the video stream to the tile and sends out updates.

    Parameters

    • attendeeId: string
    • localTile: boolean
    • mediaStream: MediaStream | null
    • contentWidth: number | null
    • contentHeight: number | null
    • streamId: number | null
    • Optional externalUserId: string

    Returns void

capture

  • capture(): ImageData | null
  • Captures a snapshot image from the tile, or null if the tile is not active right now.

    Returns ImageData | null

destroy

  • destroy(): void
  • Cleans up resources associated with the tile. The tile may not be used after destroy is called.

    Returns void

id

  • id(): number

markPoorConnection

  • markPoorConnection(): boolean
  • Marks the tile as having a poor connection returning whether it was previously unmarked

    Returns boolean

pause

  • pause(): void

state

stateRef

unmarkPoorConnection

  • unmarkPoorConnection(): boolean
  • Unmarks the tile as having a poor connection returning whether it was previously marked

    Returns boolean

unpause

  • unpause(): void

Generated using TypeDoc