All Implemented Interfaces:: java.io.Serializable


public final class SfuEvent
extends Message<SfuEvent, Nothing>

SFUEvent is a message that is sent from the SFU to the client.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public class`	`SfuEvent.Companion`

Field Summary

Fields
Modifier and Type	Field	Description
`private final SubscriberOffer`	`subscriber_offer`
`private final PublisherAnswer`	`publisher_answer`
`private final ConnectionQualityChanged`	`connection_quality_changed`
`private final AudioLevelChanged`	`audio_level_changed`
`private final ICETrickle`	`ice_trickle`
`private final ChangePublishQuality`	`change_publish_quality`
`private final ParticipantJoined`	`participant_joined`
`private final ParticipantLeft`	`participant_left`
`private final DominantSpeakerChanged`	`dominant_speaker_changed`
`private final JoinResponse`	`join_response`
`private final HealthCheckResponse`	`health_check_response`
`private final TrackPublished`	`track_published`
`private final TrackUnpublished`	`track_unpublished`
`private final Error`	`error`
`private final CallGrantsUpdated`	`call_grants_updated`
`private final GoAway`	`go_away`
`private final ICERestart`	`ice_restart`
`private final PinsChanged`	`pins_updated`
`private final CallEnded`	`call_ended`
`private final ParticipantUpdated`	`participant_updated`
`private final ParticipantMigrationComplete`	`participant_migration_complete`
`private final ChangePublishOptions`	`change_publish_options`
`private final InboundStateNotification`	`inbound_state_notification`
`private final ProtoAdapter<SfuEvent>`	`adapter`
`private final ByteString`	`unknownFields`

Constructor Summary

Constructors
Constructor	Description
SfuEvent(SubscriberOffer subscriber_offer, PublisherAnswer publisher_answer, ConnectionQualityChanged connection_quality_changed, AudioLevelChanged audio_level_changed, ICETrickle ice_trickle, ChangePublishQuality change_publish_quality, ParticipantJoined participant_joined, ParticipantLeft participant_left, DominantSpeakerChanged dominant_speaker_changed, JoinResponse join_response, HealthCheckResponse health_check_response, TrackPublished track_published, TrackUnpublished track_unpublished, Error error, CallGrantsUpdated call_grants_updated, GoAway go_away, ICERestart ice_restart, PinsChanged pins_updated, CallEnded call_ended, ParticipantUpdated participant_updated, ParticipantMigrationComplete participant_migration_complete, ChangePublishOptions change_publish_options, InboundStateNotification inbound_state_notification, ByteString unknownFields)

Method Summary

Modifier and Type	Method	Description
`final SubscriberOffer`	`getSubscriber_offer()`	SubscriberOffer sends the SDP offer for establishing the subscriber PeerConnection.
`final PublisherAnswer`	`getPublisher_answer()`	PublisherAnswer sends the SDP answer to the offer sent by the client for establishing the Publisher PeerConnection.
`final ConnectionQualityChanged`	`getConnection_quality_changed()`	ConnectionQualityChanged is sent to inform the connection quality of the participants in the call.
`final AudioLevelChanged`	`getAudio_level_changed()`	AudioLevelChanged is sent for change in audio levels of the participants.
`final ICETrickle`	`getIce_trickle()`	ICETrickle contains the ICE candidate required to establish the ICE transport: part of establishing the PeerConnection and also for ICE restarts.
`final ChangePublishQuality`	`getChange_publish_quality()`	ChangePublishQuality advises the publisher to switch on/off various qualities of their video stream based on the subscription.
`final ParticipantJoined`	`getParticipant_joined()`	ParticipantJoined notifies the client that a new participant has joined the call.
`final ParticipantLeft`	`getParticipant_left()`	ParticipantLeft notifies the client that a call participant has left the call.
`final DominantSpeakerChanged`	`getDominant_speaker_changed()`	DominantSpeakerChanged notifies the client about the current dominant speaker.
`final JoinResponse`	`getJoin_response()`	JoinResponse acknowledges a participant successfully joining the call.
`final HealthCheckResponse`	`getHealth_check_response()`	HealthCheckResponse is sent in response to the HealthCheckRequest.
`final TrackPublished`	`getTrack_published()`	TrackPublished is sent when a new track (like audio, video, screenshare) is published by a participant in the call.
`final TrackUnpublished`	`getTrack_unpublished()`	TrackUnpublished is sent when a track (like audio, video, screenshare) is no longer published.
`final Error`	`getError()`	Error is used to communicate any error related to the participant.
`final CallGrantsUpdated`	`getCall_grants_updated()`	CallGrantsUpdated tells what tracks a participant is allowed to publish.
`final GoAway`	`getGo_away()`	GoAway tells the client to migrate away from the SFU it is connected to.
`final ICERestart`	`getIce_restart()`	ICERestart tells the client to perform ICE restart.
`final PinsChanged`	`getPins_updated()`	PinsChanged is sent the list of pins in the call changes.
`final CallEnded`	`getCall_ended()`	CallEnded is sent by the SFU to the client to signal that the call has ended.
`final ParticipantUpdated`	`getParticipant_updated()`	ParticipantUpdated is sent when user data is updated
`final ParticipantMigrationComplete`	`getParticipant_migration_complete()`	ParticipantMigrationComplete is sent when the participant migration is complete
`final ChangePublishOptions`	`getChange_publish_options()`	ChangePublishOptions is sent to signal the change in publish options such as a new codec or simulcast layers
`final InboundStateNotification`	`getInbound_state_notification()`	InboundStateNotification
`final ProtoAdapter<SfuEvent>`	`adapter()`
`final ByteString`	`unknownFields()`
`Void`	`newBuilder()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final SfuEvent`	copy(SubscriberOffer subscriber_offer, PublisherAnswer publisher_answer, ConnectionQualityChanged connection_quality_changed, AudioLevelChanged audio_level_changed, ICETrickle ice_trickle, ChangePublishQuality change_publish_quality, ParticipantJoined participant_joined, ParticipantLeft participant_left, DominantSpeakerChanged dominant_speaker_changed, JoinResponse join_response, HealthCheckResponse health_check_response, TrackPublished track_published, TrackUnpublished track_unpublished, Error error, CallGrantsUpdated call_grants_updated, GoAway go_away, ICERestart ice_restart, PinsChanged pins_updated, CallEnded call_ended, ParticipantUpdated participant_updated, ParticipantMigrationComplete participant_migration_complete, ChangePublishOptions change_publish_options, InboundStateNotification inbound_state_notification, ByteString unknownFields)

Methods inherited from class stream.video.sfu.event.SfuEvent
encode, encode, encode, encodeByteString, withoutUnknownFields
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SfuEvent

SfuEvent(SubscriberOffer subscriber_offer, PublisherAnswer publisher_answer, ConnectionQualityChanged connection_quality_changed, AudioLevelChanged audio_level_changed, ICETrickle ice_trickle, ChangePublishQuality change_publish_quality, ParticipantJoined participant_joined, ParticipantLeft participant_left, DominantSpeakerChanged dominant_speaker_changed, JoinResponse join_response, HealthCheckResponse health_check_response, TrackPublished track_published, TrackUnpublished track_unpublished, Error error, CallGrantsUpdated call_grants_updated, GoAway go_away, ICERestart ice_restart, PinsChanged pins_updated, CallEnded call_ended, ParticipantUpdated participant_updated, ParticipantMigrationComplete participant_migration_complete, ChangePublishOptions change_publish_options, InboundStateNotification inbound_state_notification, ByteString unknownFields)

Method Detail
- getSubscriber_offer
```
 final SubscriberOffer getSubscriber_offer()
```
  SubscriberOffer sends the SDP offer for establishing the subscriber PeerConnection.
- getPublisher_answer
```
 final PublisherAnswer getPublisher_answer()
```
  PublisherAnswer sends the SDP answer to the offer sent by the client for establishing the Publisher PeerConnection.
- getConnection_quality_changed
```
 final ConnectionQualityChanged getConnection_quality_changed()
```
  ConnectionQualityChanged is sent to inform the connection quality of the participants in the call. It does not have to contain the full list of call participants in it.
- getAudio_level_changed
```
 final AudioLevelChanged getAudio_level_changed()
```
  AudioLevelChanged is sent for change in audio levels of the participants.
- getIce_trickle
```
 final ICETrickle getIce_trickle()
```
  ICETrickle contains the ICE candidate required to establish the ICE transport: part of establishing the PeerConnection and also for ICE restarts.
- getChange_publish_quality
```
 final ChangePublishQuality getChange_publish_quality()
```
  ChangePublishQuality advises the publisher to switch on/off various qualities of their video stream based on the subscription. This is done to save the bandwidth and the CPU of the publisher.
- getParticipant_joined
```
 final ParticipantJoined getParticipant_joined()
```
  ParticipantJoined notifies the client that a new participant has joined the call. This is not sent for anonymous users.
- getParticipant_left
```
 final ParticipantLeft getParticipant_left()
```
  ParticipantLeft notifies the client that a call participant has left the call. This is not sent for anonymous users.
- getDominant_speaker_changed
```
 final DominantSpeakerChanged getDominant_speaker_changed()
```
  DominantSpeakerChanged notifies the client about the current dominant speaker. This is required for certain use cases like the spotlight view.
- getJoin_response
```
 final JoinResponse getJoin_response()
```
  JoinResponse acknowledges a participant successfully joining the call. This is sent in response to the JoinRequest.
- getHealth_check_response
```
 final HealthCheckResponse getHealth_check_response()
```
  HealthCheckResponse is sent in response to the HealthCheckRequest. It contains the participant count in the call.
- getTrack_published
```
 final TrackPublished getTrack_published()
```
  TrackPublished is sent when a new track (like audio, video, screenshare) is published by a participant in the call. It is also sent on mute/unmute.
- getTrack_unpublished
```
 final TrackUnpublished getTrack_unpublished()
```
  TrackUnpublished is sent when a track (like audio, video, screenshare) is no longer published. It is sent on muting a track or when the participant is leaving the call.
- getError
```
 final Error getError()
```
  Error is used to communicate any error related to the participant. The error code and the message explain what went wrong. Whether the participant can retry is also indicated.
- getCall_grants_updated
```
 final CallGrantsUpdated getCall_grants_updated()
```
  CallGrantsUpdated tells what tracks a participant is allowed to publish.
- getGo_away
```
 final GoAway getGo_away()
```
  GoAway tells the client to migrate away from the SFU it is connected to. The reason field indicates why this message was sent.
- getIce_restart
```
 final ICERestart getIce_restart()
```
  ICERestart tells the client to perform ICE restart.
- getPins_updated
```
 final PinsChanged getPins_updated()
```
  PinsChanged is sent the list of pins in the call changes. This event contains the entire list of pins.
- getCall_ended
```
 final CallEnded getCall_ended()
```
  CallEnded is sent by the SFU to the client to signal that the call has ended. The reason may specify why the call has ended.
- getParticipant_updated
```
 final ParticipantUpdated getParticipant_updated()
```
  ParticipantUpdated is sent when user data is updated
- getParticipant_migration_complete
```
 final ParticipantMigrationComplete getParticipant_migration_complete()
```
  ParticipantMigrationComplete is sent when the participant migration is complete
- getChange_publish_options
```
 final ChangePublishOptions getChange_publish_options()
```
  ChangePublishOptions is sent to signal the change in publish options such as a new codec or simulcast layers
- getInbound_state_notification
```
 final InboundStateNotification getInbound_state_notification()
```
  InboundStateNotification
- adapter
```
 final ProtoAdapter<SfuEvent> adapter()
```
- unknownFields
```
 final ByteString unknownFields()
```
- newBuilder
```
@Deprecated(message = Shouldn't be used in Kotlin, level = DeprecationLevel.HIDDEN) Void newBuilder()
```
- equals
```
 Boolean equals(Object other)
```
- hashCode
```
 Integer hashCode()
```
- toString
```
 String toString()
```
- copy
```
 final SfuEvent copy(SubscriberOffer subscriber_offer, PublisherAnswer publisher_answer, ConnectionQualityChanged connection_quality_changed, AudioLevelChanged audio_level_changed, ICETrickle ice_trickle, ChangePublishQuality change_publish_quality, ParticipantJoined participant_joined, ParticipantLeft participant_left, DominantSpeakerChanged dominant_speaker_changed, JoinResponse join_response, HealthCheckResponse health_check_response, TrackPublished track_published, TrackUnpublished track_unpublished, Error error, CallGrantsUpdated call_grants_updated, GoAway go_away, ICERestart ice_restart, PinsChanged pins_updated, CallEnded call_ended, ParticipantUpdated participant_updated, ParticipantMigrationComplete participant_migration_complete, ChangePublishOptions change_publish_options, InboundStateNotification inbound_state_notification, ByteString unknownFields)
```

Class SfuEvent

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class stream.video.sfu.event.SfuEvent

Methods inherited from class java.lang.Object

Constructor Detail

SfuEvent

Method Detail

getSubscriber_offer

getPublisher_answer

getConnection_quality_changed

getAudio_level_changed

getIce_trickle

getChange_publish_quality

getParticipant_joined

getParticipant_left

getDominant_speaker_changed

getJoin_response

getHealth_check_response

getTrack_published

getTrack_unpublished

getError

getCall_grants_updated

getGo_away

getIce_restart

getPins_updated

getCall_ended

getParticipant_updated

getParticipant_migration_complete

getChange_publish_options

getInbound_state_notification

adapter

unknownFields

newBuilder

equals

hashCode

toString

copy