-
- All Implemented Interfaces:
-
com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,java.lang.Cloneable,livekit.LivekitSip.CreateSIPParticipantRequestOrBuilder
public final class LivekitSip.CreateSIPParticipantRequest.Builder extends GeneratedMessageLite.Builder<LivekitSip.CreateSIPParticipantRequest, LivekitSip.CreateSIPParticipantRequest.Builder> implements LivekitSip.CreateSIPParticipantRequestOrBuilder
Protobuf typeA SIP Participant is a singular SIP session connected to a LiveKit room via a SIP Trunk into a SIP DispatchRule{@code livekit.CreateSIPParticipantRequest}
-
-
Method Summary
Modifier and Type Method Description StringgetSipTrunkId()What SIP Trunk should be used to dial the userstring sip_trunk_id = 1;ByteStringgetSipTrunkIdBytes()What SIP Trunk should be used to dial the userstring sip_trunk_id = 1;LivekitSip.CreateSIPParticipantRequest.BuildersetSipTrunkId(String value)What SIP Trunk should be used to dial the userstring sip_trunk_id = 1;LivekitSip.CreateSIPParticipantRequest.BuilderclearSipTrunkId()What SIP Trunk should be used to dial the userstring sip_trunk_id = 1;LivekitSip.CreateSIPParticipantRequest.BuildersetSipTrunkIdBytes(ByteString value)What SIP Trunk should be used to dial the userstring sip_trunk_id = 1;booleanhasTrunk().livekit.SIPOutboundConfig trunk = 20;LivekitSip.SIPOutboundConfiggetTrunk().livekit.SIPOutboundConfig trunk = 20;LivekitSip.CreateSIPParticipantRequest.BuildersetTrunk(LivekitSip.SIPOutboundConfig value).livekit.SIPOutboundConfig trunk = 20;LivekitSip.CreateSIPParticipantRequest.BuildersetTrunk(LivekitSip.SIPOutboundConfig.Builder builderForValue).livekit.SIPOutboundConfig trunk = 20;LivekitSip.CreateSIPParticipantRequest.BuildermergeTrunk(LivekitSip.SIPOutboundConfig value).livekit.SIPOutboundConfig trunk = 20;LivekitSip.CreateSIPParticipantRequest.BuilderclearTrunk().livekit.SIPOutboundConfig trunk = 20;StringgetSipCallTo()What number should be dialed via SIPstring sip_call_to = 2;ByteStringgetSipCallToBytes()What number should be dialed via SIPstring sip_call_to = 2;LivekitSip.CreateSIPParticipantRequest.BuildersetSipCallTo(String value)What number should be dialed via SIPstring sip_call_to = 2;LivekitSip.CreateSIPParticipantRequest.BuilderclearSipCallTo()What number should be dialed via SIPstring sip_call_to = 2;LivekitSip.CreateSIPParticipantRequest.BuildersetSipCallToBytes(ByteString value)What number should be dialed via SIPstring sip_call_to = 2;StringgetSipNumber()Optional SIP From number to use. If empty, trunk number is used.string sip_number = 15;ByteStringgetSipNumberBytes()Optional SIP From number to use. If empty, trunk number is used.string sip_number = 15;LivekitSip.CreateSIPParticipantRequest.BuildersetSipNumber(String value)Optional SIP From number to use. If empty, trunk number is used.string sip_number = 15;LivekitSip.CreateSIPParticipantRequest.BuilderclearSipNumber()Optional SIP From number to use. If empty, trunk number is used.string sip_number = 15;LivekitSip.CreateSIPParticipantRequest.BuildersetSipNumberBytes(ByteString value)Optional SIP From number to use. If empty, trunk number is used.string sip_number = 15;StringgetRoomName()What LiveKit room should this participant be connected toostring room_name = 3;ByteStringgetRoomNameBytes()What LiveKit room should this participant be connected toostring room_name = 3;LivekitSip.CreateSIPParticipantRequest.BuildersetRoomName(String value)What LiveKit room should this participant be connected toostring room_name = 3;LivekitSip.CreateSIPParticipantRequest.BuilderclearRoomName()What LiveKit room should this participant be connected toostring room_name = 3;LivekitSip.CreateSIPParticipantRequest.BuildersetRoomNameBytes(ByteString value)What LiveKit room should this participant be connected toostring room_name = 3;StringgetParticipantIdentity()Optional identity of the participant in LiveKit roomstring participant_identity = 4;ByteStringgetParticipantIdentityBytes()Optional identity of the participant in LiveKit roomstring participant_identity = 4;LivekitSip.CreateSIPParticipantRequest.BuildersetParticipantIdentity(String value)Optional identity of the participant in LiveKit roomstring participant_identity = 4;LivekitSip.CreateSIPParticipantRequest.BuilderclearParticipantIdentity()Optional identity of the participant in LiveKit roomstring participant_identity = 4;LivekitSip.CreateSIPParticipantRequest.BuildersetParticipantIdentityBytes(ByteString value)Optional identity of the participant in LiveKit roomstring participant_identity = 4;StringgetParticipantName()Optional name of the participant in LiveKit roomstring participant_name = 7;ByteStringgetParticipantNameBytes()Optional name of the participant in LiveKit roomstring participant_name = 7;LivekitSip.CreateSIPParticipantRequest.BuildersetParticipantName(String value)Optional name of the participant in LiveKit roomstring participant_name = 7;LivekitSip.CreateSIPParticipantRequest.BuilderclearParticipantName()Optional name of the participant in LiveKit roomstring participant_name = 7;LivekitSip.CreateSIPParticipantRequest.BuildersetParticipantNameBytes(ByteString value)Optional name of the participant in LiveKit roomstring participant_name = 7;StringgetParticipantMetadata()Optional user-defined metadata. Will be attached to a created Participant in the room.string participant_metadata = 8;ByteStringgetParticipantMetadataBytes()Optional user-defined metadata. Will be attached to a created Participant in the room.string participant_metadata = 8;LivekitSip.CreateSIPParticipantRequest.BuildersetParticipantMetadata(String value)Optional user-defined metadata. Will be attached to a created Participant in the room.string participant_metadata = 8;LivekitSip.CreateSIPParticipantRequest.BuilderclearParticipantMetadata()Optional user-defined metadata. Will be attached to a created Participant in the room.string participant_metadata = 8;LivekitSip.CreateSIPParticipantRequest.BuildersetParticipantMetadataBytes(ByteString value)Optional user-defined metadata. Will be attached to a created Participant in the room.string participant_metadata = 8;intgetParticipantAttributesCount()Optional user-defined attributes. Will be attached to a created Participant in the room.map<string, string> participant_attributes = 9;booleancontainsParticipantAttributes(String key)Optional user-defined attributes. Will be attached to a created Participant in the room.map<string, string> participant_attributes = 9;LivekitSip.CreateSIPParticipantRequest.BuilderclearParticipantAttributes()LivekitSip.CreateSIPParticipantRequest.BuilderremoveParticipantAttributes(String key)Optional user-defined attributes. Will be attached to a created Participant in the room.map<string, string> participant_attributes = 9;Map<String, String>getParticipantAttributes()Use getParticipantAttributesMap instead. Map<String, String>getParticipantAttributesMap()Optional user-defined attributes. Will be attached to a created Participant in the room.map<string, string> participant_attributes = 9;StringgetParticipantAttributesOrDefault(String key, String defaultValue)Optional user-defined attributes. Will be attached to a created Participant in the room.map<string, string> participant_attributes = 9;StringgetParticipantAttributesOrThrow(String key)Optional user-defined attributes. Will be attached to a created Participant in the room.map<string, string> participant_attributes = 9;LivekitSip.CreateSIPParticipantRequest.BuilderputParticipantAttributes(String key, String value)Optional user-defined attributes. Will be attached to a created Participant in the room.map<string, string> participant_attributes = 9;LivekitSip.CreateSIPParticipantRequest.BuilderputAllParticipantAttributes(Map<String, String> values)Optional user-defined attributes. Will be attached to a created Participant in the room.map<string, string> participant_attributes = 9;StringgetDtmf()Optionally send following DTMF digits (extension codes) when making a call. Character 'w' can be used to add a 0.5 sec delay.string dtmf = 5;ByteStringgetDtmfBytes()Optionally send following DTMF digits (extension codes) when making a call. Character 'w' can be used to add a 0.5 sec delay.string dtmf = 5;LivekitSip.CreateSIPParticipantRequest.BuildersetDtmf(String value)Optionally send following DTMF digits (extension codes) when making a call. Character 'w' can be used to add a 0.5 sec delay.string dtmf = 5;LivekitSip.CreateSIPParticipantRequest.BuilderclearDtmf()Optionally send following DTMF digits (extension codes) when making a call. Character 'w' can be used to add a 0.5 sec delay.string dtmf = 5;LivekitSip.CreateSIPParticipantRequest.BuildersetDtmfBytes(ByteString value)Optionally send following DTMF digits (extension codes) when making a call. Character 'w' can be used to add a 0.5 sec delay.string dtmf = 5;booleangetPlayRingtone()Optionally play dialtone in the room as an audible indicator for existing participants. The `play_ringtone` option is deprectated but has the same effect.bool play_ringtone = 6 [deprecated = true];LivekitSip.CreateSIPParticipantRequest.BuildersetPlayRingtone(boolean value)Optionally play dialtone in the room as an audible indicator for existing participants. The `play_ringtone` option is deprectated but has the same effect.bool play_ringtone = 6 [deprecated = true];LivekitSip.CreateSIPParticipantRequest.BuilderclearPlayRingtone()Optionally play dialtone in the room as an audible indicator for existing participants. The `play_ringtone` option is deprectated but has the same effect.bool play_ringtone = 6 [deprecated = true];booleangetPlayDialtone()bool play_dialtone = 13;LivekitSip.CreateSIPParticipantRequest.BuildersetPlayDialtone(boolean value)bool play_dialtone = 13;LivekitSip.CreateSIPParticipantRequest.BuilderclearPlayDialtone()bool play_dialtone = 13;booleangetHidePhoneNumber()By default the From value (Phone number) is used for participant name/identity (if not set) and added to attributes. If true, a random value for identity will be used and numbers will be omitted from attributes.bool hide_phone_number = 10;LivekitSip.CreateSIPParticipantRequest.BuildersetHidePhoneNumber(boolean value)By default the From value (Phone number) is used for participant name/identity (if not set) and added to attributes. If true, a random value for identity will be used and numbers will be omitted from attributes.bool hide_phone_number = 10;LivekitSip.CreateSIPParticipantRequest.BuilderclearHidePhoneNumber()By default the From value (Phone number) is used for participant name/identity (if not set) and added to attributes. If true, a random value for identity will be used and numbers will be omitted from attributes.bool hide_phone_number = 10;intgetHeadersCount()These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.map<string, string> headers = 16;booleancontainsHeaders(String key)These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.map<string, string> headers = 16;LivekitSip.CreateSIPParticipantRequest.BuilderclearHeaders()LivekitSip.CreateSIPParticipantRequest.BuilderremoveHeaders(String key)These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.map<string, string> headers = 16;Map<String, String>getHeaders()Use getHeadersMap instead. Map<String, String>getHeadersMap()These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.map<string, string> headers = 16;StringgetHeadersOrDefault(String key, String defaultValue)These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.map<string, string> headers = 16;StringgetHeadersOrThrow(String key)These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.map<string, string> headers = 16;LivekitSip.CreateSIPParticipantRequest.BuilderputHeaders(String key, String value)These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.map<string, string> headers = 16;LivekitSip.CreateSIPParticipantRequest.BuilderputAllHeaders(Map<String, String> values)These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.map<string, string> headers = 16;intgetIncludeHeadersValue()Map SIP headers from 200 OK to sip.h.* participant attributes automatically. When the names of required headers is known, using headers_to_attributes is strongly recommended. When mapping 200 OK headers to follow-up request headers with attributes_to_headers map, lowercase header names should be used, for example: sip.h.x-custom-header..livekit.SIPHeaderOptions include_headers = 17;LivekitSip.CreateSIPParticipantRequest.BuildersetIncludeHeadersValue(int value)Map SIP headers from 200 OK to sip.h.* participant attributes automatically. When the names of required headers is known, using headers_to_attributes is strongly recommended. When mapping 200 OK headers to follow-up request headers with attributes_to_headers map, lowercase header names should be used, for example: sip.h.x-custom-header..livekit.SIPHeaderOptions include_headers = 17;LivekitSip.SIPHeaderOptionsgetIncludeHeaders()Map SIP headers from 200 OK to sip.h.* participant attributes automatically. When the names of required headers is known, using headers_to_attributes is strongly recommended. When mapping 200 OK headers to follow-up request headers with attributes_to_headers map, lowercase header names should be used, for example: sip.h.x-custom-header..livekit.SIPHeaderOptions include_headers = 17;LivekitSip.CreateSIPParticipantRequest.BuildersetIncludeHeaders(LivekitSip.SIPHeaderOptions value)Map SIP headers from 200 OK to sip.h.* participant attributes automatically. When the names of required headers is known, using headers_to_attributes is strongly recommended. When mapping 200 OK headers to follow-up request headers with attributes_to_headers map, lowercase header names should be used, for example: sip.h.x-custom-header..livekit.SIPHeaderOptions include_headers = 17;LivekitSip.CreateSIPParticipantRequest.BuilderclearIncludeHeaders()Map SIP headers from 200 OK to sip.h.* participant attributes automatically. When the names of required headers is known, using headers_to_attributes is strongly recommended. When mapping 200 OK headers to follow-up request headers with attributes_to_headers map, lowercase header names should be used, for example: sip.h.x-custom-header..livekit.SIPHeaderOptions include_headers = 17;booleanhasRingingTimeout()Max time for the callee to answer the call..google.protobuf.Duration ringing_timeout = 11;DurationgetRingingTimeout()Max time for the callee to answer the call..google.protobuf.Duration ringing_timeout = 11;LivekitSip.CreateSIPParticipantRequest.BuildersetRingingTimeout(Duration value)Max time for the callee to answer the call..google.protobuf.Duration ringing_timeout = 11;LivekitSip.CreateSIPParticipantRequest.BuildersetRingingTimeout(Duration.Builder builderForValue)Max time for the callee to answer the call..google.protobuf.Duration ringing_timeout = 11;LivekitSip.CreateSIPParticipantRequest.BuildermergeRingingTimeout(Duration value)Max time for the callee to answer the call..google.protobuf.Duration ringing_timeout = 11;LivekitSip.CreateSIPParticipantRequest.BuilderclearRingingTimeout()Max time for the callee to answer the call..google.protobuf.Duration ringing_timeout = 11;booleanhasMaxCallDuration()Max call duration..google.protobuf.Duration max_call_duration = 12;DurationgetMaxCallDuration()Max call duration..google.protobuf.Duration max_call_duration = 12;LivekitSip.CreateSIPParticipantRequest.BuildersetMaxCallDuration(Duration value)Max call duration..google.protobuf.Duration max_call_duration = 12;LivekitSip.CreateSIPParticipantRequest.BuildersetMaxCallDuration(Duration.Builder builderForValue)Max call duration..google.protobuf.Duration max_call_duration = 12;LivekitSip.CreateSIPParticipantRequest.BuildermergeMaxCallDuration(Duration value)Max call duration..google.protobuf.Duration max_call_duration = 12;LivekitSip.CreateSIPParticipantRequest.BuilderclearMaxCallDuration()Max call duration..google.protobuf.Duration max_call_duration = 12;booleangetKrispEnabled()Enable voice isolation for the callee.bool krisp_enabled = 14;LivekitSip.CreateSIPParticipantRequest.BuildersetKrispEnabled(boolean value)Enable voice isolation for the callee.bool krisp_enabled = 14;LivekitSip.CreateSIPParticipantRequest.BuilderclearKrispEnabled()Enable voice isolation for the callee.bool krisp_enabled = 14;intgetMediaEncryptionValue().livekit.SIPMediaEncryption media_encryption = 18;LivekitSip.CreateSIPParticipantRequest.BuildersetMediaEncryptionValue(int value).livekit.SIPMediaEncryption media_encryption = 18;LivekitSip.SIPMediaEncryptiongetMediaEncryption().livekit.SIPMediaEncryption media_encryption = 18;LivekitSip.CreateSIPParticipantRequest.BuildersetMediaEncryption(LivekitSip.SIPMediaEncryption value).livekit.SIPMediaEncryption media_encryption = 18;LivekitSip.CreateSIPParticipantRequest.BuilderclearMediaEncryption().livekit.SIPMediaEncryption media_encryption = 18;booleangetWaitUntilAnswered()Wait for the answer for the call before returning.bool wait_until_answered = 19;LivekitSip.CreateSIPParticipantRequest.BuildersetWaitUntilAnswered(boolean value)Wait for the answer for the call before returning.bool wait_until_answered = 19;LivekitSip.CreateSIPParticipantRequest.BuilderclearWaitUntilAnswered()Wait for the answer for the call before returning.bool wait_until_answered = 19;booleanhasDisplayName()Optional display name for the 'From' SIP header. Cases: 1) Unspecified: Use legacy behavior - display name will be set to be the caller's number. 2) Empty string: Do not send a display name, which will result in a CNAM lookup downstream. 3) Non-empty: Use the specified value as the display name.optional string display_name = 21;StringgetDisplayName()Optional display name for the 'From' SIP header. Cases: 1) Unspecified: Use legacy behavior - display name will be set to be the caller's number. 2) Empty string: Do not send a display name, which will result in a CNAM lookup downstream. 3) Non-empty: Use the specified value as the display name.optional string display_name = 21;ByteStringgetDisplayNameBytes()Optional display name for the 'From' SIP header. Cases: 1) Unspecified: Use legacy behavior - display name will be set to be the caller's number. 2) Empty string: Do not send a display name, which will result in a CNAM lookup downstream. 3) Non-empty: Use the specified value as the display name.optional string display_name = 21;LivekitSip.CreateSIPParticipantRequest.BuildersetDisplayName(String value)Optional display name for the 'From' SIP header. Cases: 1) Unspecified: Use legacy behavior - display name will be set to be the caller's number. 2) Empty string: Do not send a display name, which will result in a CNAM lookup downstream. 3) Non-empty: Use the specified value as the display name.optional string display_name = 21;LivekitSip.CreateSIPParticipantRequest.BuilderclearDisplayName()Optional display name for the 'From' SIP header. Cases: 1) Unspecified: Use legacy behavior - display name will be set to be the caller's number. 2) Empty string: Do not send a display name, which will result in a CNAM lookup downstream. 3) Non-empty: Use the specified value as the display name.optional string display_name = 21;LivekitSip.CreateSIPParticipantRequest.BuildersetDisplayNameBytes(ByteString value)Optional display name for the 'From' SIP header. Cases: 1) Unspecified: Use legacy behavior - display name will be set to be the caller's number. 2) Empty string: Do not send a display name, which will result in a CNAM lookup downstream. 3) Non-empty: Use the specified value as the display name.optional string display_name = 21;-
Methods inherited from class com.google.protobuf.GeneratedMessageLite.Builder
build, buildPartial, clear, clone, getDefaultInstanceForType, isInitialized, mergeFrom -
Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
mergeDelimitedFrom -
Methods inherited from class com.google.protobuf.MessageLite.Builder
build, buildPartial, clear, clone, mergeFrom -
Methods inherited from class com.google.protobuf.MessageLiteOrBuilder
getDefaultInstanceForType -
Methods inherited from class livekit.LivekitSip.CreateSIPParticipantRequestOrBuilder
containsHeaders, containsParticipantAttributes, getHeadersOrDefault, getHeadersOrThrow, getParticipantAttributesOrDefault, getParticipantAttributesOrThrow -
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
-
Method Detail
-
getSipTrunkId
String getSipTrunkId()
What SIP Trunk should be used to dial the userstring sip_trunk_id = 1;
-
getSipTrunkIdBytes
ByteString getSipTrunkIdBytes()
What SIP Trunk should be used to dial the userstring sip_trunk_id = 1;
-
setSipTrunkId
LivekitSip.CreateSIPParticipantRequest.Builder setSipTrunkId(String value)
What SIP Trunk should be used to dial the userstring sip_trunk_id = 1;- Parameters:
value- The sipTrunkId to set.
-
clearSipTrunkId
LivekitSip.CreateSIPParticipantRequest.Builder clearSipTrunkId()
What SIP Trunk should be used to dial the userstring sip_trunk_id = 1;
-
setSipTrunkIdBytes
LivekitSip.CreateSIPParticipantRequest.Builder setSipTrunkIdBytes(ByteString value)
What SIP Trunk should be used to dial the userstring sip_trunk_id = 1;- Parameters:
value- The bytes for sipTrunkId to set.
-
hasTrunk
boolean hasTrunk()
.livekit.SIPOutboundConfig trunk = 20;
-
getTrunk
LivekitSip.SIPOutboundConfig getTrunk()
.livekit.SIPOutboundConfig trunk = 20;
-
setTrunk
LivekitSip.CreateSIPParticipantRequest.Builder setTrunk(LivekitSip.SIPOutboundConfig value)
.livekit.SIPOutboundConfig trunk = 20;
-
setTrunk
LivekitSip.CreateSIPParticipantRequest.Builder setTrunk(LivekitSip.SIPOutboundConfig.Builder builderForValue)
.livekit.SIPOutboundConfig trunk = 20;
-
mergeTrunk
LivekitSip.CreateSIPParticipantRequest.Builder mergeTrunk(LivekitSip.SIPOutboundConfig value)
.livekit.SIPOutboundConfig trunk = 20;
-
clearTrunk
LivekitSip.CreateSIPParticipantRequest.Builder clearTrunk()
.livekit.SIPOutboundConfig trunk = 20;
-
getSipCallTo
String getSipCallTo()
What number should be dialed via SIPstring sip_call_to = 2;
-
getSipCallToBytes
ByteString getSipCallToBytes()
What number should be dialed via SIPstring sip_call_to = 2;
-
setSipCallTo
LivekitSip.CreateSIPParticipantRequest.Builder setSipCallTo(String value)
What number should be dialed via SIPstring sip_call_to = 2;- Parameters:
value- The sipCallTo to set.
-
clearSipCallTo
LivekitSip.CreateSIPParticipantRequest.Builder clearSipCallTo()
What number should be dialed via SIPstring sip_call_to = 2;
-
setSipCallToBytes
LivekitSip.CreateSIPParticipantRequest.Builder setSipCallToBytes(ByteString value)
What number should be dialed via SIPstring sip_call_to = 2;- Parameters:
value- The bytes for sipCallTo to set.
-
getSipNumber
String getSipNumber()
Optional SIP From number to use. If empty, trunk number is used.string sip_number = 15;
-
getSipNumberBytes
ByteString getSipNumberBytes()
Optional SIP From number to use. If empty, trunk number is used.string sip_number = 15;
-
setSipNumber
LivekitSip.CreateSIPParticipantRequest.Builder setSipNumber(String value)
Optional SIP From number to use. If empty, trunk number is used.string sip_number = 15;- Parameters:
value- The sipNumber to set.
-
clearSipNumber
LivekitSip.CreateSIPParticipantRequest.Builder clearSipNumber()
Optional SIP From number to use. If empty, trunk number is used.string sip_number = 15;
-
setSipNumberBytes
LivekitSip.CreateSIPParticipantRequest.Builder setSipNumberBytes(ByteString value)
Optional SIP From number to use. If empty, trunk number is used.string sip_number = 15;- Parameters:
value- The bytes for sipNumber to set.
-
getRoomName
String getRoomName()
What LiveKit room should this participant be connected toostring room_name = 3;
-
getRoomNameBytes
ByteString getRoomNameBytes()
What LiveKit room should this participant be connected toostring room_name = 3;
-
setRoomName
LivekitSip.CreateSIPParticipantRequest.Builder setRoomName(String value)
What LiveKit room should this participant be connected toostring room_name = 3;- Parameters:
value- The roomName to set.
-
clearRoomName
LivekitSip.CreateSIPParticipantRequest.Builder clearRoomName()
What LiveKit room should this participant be connected toostring room_name = 3;
-
setRoomNameBytes
LivekitSip.CreateSIPParticipantRequest.Builder setRoomNameBytes(ByteString value)
What LiveKit room should this participant be connected toostring room_name = 3;- Parameters:
value- The bytes for roomName to set.
-
getParticipantIdentity
String getParticipantIdentity()
Optional identity of the participant in LiveKit roomstring participant_identity = 4;
-
getParticipantIdentityBytes
ByteString getParticipantIdentityBytes()
Optional identity of the participant in LiveKit roomstring participant_identity = 4;
-
setParticipantIdentity
LivekitSip.CreateSIPParticipantRequest.Builder setParticipantIdentity(String value)
Optional identity of the participant in LiveKit roomstring participant_identity = 4;- Parameters:
value- The participantIdentity to set.
-
clearParticipantIdentity
LivekitSip.CreateSIPParticipantRequest.Builder clearParticipantIdentity()
Optional identity of the participant in LiveKit roomstring participant_identity = 4;
-
setParticipantIdentityBytes
LivekitSip.CreateSIPParticipantRequest.Builder setParticipantIdentityBytes(ByteString value)
Optional identity of the participant in LiveKit roomstring participant_identity = 4;- Parameters:
value- The bytes for participantIdentity to set.
-
getParticipantName
String getParticipantName()
Optional name of the participant in LiveKit roomstring participant_name = 7;
-
getParticipantNameBytes
ByteString getParticipantNameBytes()
Optional name of the participant in LiveKit roomstring participant_name = 7;
-
setParticipantName
LivekitSip.CreateSIPParticipantRequest.Builder setParticipantName(String value)
Optional name of the participant in LiveKit roomstring participant_name = 7;- Parameters:
value- The participantName to set.
-
clearParticipantName
LivekitSip.CreateSIPParticipantRequest.Builder clearParticipantName()
Optional name of the participant in LiveKit roomstring participant_name = 7;
-
setParticipantNameBytes
LivekitSip.CreateSIPParticipantRequest.Builder setParticipantNameBytes(ByteString value)
Optional name of the participant in LiveKit roomstring participant_name = 7;- Parameters:
value- The bytes for participantName to set.
-
getParticipantMetadata
String getParticipantMetadata()
Optional user-defined metadata. Will be attached to a created Participant in the room.string participant_metadata = 8;
-
getParticipantMetadataBytes
ByteString getParticipantMetadataBytes()
Optional user-defined metadata. Will be attached to a created Participant in the room.string participant_metadata = 8;
-
setParticipantMetadata
LivekitSip.CreateSIPParticipantRequest.Builder setParticipantMetadata(String value)
Optional user-defined metadata. Will be attached to a created Participant in the room.string participant_metadata = 8;- Parameters:
value- The participantMetadata to set.
-
clearParticipantMetadata
LivekitSip.CreateSIPParticipantRequest.Builder clearParticipantMetadata()
Optional user-defined metadata. Will be attached to a created Participant in the room.string participant_metadata = 8;
-
setParticipantMetadataBytes
LivekitSip.CreateSIPParticipantRequest.Builder setParticipantMetadataBytes(ByteString value)
Optional user-defined metadata. Will be attached to a created Participant in the room.string participant_metadata = 8;- Parameters:
value- The bytes for participantMetadata to set.
-
getParticipantAttributesCount
int getParticipantAttributesCount()
Optional user-defined attributes. Will be attached to a created Participant in the room.map<string, string> participant_attributes = 9;
-
containsParticipantAttributes
boolean containsParticipantAttributes(String key)
Optional user-defined attributes. Will be attached to a created Participant in the room.map<string, string> participant_attributes = 9;
-
clearParticipantAttributes
LivekitSip.CreateSIPParticipantRequest.Builder clearParticipantAttributes()
-
removeParticipantAttributes
LivekitSip.CreateSIPParticipantRequest.Builder removeParticipantAttributes(String key)
Optional user-defined attributes. Will be attached to a created Participant in the room.map<string, string> participant_attributes = 9;
-
getParticipantAttributes
@Deprecated() Map<String, String> getParticipantAttributes()
Use getParticipantAttributesMap instead.
-
getParticipantAttributesMap
Map<String, String> getParticipantAttributesMap()
Optional user-defined attributes. Will be attached to a created Participant in the room.map<string, string> participant_attributes = 9;
-
getParticipantAttributesOrDefault
String getParticipantAttributesOrDefault(String key, String defaultValue)
Optional user-defined attributes. Will be attached to a created Participant in the room.map<string, string> participant_attributes = 9;
-
getParticipantAttributesOrThrow
String getParticipantAttributesOrThrow(String key)
Optional user-defined attributes. Will be attached to a created Participant in the room.map<string, string> participant_attributes = 9;
-
putParticipantAttributes
LivekitSip.CreateSIPParticipantRequest.Builder putParticipantAttributes(String key, String value)
Optional user-defined attributes. Will be attached to a created Participant in the room.map<string, string> participant_attributes = 9;
-
putAllParticipantAttributes
LivekitSip.CreateSIPParticipantRequest.Builder putAllParticipantAttributes(Map<String, String> values)
Optional user-defined attributes. Will be attached to a created Participant in the room.map<string, string> participant_attributes = 9;
-
getDtmf
String getDtmf()
Optionally send following DTMF digits (extension codes) when making a call. Character 'w' can be used to add a 0.5 sec delay.string dtmf = 5;
-
getDtmfBytes
ByteString getDtmfBytes()
Optionally send following DTMF digits (extension codes) when making a call. Character 'w' can be used to add a 0.5 sec delay.string dtmf = 5;
-
setDtmf
LivekitSip.CreateSIPParticipantRequest.Builder setDtmf(String value)
Optionally send following DTMF digits (extension codes) when making a call. Character 'w' can be used to add a 0.5 sec delay.string dtmf = 5;- Parameters:
value- The dtmf to set.
-
clearDtmf
LivekitSip.CreateSIPParticipantRequest.Builder clearDtmf()
Optionally send following DTMF digits (extension codes) when making a call. Character 'w' can be used to add a 0.5 sec delay.string dtmf = 5;
-
setDtmfBytes
LivekitSip.CreateSIPParticipantRequest.Builder setDtmfBytes(ByteString value)
Optionally send following DTMF digits (extension codes) when making a call. Character 'w' can be used to add a 0.5 sec delay.string dtmf = 5;- Parameters:
value- The bytes for dtmf to set.
-
getPlayRingtone
@Deprecated() boolean getPlayRingtone()
Optionally play dialtone in the room as an audible indicator for existing participants. The `play_ringtone` option is deprectated but has the same effect.bool play_ringtone = 6 [deprecated = true];
-
setPlayRingtone
@Deprecated() LivekitSip.CreateSIPParticipantRequest.Builder setPlayRingtone(boolean value)
Optionally play dialtone in the room as an audible indicator for existing participants. The `play_ringtone` option is deprectated but has the same effect.bool play_ringtone = 6 [deprecated = true];- Parameters:
value- The playRingtone to set.
-
clearPlayRingtone
@Deprecated() LivekitSip.CreateSIPParticipantRequest.Builder clearPlayRingtone()
Optionally play dialtone in the room as an audible indicator for existing participants. The `play_ringtone` option is deprectated but has the same effect.bool play_ringtone = 6 [deprecated = true];
-
getPlayDialtone
boolean getPlayDialtone()
bool play_dialtone = 13;
-
setPlayDialtone
LivekitSip.CreateSIPParticipantRequest.Builder setPlayDialtone(boolean value)
bool play_dialtone = 13;- Parameters:
value- The playDialtone to set.
-
clearPlayDialtone
LivekitSip.CreateSIPParticipantRequest.Builder clearPlayDialtone()
bool play_dialtone = 13;
-
getHidePhoneNumber
boolean getHidePhoneNumber()
By default the From value (Phone number) is used for participant name/identity (if not set) and added to attributes. If true, a random value for identity will be used and numbers will be omitted from attributes.bool hide_phone_number = 10;
-
setHidePhoneNumber
LivekitSip.CreateSIPParticipantRequest.Builder setHidePhoneNumber(boolean value)
By default the From value (Phone number) is used for participant name/identity (if not set) and added to attributes. If true, a random value for identity will be used and numbers will be omitted from attributes.bool hide_phone_number = 10;- Parameters:
value- The hidePhoneNumber to set.
-
clearHidePhoneNumber
LivekitSip.CreateSIPParticipantRequest.Builder clearHidePhoneNumber()
By default the From value (Phone number) is used for participant name/identity (if not set) and added to attributes. If true, a random value for identity will be used and numbers will be omitted from attributes.bool hide_phone_number = 10;
-
getHeadersCount
int getHeadersCount()
These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.map<string, string> headers = 16;
-
containsHeaders
boolean containsHeaders(String key)
These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.map<string, string> headers = 16;
-
clearHeaders
LivekitSip.CreateSIPParticipantRequest.Builder clearHeaders()
-
removeHeaders
LivekitSip.CreateSIPParticipantRequest.Builder removeHeaders(String key)
These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.map<string, string> headers = 16;
-
getHeaders
@Deprecated() Map<String, String> getHeaders()
Use getHeadersMap instead.
-
getHeadersMap
Map<String, String> getHeadersMap()
These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.map<string, string> headers = 16;
-
getHeadersOrDefault
String getHeadersOrDefault(String key, String defaultValue)
These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.map<string, string> headers = 16;
-
getHeadersOrThrow
String getHeadersOrThrow(String key)
These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.map<string, string> headers = 16;
-
putHeaders
LivekitSip.CreateSIPParticipantRequest.Builder putHeaders(String key, String value)
These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.map<string, string> headers = 16;
-
putAllHeaders
LivekitSip.CreateSIPParticipantRequest.Builder putAllHeaders(Map<String, String> values)
These headers are sent as-is and may help identify this call as coming from LiveKit for the other SIP endpoint.map<string, string> headers = 16;
-
getIncludeHeadersValue
int getIncludeHeadersValue()
Map SIP headers from 200 OK to sip.h.* participant attributes automatically. When the names of required headers is known, using headers_to_attributes is strongly recommended. When mapping 200 OK headers to follow-up request headers with attributes_to_headers map, lowercase header names should be used, for example: sip.h.x-custom-header..livekit.SIPHeaderOptions include_headers = 17;
-
setIncludeHeadersValue
LivekitSip.CreateSIPParticipantRequest.Builder setIncludeHeadersValue(int value)
Map SIP headers from 200 OK to sip.h.* participant attributes automatically. When the names of required headers is known, using headers_to_attributes is strongly recommended. When mapping 200 OK headers to follow-up request headers with attributes_to_headers map, lowercase header names should be used, for example: sip.h.x-custom-header..livekit.SIPHeaderOptions include_headers = 17;- Parameters:
value- The includeHeaders to set.
-
getIncludeHeaders
LivekitSip.SIPHeaderOptions getIncludeHeaders()
Map SIP headers from 200 OK to sip.h.* participant attributes automatically. When the names of required headers is known, using headers_to_attributes is strongly recommended. When mapping 200 OK headers to follow-up request headers with attributes_to_headers map, lowercase header names should be used, for example: sip.h.x-custom-header..livekit.SIPHeaderOptions include_headers = 17;
-
setIncludeHeaders
LivekitSip.CreateSIPParticipantRequest.Builder setIncludeHeaders(LivekitSip.SIPHeaderOptions value)
Map SIP headers from 200 OK to sip.h.* participant attributes automatically. When the names of required headers is known, using headers_to_attributes is strongly recommended. When mapping 200 OK headers to follow-up request headers with attributes_to_headers map, lowercase header names should be used, for example: sip.h.x-custom-header..livekit.SIPHeaderOptions include_headers = 17;- Parameters:
value- The enum numeric value on the wire for includeHeaders to set.
-
clearIncludeHeaders
LivekitSip.CreateSIPParticipantRequest.Builder clearIncludeHeaders()
Map SIP headers from 200 OK to sip.h.* participant attributes automatically. When the names of required headers is known, using headers_to_attributes is strongly recommended. When mapping 200 OK headers to follow-up request headers with attributes_to_headers map, lowercase header names should be used, for example: sip.h.x-custom-header..livekit.SIPHeaderOptions include_headers = 17;
-
hasRingingTimeout
boolean hasRingingTimeout()
Max time for the callee to answer the call..google.protobuf.Duration ringing_timeout = 11;
-
getRingingTimeout
Duration getRingingTimeout()
Max time for the callee to answer the call..google.protobuf.Duration ringing_timeout = 11;
-
setRingingTimeout
LivekitSip.CreateSIPParticipantRequest.Builder setRingingTimeout(Duration value)
Max time for the callee to answer the call..google.protobuf.Duration ringing_timeout = 11;
-
setRingingTimeout
LivekitSip.CreateSIPParticipantRequest.Builder setRingingTimeout(Duration.Builder builderForValue)
Max time for the callee to answer the call..google.protobuf.Duration ringing_timeout = 11;
-
mergeRingingTimeout
LivekitSip.CreateSIPParticipantRequest.Builder mergeRingingTimeout(Duration value)
Max time for the callee to answer the call..google.protobuf.Duration ringing_timeout = 11;
-
clearRingingTimeout
LivekitSip.CreateSIPParticipantRequest.Builder clearRingingTimeout()
Max time for the callee to answer the call..google.protobuf.Duration ringing_timeout = 11;
-
hasMaxCallDuration
boolean hasMaxCallDuration()
Max call duration..google.protobuf.Duration max_call_duration = 12;
-
getMaxCallDuration
Duration getMaxCallDuration()
Max call duration..google.protobuf.Duration max_call_duration = 12;
-
setMaxCallDuration
LivekitSip.CreateSIPParticipantRequest.Builder setMaxCallDuration(Duration value)
Max call duration..google.protobuf.Duration max_call_duration = 12;
-
setMaxCallDuration
LivekitSip.CreateSIPParticipantRequest.Builder setMaxCallDuration(Duration.Builder builderForValue)
Max call duration..google.protobuf.Duration max_call_duration = 12;
-
mergeMaxCallDuration
LivekitSip.CreateSIPParticipantRequest.Builder mergeMaxCallDuration(Duration value)
Max call duration..google.protobuf.Duration max_call_duration = 12;
-
clearMaxCallDuration
LivekitSip.CreateSIPParticipantRequest.Builder clearMaxCallDuration()
Max call duration..google.protobuf.Duration max_call_duration = 12;
-
getKrispEnabled
boolean getKrispEnabled()
Enable voice isolation for the callee.bool krisp_enabled = 14;
-
setKrispEnabled
LivekitSip.CreateSIPParticipantRequest.Builder setKrispEnabled(boolean value)
Enable voice isolation for the callee.bool krisp_enabled = 14;- Parameters:
value- The krispEnabled to set.
-
clearKrispEnabled
LivekitSip.CreateSIPParticipantRequest.Builder clearKrispEnabled()
Enable voice isolation for the callee.bool krisp_enabled = 14;
-
getMediaEncryptionValue
int getMediaEncryptionValue()
.livekit.SIPMediaEncryption media_encryption = 18;
-
setMediaEncryptionValue
LivekitSip.CreateSIPParticipantRequest.Builder setMediaEncryptionValue(int value)
.livekit.SIPMediaEncryption media_encryption = 18;- Parameters:
value- The mediaEncryption to set.
-
getMediaEncryption
LivekitSip.SIPMediaEncryption getMediaEncryption()
.livekit.SIPMediaEncryption media_encryption = 18;
-
setMediaEncryption
LivekitSip.CreateSIPParticipantRequest.Builder setMediaEncryption(LivekitSip.SIPMediaEncryption value)
.livekit.SIPMediaEncryption media_encryption = 18;- Parameters:
value- The enum numeric value on the wire for mediaEncryption to set.
-
clearMediaEncryption
LivekitSip.CreateSIPParticipantRequest.Builder clearMediaEncryption()
.livekit.SIPMediaEncryption media_encryption = 18;
-
getWaitUntilAnswered
boolean getWaitUntilAnswered()
Wait for the answer for the call before returning.bool wait_until_answered = 19;
-
setWaitUntilAnswered
LivekitSip.CreateSIPParticipantRequest.Builder setWaitUntilAnswered(boolean value)
Wait for the answer for the call before returning.bool wait_until_answered = 19;- Parameters:
value- The waitUntilAnswered to set.
-
clearWaitUntilAnswered
LivekitSip.CreateSIPParticipantRequest.Builder clearWaitUntilAnswered()
Wait for the answer for the call before returning.bool wait_until_answered = 19;
-
hasDisplayName
boolean hasDisplayName()
Optional display name for the 'From' SIP header. Cases: 1) Unspecified: Use legacy behavior - display name will be set to be the caller's number. 2) Empty string: Do not send a display name, which will result in a CNAM lookup downstream. 3) Non-empty: Use the specified value as the display name.optional string display_name = 21;
-
getDisplayName
String getDisplayName()
Optional display name for the 'From' SIP header. Cases: 1) Unspecified: Use legacy behavior - display name will be set to be the caller's number. 2) Empty string: Do not send a display name, which will result in a CNAM lookup downstream. 3) Non-empty: Use the specified value as the display name.optional string display_name = 21;
-
getDisplayNameBytes
ByteString getDisplayNameBytes()
Optional display name for the 'From' SIP header. Cases: 1) Unspecified: Use legacy behavior - display name will be set to be the caller's number. 2) Empty string: Do not send a display name, which will result in a CNAM lookup downstream. 3) Non-empty: Use the specified value as the display name.optional string display_name = 21;
-
setDisplayName
LivekitSip.CreateSIPParticipantRequest.Builder setDisplayName(String value)
Optional display name for the 'From' SIP header. Cases: 1) Unspecified: Use legacy behavior - display name will be set to be the caller's number. 2) Empty string: Do not send a display name, which will result in a CNAM lookup downstream. 3) Non-empty: Use the specified value as the display name.optional string display_name = 21;- Parameters:
value- The displayName to set.
-
clearDisplayName
LivekitSip.CreateSIPParticipantRequest.Builder clearDisplayName()
Optional display name for the 'From' SIP header. Cases: 1) Unspecified: Use legacy behavior - display name will be set to be the caller's number. 2) Empty string: Do not send a display name, which will result in a CNAM lookup downstream. 3) Non-empty: Use the specified value as the display name.optional string display_name = 21;
-
setDisplayNameBytes
LivekitSip.CreateSIPParticipantRequest.Builder setDisplayNameBytes(ByteString value)
Optional display name for the 'From' SIP header. Cases: 1) Unspecified: Use legacy behavior - display name will be set to be the caller's number. 2) Empty string: Do not send a display name, which will result in a CNAM lookup downstream. 3) Non-empty: Use the specified value as the display name.optional string display_name = 21;- Parameters:
value- The bytes for displayName to set.
-
-
-
-