-
public final class CallCompositeLocalOptions
CallCompositeLocalOptions for launch.
Local Options for the Call Composite. These options are not shared with the server and impact local views only. E.g. The Local Participant Name if it differs from the display name you'd like to share with the server.
// Initialize the call composite builder final CallCompositeBuilder builder = new CallCompositeBuilder(); // Build the call composite CallComposite callComposite = builder.build(); // Build the CallCompositeLocalOptions with CallCompositeParticipantViewData CallCompositeLocalOptions localOptions = new CallCompositeLocalOptions( new CallCompositeParticipantViewData(...)); // Launch call callComposite.launch(.., .., localOptions)
-
-
Field Summary
Fields Modifier and Type Field Description private CallCompositeParticipantViewData
participantViewData
private CallCompositeSetupScreenViewData
setupScreenViewData
private boolean
cameraOn
private boolean
microphoneOn
private boolean
skipSetupScreen
private CallCompositeAudioVideoMode
audioVideoMode
private CallCompositeCaptionsOptions
captionsOptions
private CallCompositeSetupScreenOptions
setupScreenOptions
private CallCompositeCallScreenOptions
callScreenOptions
-
Constructor Summary
Constructors Constructor Description CallCompositeLocalOptions(CallCompositeParticipantViewData participantViewData)
Create LocalSettings. CallCompositeLocalOptions()
Create an empty CallCompositeLocalOptions object and assign using setters.
-
Method Summary
-
-
Constructor Detail
-
CallCompositeLocalOptions
CallCompositeLocalOptions(CallCompositeParticipantViewData participantViewData)
Create LocalSettings.- Parameters:
participantViewData
- The CallCompositeParticipantViewData;
-
CallCompositeLocalOptions
CallCompositeLocalOptions()
Create an empty CallCompositeLocalOptions object and assign using setters.
-
-
Method Detail
-
getParticipantViewData
CallCompositeParticipantViewData getParticipantViewData()
Get the CallCompositeParticipantViewData.
-
setParticipantViewData
CallCompositeLocalOptions setParticipantViewData(CallCompositeParticipantViewData participantViewData)
Set a CallCompositeParticipantViewData to be used.
- Parameters:
participantViewData
- The participant view data object to be used.
-
getSetupScreenViewData
CallCompositeSetupScreenViewData getSetupScreenViewData()
Get the CallCompositeSetupScreenViewData.
-
setSetupScreenViewData
CallCompositeLocalOptions setSetupScreenViewData(CallCompositeSetupScreenViewData setupScreenViewData)
Set a CallCompositeSetupScreenViewData to be used.
- Parameters:
setupScreenViewData
- The setup screen view data object to be used.
-
setCameraOn
CallCompositeLocalOptions setCameraOn(boolean cameraOn)
Enables the Local Camera by default.Note: If AvMode is set to Audio Only, this will have no effect
- Parameters:
cameraOn
- The boolean value to be used for initial camera configuration.
-
setMicrophoneOn
CallCompositeLocalOptions setMicrophoneOn(boolean microphoneOn)
Set a boolean to be used.
- Parameters:
microphoneOn
- The boolean value to be used for initial microphone configuration.
-
setSkipSetupScreen
CallCompositeLocalOptions setSkipSetupScreen(boolean skipSetupScreen)
Set a boolean to be used.
- Parameters:
skipSetupScreen
- The boolean value to be used.
-
getAudioVideoMode
CallCompositeAudioVideoMode getAudioVideoMode()
Returns the Audio/Video mode of the local call
-
setAudioVideoMode
CallCompositeLocalOptions setAudioVideoMode(CallCompositeAudioVideoMode audioVideoMode)
Sets the Audio/Video Mode of the local call.Currently supported (Audio Only, Audio and Video)Audio Only: This will disable the camera and incoming video feeds.Audio and Video: This will enable the camera and incoming video feeds.See CallCompositeAudioVideoMode
- Parameters:
audioVideoMode
- The CallCompositeAudioVideoMode to be used.
-
getCaptionsOptions
CallCompositeCaptionsOptions getCaptionsOptions()
Get the CallCompositeCaptionsOptions.
-
setCaptionsOptions
CallCompositeLocalOptions setCaptionsOptions(CallCompositeCaptionsOptions captionsOptions)
Set a CallCompositeCaptionsOptions to be used.
- Parameters:
captionsOptions
- The captions options object to be used.
-
getSetupScreenOptions
CallCompositeSetupScreenOptions getSetupScreenOptions()
Get setup screen options.
-
setSetupScreenOptions
CallCompositeLocalOptions setSetupScreenOptions(CallCompositeSetupScreenOptions setupScreenOptions)
Set setup screen options.
- Parameters:
setupScreenOptions
- CallCompositeSetupScreenOptions
-
getCallScreenOptions
CallCompositeCallScreenOptions getCallScreenOptions()
Get call screen options.
-
setCallScreenOptions
CallCompositeLocalOptions setCallScreenOptions(CallCompositeCallScreenOptions callScreenOptions)
Set call screen options.
- Parameters:
callScreenOptions
- CallCompositeCallScreenOptions
-
isSkipSetupScreen
boolean isSkipSetupScreen()
Get the boolean value for skip setup screen.
-
isCameraOn
boolean isCameraOn()
Get the initial camera configuration boolean value.Note: If AUDIO_ONLY mode is set, this will always return false.
-
isMicrophoneOn
boolean isMicrophoneOn()
Get the initial microphone configuration boolean value.
-
-
-
-