Package 

Interface LivekitRtc.SignalResponseOrBuilder

    • Method Summary

      Modifier and Type Method Description
      abstract boolean hasJoin()
      sent when join is accepted
      
      .livekit.JoinResponse join = 1;
      abstract LivekitRtc.JoinResponse getJoin()
      sent when join is accepted
      
      .livekit.JoinResponse join = 1;
      abstract boolean hasAnswer()
      sent when server answers publisher
      
      .livekit.SessionDescription answer = 2;
      abstract LivekitRtc.SessionDescription getAnswer()
      sent when server answers publisher
      
      .livekit.SessionDescription answer = 2;
      abstract boolean hasOffer()
      sent when server is sending subscriber an offer
      
      .livekit.SessionDescription offer = 3;
      abstract LivekitRtc.SessionDescription getOffer()
      sent when server is sending subscriber an offer
      
      .livekit.SessionDescription offer = 3;
      abstract boolean hasTrickle()
      sent when an ICE candidate is available
      
      .livekit.TrickleRequest trickle = 4;
      abstract LivekitRtc.TrickleRequest getTrickle()
      sent when an ICE candidate is available
      
      .livekit.TrickleRequest trickle = 4;
      abstract boolean hasUpdate()
      sent when participants in the room has changed
      
      .livekit.ParticipantUpdate update = 5;
      abstract LivekitRtc.ParticipantUpdate getUpdate()
      sent when participants in the room has changed
      
      .livekit.ParticipantUpdate update = 5;
      abstract boolean hasTrackPublished()
      sent to the participant when their track has been published
      
      .livekit.TrackPublishedResponse track_published = 6;
      abstract LivekitRtc.TrackPublishedResponse getTrackPublished()
      sent to the participant when their track has been published
      
      .livekit.TrackPublishedResponse track_published = 6;
      abstract boolean hasLeave()
      Immediately terminate session
      
      .livekit.LeaveRequest leave = 8;
      abstract LivekitRtc.LeaveRequest getLeave()
      Immediately terminate session
      
      .livekit.LeaveRequest leave = 8;
      abstract boolean hasMute()
      server initiated mute
      
      .livekit.MuteTrackRequest mute = 9;
      abstract LivekitRtc.MuteTrackRequest getMute()
      server initiated mute
      
      .livekit.MuteTrackRequest mute = 9;
      abstract boolean hasSpeakersChanged()
      indicates changes to speaker status, including when they've gone to not speaking
      
      .livekit.SpeakersChanged speakers_changed = 10;
      abstract LivekitRtc.SpeakersChanged getSpeakersChanged()
      indicates changes to speaker status, including when they've gone to not speaking
      
      .livekit.SpeakersChanged speakers_changed = 10;
      abstract boolean hasRoomUpdate()
      sent when metadata of the room has changed
      
      .livekit.RoomUpdate room_update = 11;
      abstract LivekitRtc.RoomUpdate getRoomUpdate()
      sent when metadata of the room has changed
      
      .livekit.RoomUpdate room_update = 11;
      abstract boolean hasConnectionQuality()
      when connection quality changed
      
      .livekit.ConnectionQualityUpdate connection_quality = 12;
      abstract LivekitRtc.ConnectionQualityUpdate getConnectionQuality()
      when connection quality changed
      
      .livekit.ConnectionQualityUpdate connection_quality = 12;
      abstract boolean hasStreamStateUpdate()
      when streamed tracks state changed, used to notify when any of the streams were paused due to
      congestion
      
      .livekit.StreamStateUpdate stream_state_update = 13;
      abstract LivekitRtc.StreamStateUpdate getStreamStateUpdate()
      when streamed tracks state changed, used to notify when any of the streams were paused due to
      congestion
      
      .livekit.StreamStateUpdate stream_state_update = 13;
      abstract boolean hasSubscribedQualityUpdate()
      when max subscribe quality changed, used by dynamic broadcasting to disable unused layers
      
      .livekit.SubscribedQualityUpdate subscribed_quality_update = 14;
      abstract LivekitRtc.SubscribedQualityUpdate getSubscribedQualityUpdate()
      when max subscribe quality changed, used by dynamic broadcasting to disable unused layers
      
      .livekit.SubscribedQualityUpdate subscribed_quality_update = 14;
      abstract boolean hasSubscriptionPermissionUpdate()
      when subscription permission changed
      
      .livekit.SubscriptionPermissionUpdate subscription_permission_update = 15;
      abstract LivekitRtc.SubscriptionPermissionUpdate getSubscriptionPermissionUpdate()
      when subscription permission changed
      
      .livekit.SubscriptionPermissionUpdate subscription_permission_update = 15;
      abstract boolean hasRefreshToken()
      update the token the client was using, to prevent an active client from using an expired token
      
      string refresh_token = 16;
      abstract String getRefreshToken()
      update the token the client was using, to prevent an active client from using an expired token
      
      string refresh_token = 16;
      abstract ByteString getRefreshTokenBytes()
      update the token the client was using, to prevent an active client from using an expired token
      
      string refresh_token = 16;
      abstract boolean hasTrackUnpublished()
      server initiated track unpublish
      
      .livekit.TrackUnpublishedResponse track_unpublished = 17;
      abstract LivekitRtc.TrackUnpublishedResponse getTrackUnpublished()
      server initiated track unpublish
      
      .livekit.TrackUnpublishedResponse track_unpublished = 17;
      abstract boolean hasPong()
      respond to ping
      
      int64 pong = 18;
      abstract long getPong()
      respond to ping
      
      int64 pong = 18;
      abstract boolean hasReconnect()
      sent when client reconnects
      
      .livekit.ReconnectResponse reconnect = 19;
      abstract LivekitRtc.ReconnectResponse getReconnect()
      sent when client reconnects
      
      .livekit.ReconnectResponse reconnect = 19;
      abstract boolean hasPongResp()
      respond to Ping
      
      .livekit.Pong pong_resp = 20;
      abstract LivekitRtc.Pong getPongResp()
      respond to Ping
      
      .livekit.Pong pong_resp = 20;
      abstract boolean hasSubscriptionResponse()
      Subscription response, client should not expect any media from this subscription if it fails
      
      .livekit.SubscriptionResponse subscription_response = 21;
      abstract LivekitRtc.SubscriptionResponse getSubscriptionResponse()
      Subscription response, client should not expect any media from this subscription if it fails
      
      .livekit.SubscriptionResponse subscription_response = 21;
      abstract boolean hasRequestResponse()
      Response relating to user inititated requests that carry a `request_id`
      
      .livekit.RequestResponse request_response = 22;
      abstract LivekitRtc.RequestResponse getRequestResponse()
      Response relating to user inititated requests that carry a `request_id`
      
      .livekit.RequestResponse request_response = 22;
      abstract boolean hasTrackSubscribed()
      notify to the publisher when a published track has been subscribed for the first time
      
      .livekit.TrackSubscribed track_subscribed = 23;
      abstract LivekitRtc.TrackSubscribed getTrackSubscribed()
      notify to the publisher when a published track has been subscribed for the first time
      
      .livekit.TrackSubscribed track_subscribed = 23;
      abstract boolean hasRoomMoved()
      notify to the participant when they have been moved to a new room
      
      .livekit.RoomMovedResponse room_moved = 24;
      abstract LivekitRtc.RoomMovedResponse getRoomMoved()
      notify to the participant when they have been moved to a new room
      
      .livekit.RoomMovedResponse room_moved = 24;
      abstract boolean hasMediaSectionsRequirement()
      notify number of required media sections to satisfy subscribed tracks
      
      .livekit.MediaSectionsRequirement media_sections_requirement = 25;
      abstract LivekitRtc.MediaSectionsRequirement getMediaSectionsRequirement()
      notify number of required media sections to satisfy subscribed tracks
      
      .livekit.MediaSectionsRequirement media_sections_requirement = 25;
      abstract boolean hasSubscribedAudioCodecUpdate()
      when audio subscription changes, used to enable simulcasting of audio codecs based on subscriptions
      
      .livekit.SubscribedAudioCodecUpdate subscribed_audio_codec_update = 26;
      abstract LivekitRtc.SubscribedAudioCodecUpdate getSubscribedAudioCodecUpdate()
      when audio subscription changes, used to enable simulcasting of audio codecs based on subscriptions
      
      .livekit.SubscribedAudioCodecUpdate subscribed_audio_codec_update = 26;
      abstract LivekitRtc.SignalResponse.MessageCase getMessageCase()
      • Methods inherited from class com.google.protobuf.MessageLiteOrBuilder

        getDefaultInstanceForType, isInitialized
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • hasJoin

         abstract boolean hasJoin()
        sent when join is accepted
        
        .livekit.JoinResponse join = 1;
      • hasAnswer

         abstract boolean hasAnswer()
        sent when server answers publisher
        
        .livekit.SessionDescription answer = 2;
      • hasOffer

         abstract boolean hasOffer()
        sent when server is sending subscriber an offer
        
        .livekit.SessionDescription offer = 3;
      • hasTrickle

         abstract boolean hasTrickle()
        sent when an ICE candidate is available
        
        .livekit.TrickleRequest trickle = 4;
      • hasUpdate

         abstract boolean hasUpdate()
        sent when participants in the room has changed
        
        .livekit.ParticipantUpdate update = 5;
      • hasTrackPublished

         abstract boolean hasTrackPublished()
        sent to the participant when their track has been published
        
        .livekit.TrackPublishedResponse track_published = 6;
      • hasLeave

         abstract boolean hasLeave()
        Immediately terminate session
        
        .livekit.LeaveRequest leave = 8;
      • hasMute

         abstract boolean hasMute()
        server initiated mute
        
        .livekit.MuteTrackRequest mute = 9;
      • hasSpeakersChanged

         abstract boolean hasSpeakersChanged()
        indicates changes to speaker status, including when they've gone to not speaking
        
        .livekit.SpeakersChanged speakers_changed = 10;
      • hasRoomUpdate

         abstract boolean hasRoomUpdate()
        sent when metadata of the room has changed
        
        .livekit.RoomUpdate room_update = 11;
      • hasConnectionQuality

         abstract boolean hasConnectionQuality()
        when connection quality changed
        
        .livekit.ConnectionQualityUpdate connection_quality = 12;
      • hasStreamStateUpdate

         abstract boolean hasStreamStateUpdate()
        when streamed tracks state changed, used to notify when any of the streams were paused due to
        congestion
        
        .livekit.StreamStateUpdate stream_state_update = 13;
      • getStreamStateUpdate

         abstract LivekitRtc.StreamStateUpdate getStreamStateUpdate()
        when streamed tracks state changed, used to notify when any of the streams were paused due to
        congestion
        
        .livekit.StreamStateUpdate stream_state_update = 13;
      • hasSubscribedQualityUpdate

         abstract boolean hasSubscribedQualityUpdate()
        when max subscribe quality changed, used by dynamic broadcasting to disable unused layers
        
        .livekit.SubscribedQualityUpdate subscribed_quality_update = 14;
      • hasSubscriptionPermissionUpdate

         abstract boolean hasSubscriptionPermissionUpdate()
        when subscription permission changed
        
        .livekit.SubscriptionPermissionUpdate subscription_permission_update = 15;
      • hasRefreshToken

         abstract boolean hasRefreshToken()
        update the token the client was using, to prevent an active client from using an expired token
        
        string refresh_token = 16;
      • getRefreshToken

         abstract String getRefreshToken()
        update the token the client was using, to prevent an active client from using an expired token
        
        string refresh_token = 16;
      • getRefreshTokenBytes

         abstract ByteString getRefreshTokenBytes()
        update the token the client was using, to prevent an active client from using an expired token
        
        string refresh_token = 16;
      • hasTrackUnpublished

         abstract boolean hasTrackUnpublished()
        server initiated track unpublish
        
        .livekit.TrackUnpublishedResponse track_unpublished = 17;
      • hasPong

         abstract boolean hasPong()
        respond to ping
        
        int64 pong = 18;
      • getPong

         abstract long getPong()
        respond to ping
        
        int64 pong = 18;
      • hasReconnect

         abstract boolean hasReconnect()
        sent when client reconnects
        
        .livekit.ReconnectResponse reconnect = 19;
      • hasPongResp

         abstract boolean hasPongResp()
        respond to Ping
        
        .livekit.Pong pong_resp = 20;
      • hasSubscriptionResponse

         abstract boolean hasSubscriptionResponse()
        Subscription response, client should not expect any media from this subscription if it fails
        
        .livekit.SubscriptionResponse subscription_response = 21;
      • hasRequestResponse

         abstract boolean hasRequestResponse()
        Response relating to user inititated requests that carry a `request_id`
        
        .livekit.RequestResponse request_response = 22;
      • hasTrackSubscribed

         abstract boolean hasTrackSubscribed()
        notify to the publisher when a published track has been subscribed for the first time
        
        .livekit.TrackSubscribed track_subscribed = 23;
      • hasRoomMoved

         abstract boolean hasRoomMoved()
        notify to the participant when they have been moved to a new room
        
        .livekit.RoomMovedResponse room_moved = 24;
      • hasMediaSectionsRequirement

         abstract boolean hasMediaSectionsRequirement()
        notify number of required media sections to satisfy subscribed tracks
        
        .livekit.MediaSectionsRequirement media_sections_requirement = 25;
      • hasSubscribedAudioCodecUpdate

         abstract boolean hasSubscribedAudioCodecUpdate()
        when audio subscription changes, used to enable simulcasting of audio codecs based on subscriptions
        
        .livekit.SubscribedAudioCodecUpdate subscribed_audio_codec_update = 26;