Class SignalingClientSubscribe

[[SignalingClientSubscribe]] contains settings for the Subscribe SignalFrame.

Constructors

  • 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[]

      array of local video stream description

    • connectionTypeHasVideo: boolean

      Whether connection type has video

    • compressedSdpOffer: Uint8Array

      Compressed version of the SDP offer which was created by WebRTC

    Returns SignalingClientSubscribe

Properties

attendeeId: string

Attendee ID of the client

audioCheckin: boolean

Whether audio is in checked-in state

audioHost: string

host

audioMuted: boolean

Whether audio from client is muted

compressedSdpOffer: Uint8Array

Compressed version of the SDP offer which was created by WebRTC

connectionTypeHasVideo: boolean

Whether connection type has video

localVideoEnabled: boolean

Whether to send a video stream for the local camera

receiveStreamIds: number[]

Which video streams to receive

sdpOffer: string

SDP offer created by WebRTC

videoStreamDescriptions: VideoStreamDescription[]

array of local video stream description

videoSubscriptionConfiguration: SignalingClientVideoSubscriptionConfiguration[] = []