package stream.video.sfu.models

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: signal.SendStatsRequest

• AndroidThermalState thermal_state = 1

• bool is_power_saver_mode = 2

AndroidThermalState is reported by the Android API. The full list of values is documented here https://developer.android.com/reference/android/os/PowerManager.html#getCurrentThermalStatus()

Used in: AndroidState

• ANDROID_THERMAL_STATE_UNSPECIFIED = 0

• ANDROID_THERMAL_STATE_NONE = 1

• ANDROID_THERMAL_STATE_LIGHT = 2

• ANDROID_THERMAL_STATE_MODERATE = 3

• ANDROID_THERMAL_STATE_SEVERE = 4

• ANDROID_THERMAL_STATE_CRITICAL = 5

• ANDROID_THERMAL_STATE_EMERGENCY = 6

• ANDROID_THERMAL_STATE_SHUTDOWN = 7

Used in: signal.SendStatsRequest

• AppleThermalState thermal_state = 1

• bool is_low_power_mode_enabled = 2

  https://developer.apple.com/documentation/foundation/processinfo/1617047-islowpowermodeenabled

AppleThermalState is the thermal state as reported by Apple devices when available or applicable to the platform. The full list of states (enum) is available here: https://developer.apple.com/documentation/foundation/processinfo/thermalstate

Used in: AppleState

• APPLE_THERMAL_STATE_UNSPECIFIED = 0

• APPLE_THERMAL_STATE_NOMINAL = 1

• APPLE_THERMAL_STATE_FAIR = 2

• APPLE_THERMAL_STATE_SERIOUS = 3

• APPLE_THERMAL_STATE_CRITICAL = 4

Used in: ClientDetails

• string name = 1

• string version = 2

• string type = 1

  the call type

• string id = 2

  the call id

• string created_by_user_id = 3

  the id of the user that created this call

• string host_user_id = 4

  the id of the current host for this call

• optional google.protobuf.Struct custom = 5

• optional google.protobuf.Timestamp created_at = 6

• optional google.protobuf.Timestamp updated_at = 7

CallEndedReason represents the reason for the call to end.

Used in: event.CallEnded

• CALL_ENDED_REASON_UNSPECIFIED = 0

• CALL_ENDED_REASON_ENDED = 1

• CALL_ENDED_REASON_LIVE_ENDED = 2

• CALL_ENDED_REASON_KICKED = 3

• CALL_ENDED_REASON_SESSION_ENDED = 4

CallGrants represents the set of permissions given to the user for the current call.

Used in: event.CallGrantsUpdated

• bool can_publish_audio = 1

• bool can_publish_video = 2

• bool can_screenshare = 3

CallState is the current state of the call as seen by an SFU.

Used in: event.JoinResponse

• repeated Participant participants = 1

  participants is the list of participants in the call. In large calls, the list could be truncated in which case, the list of participants contains fewer participants than the counts returned in participant_count. Anonymous participants are **NOT** included in the list.

• optional google.protobuf.Timestamp started_at = 2

  started_at is the time the call session actually started.

• optional ParticipantCount participant_count = 3

  participant_count contains the summary of the counts.

• repeated Pin pins = 4

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

Used in: event.JoinRequest

• optional Sdk sdk = 1

• optional OS os = 2

• optional Browser browser = 3

• optional Device device = 4

Used in: event.AudioSender, event.VideoLayerSetting, event.VideoSender, PublishOption, SubscribeOption, TrackInfo

• uint32 payload_type = 16

• string name = 10

• uint32 clock_rate = 14

• string encoding_parameters = 15

• string fmtp = 12

Used in: event.ConnectionQualityInfo, Participant

• CONNECTION_QUALITY_UNSPECIFIED = 0

• CONNECTION_QUALITY_POOR = 1

• CONNECTION_QUALITY_GOOD = 2

• CONNECTION_QUALITY_EXCELLENT = 3

Used in: ClientDetails

• string name = 1

• string version = 2

Used in: event.Error, signal.ICERestartResponse, signal.ICETrickleResponse, signal.SendAnswerResponse, signal.SendStatsResponse, signal.SetPublisherResponse, signal.StartNoiseCancellationResponse, signal.StopNoiseCancellationResponse, signal.UpdateMuteStatesResponse, signal.UpdateSubscriptionsResponse

• ErrorCode code = 1

• string message = 2

• bool should_retry = 3

Used in: Error

• ERROR_CODE_UNSPECIFIED = 0

• ERROR_CODE_PUBLISH_TRACK_NOT_FOUND = 100

• ERROR_CODE_PUBLISH_TRACKS_MISMATCH = 101

• ERROR_CODE_PUBLISH_TRACK_OUT_OF_ORDER = 102

• ERROR_CODE_PUBLISH_TRACK_VIDEO_LAYER_NOT_FOUND = 103

• ERROR_CODE_LIVE_ENDED = 104

• ERROR_CODE_PARTICIPANT_NOT_FOUND = 200

• ERROR_CODE_PARTICIPANT_MIGRATING_OUT = 201

• ERROR_CODE_PARTICIPANT_MIGRATION_FAILED = 202

• ERROR_CODE_PARTICIPANT_MIGRATING = 203

• ERROR_CODE_PARTICIPANT_RECONNECT_FAILED = 204

• ERROR_CODE_PARTICIPANT_MEDIA_TRANSPORT_FAILURE = 205

• ERROR_CODE_CALL_NOT_FOUND = 300

• ERROR_CODE_REQUEST_VALIDATION_FAILED = 400

• ERROR_CODE_UNAUTHENTICATED = 401

• ERROR_CODE_PERMISSION_DENIED = 403

• ERROR_CODE_TOO_MANY_REQUESTS = 429

• ERROR_CODE_INTERNAL_SERVER_ERROR = 500

• ERROR_CODE_SFU_SHUTTING_DOWN = 600

• ERROR_CODE_SFU_FULL = 700

GoAwayReason represents the reason for the SFU to disconnect the client.

Used in: event.GoAway

• GO_AWAY_REASON_UNSPECIFIED = 0

• GO_AWAY_REASON_SHUTTING_DOWN = 1

• GO_AWAY_REASON_REBALANCE = 2

Used as request type in: signal.SignalServer.IceTrickle

Used as field type in: event.SfuEvent

• PeerType peer_type = 1

• string ice_candidate = 2

• string session_id = 3

Used in: signal.SendStatsRequest

• repeated string available_devices = 1

• string current_device = 2

• bool is_permitted = 3

Used in: ClientDetails

• string name = 1

• string version = 2

• string architecture = 3

those who are online in the call

Used in: event.ParticipantJoined, event.ParticipantLeft, event.ParticipantUpdated, event.TrackPublished, event.TrackUnpublished, CallState

• string user_id = 1

• string session_id = 2

• repeated TrackType published_tracks = 3

  map of track id to track type

• optional google.protobuf.Timestamp joined_at = 4

• string track_lookup_prefix = 5

• ConnectionQuality connection_quality = 6

• bool is_speaking = 7

• bool is_dominant_speaker = 8

• float audio_level = 9

• string name = 10

• string image = 11

• optional google.protobuf.Struct custom = 12

• repeated string roles = 13

Used in: event.HealthCheckResponse, CallState

• uint32 total = 1

  Total number of participants in the call including the anonymous participants.

• uint32 anonymous = 2

  Total number of anonymous participants in the call.

Used in: event.ICERestart, event.ICETrickle, ICETrickle, signal.ICERestartRequest, signal.SendAnswerRequest

• PEER_TYPE_PUBLISHER_UNSPECIFIED = 0

  todo fix me (marcelo)

• PEER_TYPE_SUBSCRIBER = 1

Used in: event.PinsChanged, CallState

• string user_id = 1

  the user to pin

• string session_id = 2

  the user sesion_id to pin, if not provided, applies to all sessions

PublishOption represents the configuration options for publishing a track.

Used in: event.ChangePublishOptions, event.JoinRequest, event.JoinResponse

• TrackType track_type = 1

  The type of the track being published (e.g., video, screenshare).

• optional Codec codec = 2

  The codec to be used for encoding the track (e.g., VP8, VP9, H264).

• int32 bitrate = 3

  The target bitrate for the published track, in bits per second.

• int32 fps = 4

  The target frames per second (FPS) for video encoding.

• int32 max_spatial_layers = 5

  The maximum number of spatial layers to send. - For SVC (e.g., VP9), spatial layers downscale by a factor of 2: - 1 layer: full resolution - 2 layers: full resolution + half resolution - 3 layers: full resolution + half resolution + quarter resolution - For non-SVC codecs (e.g., VP8/H264), this determines the number of encoded resolutions (e.g., quarter, half, full) sent for simulcast.

• int32 max_temporal_layers = 6

  The maximum number of temporal layers for scalable video coding (SVC). Temporal layers allow varying frame rates for different bandwidths.

• optional VideoDimension video_dimension = 7

  The dimensions of the video (e.g., width and height in pixels). Spatial layers are based on this base resolution. For example, if the base resolution is 1280x720: - Full resolution (1 layer) = 1280x720 - Half resolution (2 layers) = 640x360 - Quarter resolution (3 layers) = 320x180

• int32 id = 8

  The unique identifier for the publish request. - This `id` is assigned exclusively by the SFU. Any `id` set by the client in the `PublishOption` will be ignored and overwritten by the SFU. - The primary purpose of this `id` is to uniquely identify each publish request, even in scenarios where multiple publish requests for the same `track_type` and `codec` are active simultaneously. For example: - A user may publish two tracks of the same type (e.g., video) and codec (e.g., VP9) concurrently. - This uniqueness ensures that individual requests can be managed independently. For instance, an `id` is critical when stopping a specific publish request without affecting others.

Used in: ClientDetails

• SdkType type = 1

• string major = 2

• string minor = 3

• string patch = 4

Used in: Sdk

• SDK_TYPE_UNSPECIFIED = 0

• SDK_TYPE_REACT = 1

• SDK_TYPE_ANGULAR = 2

• SDK_TYPE_ANDROID = 3

• SDK_TYPE_IOS = 4

• SDK_TYPE_FLUTTER = 5

• SDK_TYPE_REACT_NATIVE = 6

• SDK_TYPE_UNITY = 7

• SDK_TYPE_GO = 8

• SDK_TYPE_PLAIN_JAVASCRIPT = 9

• VideoQuality video_quality = 1

• string user_id = 2

SubscribeOption represents the configuration options for subscribing to a track.

Used in: event.JoinRequest

• TrackType track_type = 1

  The type of the track being subscribed (e.g., video, screenshare).

• repeated Codec codecs = 2

  The codecs supported by the subscriber for decoding tracks.

Used in: event.Migration, event.ReconnectDetails, signal.SetPublisherRequest

• string track_id = 1

• TrackType track_type = 2

• repeated VideoLayer layers = 5

• string mid = 6

• bool dtx = 7

  for audio tracks

• bool stereo = 8

• bool red = 9

• bool muted = 10

• optional Codec codec = 11

• int32 publish_option_id = 12

Used in: event.AudioSender, event.TrackPublished, event.TrackUnpublished, event.VideoSender, Participant, PublishOption, SubscribeOption, TrackInfo, signal.TrackMuteState, signal.TrackSubscriptionDetails

• TRACK_TYPE_UNSPECIFIED = 0

• TRACK_TYPE_AUDIO = 1

• TRACK_TYPE_VIDEO = 2

• TRACK_TYPE_SCREEN_SHARE = 3

• TRACK_TYPE_SCREEN_SHARE_AUDIO = 4

Used in: event.TrackUnpublished

• TRACK_UNPUBLISH_REASON_UNSPECIFIED = 0

  Default value which is used when the specific reason for muting the track is not known.

• TRACK_UNPUBLISH_REASON_USER_MUTED = 1

  Represents user muting their tracks.

• TRACK_UNPUBLISH_REASON_PERMISSION_REVOKED = 2

  Represents muting the track because the permission to publish the track has been revoked.

• TRACK_UNPUBLISH_REASON_MODERATION = 3

  Represents muting the track due to moderation actions. This is different from permission revoked because the participant can unmute themselves here whereas in case of "permission revoke" it is not possible until the call permissions are updated.

Used in: PublishOption, VideoLayer, signal.TrackSubscriptionDetails

• uint32 width = 1

• uint32 height = 2

Used in: TrackInfo

• string rid = 1

  for tracks with a single layer, this should be HIGH

• optional VideoDimension video_dimension = 2

• uint32 bitrate = 4

  target bitrate, server will measure actual

• uint32 fps = 5

• VideoQuality quality = 6

Used in: StreamQuality, VideoLayer

• VIDEO_QUALITY_LOW_UNSPECIFIED = 0

• VIDEO_QUALITY_MID = 1

• VIDEO_QUALITY_HIGH = 2

• VIDEO_QUALITY_OFF = 3

WebsocketReconnectStrategy defines the ws strategies available for handling reconnections.

Used in: event.Error, event.ReconnectDetails, signal.Reconnection

• WEBSOCKET_RECONNECT_STRATEGY_UNSPECIFIED = 0

• WEBSOCKET_RECONNECT_STRATEGY_DISCONNECT = 1

  Sent after reaching the maximum reconnection attempts, or any other unrecoverable error leading to permanent disconnect.

• WEBSOCKET_RECONNECT_STRATEGY_FAST = 2

  SDK should maintaining existing publisher/subscriber pc instances and establish a new WebSocket connection.

• WEBSOCKET_RECONNECT_STRATEGY_REJOIN = 3

  SDK should obtain new credentials from the coordinator, drops existing pc instances, set a new session_id and initializes a completely new WebSocket connection, ensuring a comprehensive reset.

• WEBSOCKET_RECONNECT_STRATEGY_MIGRATE = 4

  SDK should migrate to a new SFU instance