package stream.video.sfu.event

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: AudioLevelChanged

• string user_id = 1

• string session_id = 2

• float level = 3

  0.0 means complete silence, 1.0 loudest

• bool is_speaking = 4

AudioLevelChanged is sent by the SFU to notify about audio levels by user

Used in: SfuEvent

• repeated AudioLevel audio_levels = 1

Used in: ChangePublishQuality

• optional models.Codec codec = 2

• models.TrackType track_type = 3

• int32 publish_option_id = 4

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.

Used in: SfuEvent

• models.CallEndedReason reason = 1

CallGrants is sent to users when there is a change in the call permissions to publish audio, video or share the screen for a user or a role. This is idempotent and can be sent at any time. Only the current_grants in the latest message should be considered. In other words, this is not dependent on any other message (including previous call_grants_updated message) When this message is received, the client (say, React component) should mute the tracks which are not allowed anymore. For example, if the message has grants {audio:true, video:false} while the user is publishing video, then the client component should mute the video track and gray out the video button. This way, the user will not be able to publish video until the permissions are granted again. Also, muting the track on the client side will prevent the SFU from receiving the video track and will save bandwidth. In simple words, this is exactly the same as muting a track on the client. Here, instead of the user instructing the client, SFU would be doing it.

Used in: SfuEvent

• optional models.CallGrants current_grants = 1

• string message = 2

Used in: SfuEvent

• repeated models.PublishOption publish_options = 1

• string reason = 2

(message has no fields)

sent to users when they need to change the quality of their video

Used in: SfuEvent

• repeated AudioSender audio_senders = 1

• repeated VideoSender video_senders = 2

ConnectionQuality is sent to inform about connection quality changes eg. thierry's connection is not good -> render a red icon Zoom style

Used in: SfuEvent

• repeated ConnectionQualityInfo connection_quality_updates = 1

Used in: ConnectionQualityChanged

• string user_id = 1

• string session_id = 2

• models.ConnectionQuality connection_quality = 3

DominantSpeakerChanged is sent by the SFU to notify when there is a new dominant speaker in the call

Used in: SfuEvent

• string user_id = 1

• string session_id = 2

Used in: SfuEvent

• optional models.Error error = 4

• models.WebsocketReconnectStrategy reconnect_strategy = 5

  returns the reconnect strategy to be used by the client

Go away is sent by the SFU to the client to signal to migrate away from the SFU. The evict reason may specify why the user is being evicted.

Used in: SfuEvent

• models.GoAwayReason reason = 1

Used in: SfuRequest

(message has no fields)

Used in: SfuEvent

• optional models.ParticipantCount participant_count = 1

Used in: SfuEvent

• models.PeerType peer_type = 1

• models.PeerType peer_type = 1

• string ice_candidate = 2

Used in: SfuRequest

• string token = 1

• string session_id = 2

• string subscriber_sdp = 3

  dumb SDP that allow us to extract subscriber's decode codecs

• string publisher_sdp = 8

• optional models.ClientDetails client_details = 4

• optional Migration migration = 5

  Deprecated: use ReconnectDetails instead

• bool fast_reconnect = 6

  Fast reconnect flag explicitly indicates that if the participant session and the associated state is still present in the SFU, the client is ready to restore the PeerConnection with an ICE restart. If the SFU replies with "reconnected: true" in its JoinResponse, then it is safe to perform an ICE restart or else the existing PeerConnections must be cleaned up. For the SFU, fast_reconnect:false indicates that even if it has the state cached, the client state is not in sync and hence it must be cleaned up before proceeding further.

• optional ReconnectDetails reconnect_details = 7

• repeated models.PublishOption preferred_publish_options = 9

• repeated models.SubscribeOption preferred_subscribe_options = 10

Used in: SfuEvent

• optional models.CallState call_state = 1

• bool reconnected = 2

• int32 fast_reconnect_deadline_seconds = 3

• repeated models.PublishOption publish_options = 4

Used in: SfuRequest

• string session_id = 1

• string reason = 2

Used in: JoinRequest

• string from_sfu_id = 1

• repeated models.TrackInfo announced_tracks = 2

• repeated signal.TrackSubscriptionDetails subscriptions = 3

ParticipantJoined is fired when a user joins a call

Used in: SfuEvent

• string call_cid = 1

• optional models.Participant participant = 2

ParticipantJoined is fired when a user leaves a call

Used in: SfuEvent

• string call_cid = 1

• optional models.Participant participant = 2

Used in: SfuEvent

(message has no fields)

ParticipantUpdated is fired when user data is updated

Used in: SfuEvent

• string call_cid = 1

• optional models.Participant participant = 2

Used in: SfuEvent

• repeated models.Pin pins = 1

  the list of pins in the call. Pins are ordered in descending order (most important first).

Used in: SfuEvent

• string sdp = 1

Used in: JoinRequest

• models.WebsocketReconnectStrategy strategy = 1

• repeated models.TrackInfo announced_tracks = 3

• repeated signal.TrackSubscriptionDetails subscriptions = 4

• uint32 reconnect_attempt = 5

• string from_sfu_id = 6

• string previous_session_id = 7

  only set in case of rejoin

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

• oneof event_payload

  • SubscriberOffer subscriber_offer = 1

    SubscriberOffer sends the SDP offer for establishing the subscriber PeerConnection.

  • PublisherAnswer publisher_answer = 2

    PublisherAnswer sends the SDP answer to the offer sent by the client for establishing the Publisher PeerConnection.

  • ConnectionQualityChanged connection_quality_changed = 3

    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.

  • AudioLevelChanged audio_level_changed = 4

    AudioLevelChanged is sent for change in audio levels of the participants.

  • models.ICETrickle ice_trickle = 5

    ICETrickle contains the ICE candidate required to establish the ICE transport: part of establishing the PeerConnection and also for ICE restarts.

  • ChangePublishQuality change_publish_quality = 6

    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.

  • ParticipantJoined participant_joined = 10

    ParticipantJoined notifies the client that a new participant has joined the call. This is not sent for anonymous users.

  • ParticipantLeft participant_left = 11

    ParticipantLeft notifies the client that a call participant has left the call. This is not sent for anonymous users.

  • DominantSpeakerChanged dominant_speaker_changed = 12

    DominantSpeakerChanged notifies the client about the current dominant speaker. This is required for certain use cases like the spotlight view.

  • JoinResponse join_response = 13

    JoinResponse acknowledges a participant successfully joining the call. This is sent in response to the JoinRequest.

  • HealthCheckResponse health_check_response = 14

    HealthCheckResponse is sent in response to the HealthCheckRequest. It contains the participant count in the call.

  • TrackPublished track_published = 16

    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.

  • TrackUnpublished track_unpublished = 17

    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.

  • Error error = 18

    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.

  • CallGrantsUpdated call_grants_updated = 19

    CallGrantsUpdated tells what tracks a participant is allowed to publish.

  • GoAway go_away = 20

    GoAway tells the client to migrate away from the SFU it is connected to. The reason field indicates why this message was sent.

  • ICERestart ice_restart = 21

    ICERestart tells the client to perform ICE restart.

  • PinsChanged pins_updated = 22

    PinsChanged is sent the list of pins in the call changes. This event contains the entire list of pins.

  • CallEnded call_ended = 23

    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.

  • ParticipantUpdated participant_updated = 24

    ParticipantUpdated is sent when user data is updated

  • ParticipantMigrationComplete participant_migration_complete = 25

    ParticipantMigrationComplete is sent when the participant migration is complete

  • ChangePublishOptions change_publish_options = 27

    ChangePublishOptions is sent to signal the change in publish options such as a new codec or simulcast layers

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

• oneof request_payload

  • JoinRequest join_request = 1

  • HealthCheckRequest health_check_request = 2

  • LeaveCallRequest leave_call_request = 3

SubscriberOffer is sent when the SFU adds tracks to a subscription

Used in: SfuEvent

• bool ice_restart = 1

• string sdp = 2

Used in: SfuEvent

• string user_id = 1

• string session_id = 2

• models.TrackType type = 3

• optional models.Participant participant = 4

  Participant information here is included as an optimisation for large calls where broadcasting on every participant join is expensive. You should **NOT** assume that this will always be available though you can use it to update the participant list when it is there.

Used in: SfuEvent

• string user_id = 1

• string session_id = 2

• models.TrackType type = 3

• models.TrackUnpublishReason cause = 4

• optional models.Participant participant = 5

  Participant information here is included as an optimisation for large calls where broadcasting on every participant join is expensive. You should **NOT** assume that this will always be available though you can use it to update the participant list when it is there.

VideoLayerSetting is used to specify various parameters of a particular encoding in simulcast. The parameters are specified here - https://developer.mozilla.org/en-US/docs/Web/API/RTCRtpEncodingParameters SDKs use these parameters sent from the server to dynamically adjust these parameters to save CPU, bandwidth

Used in: VideoSender

• string name = 1

• bool active = 2

• int32 max_bitrate = 3

• float scale_resolution_down_by = 4

• optional models.Codec codec = 6

• uint32 max_framerate = 7

• string scalability_mode = 8

Used in: ChangePublishQuality

• optional models.Codec codec = 2

• repeated VideoLayerSetting layers = 3

• models.TrackType track_type = 4

• int32 publish_option_id = 5