Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SignalingClientSubscribe

SignalingClientSubscribe contains settings for the Subscribe SignalFrame.

Hierarchy

  • SignalingClientSubscribe

Index

Constructors

constructor

  • new SignalingClientSubscribe(attendeeId: string, sdpOffer: string, audioHost: string, audioMuted: boolean, audioCheckin: boolean, receiveStreamIds: number[], localVideoEnabled: boolean, videoStreamDescriptions: VideoStreamDescription[], connectionTypeHasVideo: boolean): SignalingClientSubscribe
  • Initializes a SignalingClientSubscribe with the given properties.

    Parameters

    • attendeeId: string

      Attendee ID of the client

    • sdpOffer: string

      SDP offer created by WebRTC

    • audioHost: string

      host

    • audioMuted: boolean

      Whether audio from client is muted

    • audioCheckin: boolean

      Whether audio is in checked-in state

    • receiveStreamIds: number[]

      Which video streams to receive

    • localVideoEnabled: boolean

      Whether to send a video stream for the local camera

    • videoStreamDescriptions: VideoStreamDescription[]
    • connectionTypeHasVideo: boolean

      Whether connection type has video

    Returns SignalingClientSubscribe

Properties

attendeeId

attendeeId: string

Attendee ID of the client

audioCheckin

audioCheckin: boolean

Whether audio is in checked-in state

audioHost

audioHost: string

host

audioMuted

audioMuted: boolean

Whether audio from client is muted

connectionTypeHasVideo

connectionTypeHasVideo: boolean

Whether connection type has video

localVideoEnabled

localVideoEnabled: boolean

Whether to send a video stream for the local camera

receiveStreamIds

receiveStreamIds: number[]

Which video streams to receive

sdpOffer

sdpOffer: string

SDP offer created by WebRTC

videoStreamDescriptions

videoStreamDescriptions: VideoStreamDescription[]

Generated using TypeDoc