-
- All Implemented Interfaces:
-
java.io.Serializable
public final class JoinRequest extends Message<JoinRequest, Nothing>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public classJoinRequest.Companion
-
Field Summary
Fields Modifier and Type Field Description private final List<PublishOption>preferred_publish_optionsprivate final List<SubscribeOption>preferred_subscribe_optionsprivate final List<ClientCapability>capabilitiesprivate final Stringtokenprivate final Stringsession_idprivate final Stringunified_session_idprivate final Stringsubscriber_sdpprivate final Stringpublisher_sdpprivate final ClientDetailsclient_detailsprivate final Migrationmigrationprivate final Booleanfast_reconnectprivate final ReconnectDetailsreconnect_detailsprivate final ParticipantSourcesourceprivate final ProtoAdapter<JoinRequest>adapterprivate final ByteStringunknownFields
-
Constructor Summary
Constructors Constructor Description JoinRequest(String token, String session_id, String unified_session_id, String subscriber_sdp, String publisher_sdp, ClientDetails client_details, Migration migration, Boolean fast_reconnect, ReconnectDetails reconnect_details, List<PublishOption> preferred_publish_options, List<SubscribeOption> preferred_subscribe_options, List<ClientCapability> capabilities, ParticipantSource source, ByteString unknownFields)
-
Method Summary
Modifier and Type Method Description final List<PublishOption>getPreferred_publish_options()final List<SubscribeOption>getPreferred_subscribe_options()final List<ClientCapability>getCapabilities()final StringgetToken()final StringgetSession_id()final StringgetUnified_session_id()user_session id can change during reconnects, this helps us to identify the user across reconnects and should remain consistent until the user explicitly disconnects, is kicked or the call is ended. final StringgetSubscriber_sdp()dumb SDP that allow us to extract subscriber's decode codecs final StringgetPublisher_sdp()final ClientDetailsgetClient_details()final MigrationgetMigration()Deprecated: use ReconnectDetails instead final BooleangetFast_reconnect()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. final ReconnectDetailsgetReconnect_details()final ParticipantSourcegetSource()final ProtoAdapter<JoinRequest>adapter()final ByteStringunknownFields()VoidnewBuilder()Booleanequals(Object other)IntegerhashCode()StringtoString()final JoinRequestcopy(String token, String session_id, String unified_session_id, String subscriber_sdp, String publisher_sdp, ClientDetails client_details, Migration migration, Boolean fast_reconnect, ReconnectDetails reconnect_details, List<PublishOption> preferred_publish_options, List<SubscribeOption> preferred_subscribe_options, List<ClientCapability> capabilities, ParticipantSource source, ByteString unknownFields)-
-
Constructor Detail
-
JoinRequest
JoinRequest(String token, String session_id, String unified_session_id, String subscriber_sdp, String publisher_sdp, ClientDetails client_details, Migration migration, Boolean fast_reconnect, ReconnectDetails reconnect_details, List<PublishOption> preferred_publish_options, List<SubscribeOption> preferred_subscribe_options, List<ClientCapability> capabilities, ParticipantSource source, ByteString unknownFields)
-
-
Method Detail
-
getPreferred_publish_options
final List<PublishOption> getPreferred_publish_options()
-
getPreferred_subscribe_options
final List<SubscribeOption> getPreferred_subscribe_options()
-
getCapabilities
final List<ClientCapability> getCapabilities()
-
getSession_id
final String getSession_id()
-
getUnified_session_id
final String getUnified_session_id()
user_session id can change during reconnects, this helps us to identify the user across reconnects and should remain consistent until the user explicitly disconnects, is kicked or the call is ended.
-
getSubscriber_sdp
final String getSubscriber_sdp()
dumb SDP that allow us to extract subscriber's decode codecs
-
getPublisher_sdp
final String getPublisher_sdp()
-
getClient_details
final ClientDetails getClient_details()
-
getMigration
final Migration getMigration()
Deprecated: use ReconnectDetails instead
-
getFast_reconnect
final Boolean getFast_reconnect()
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.
-
getReconnect_details
final ReconnectDetails getReconnect_details()
-
getSource
final ParticipantSource getSource()
-
adapter
final ProtoAdapter<JoinRequest> adapter()
-
unknownFields
final ByteString unknownFields()
-
newBuilder
@Deprecated(message = Shouldn't be used in Kotlin, level = DeprecationLevel.HIDDEN) Void newBuilder()
-
copy
final JoinRequest copy(String token, String session_id, String unified_session_id, String subscriber_sdp, String publisher_sdp, ClientDetails client_details, Migration migration, Boolean fast_reconnect, ReconnectDetails reconnect_details, List<PublishOption> preferred_publish_options, List<SubscribeOption> preferred_subscribe_options, List<ClientCapability> capabilities, ParticipantSource source, ByteString unknownFields)
-
-
-
-