Package com.mux.sdk.webrtc.spaces

Class SpaceConfiguration.Builder

java.lang.Object

com.mux.sdk.webrtc.spaces.SpaceConfiguration.Builder

Enclosing class:

SpaceConfiguration

public static class SpaceConfiguration.Builder
extends java.lang.Object

A class for building SpaceConfigurations using the builder pattern.

Method Summary

Modifier and Type	Method	Description
SpaceConfiguration	build()
SpaceConfiguration.Builder	setId(java.lang.String spaceId)
SpaceConfiguration.Builder	setJWT(java.lang.String rawToken)	Set the complete JWT value
SpaceConfiguration.Builder	setManagedSubscriptions(boolean managedSubscriptions)	Set if we should default to managed (i.e.
SpaceConfiguration.Builder	setManagedSubscriptions(int managedSubscriptions)	Directly set the number of things to subscribe to 0 means it's manual
SpaceConfiguration.Builder	setParticipantId(java.lang.String participantId)	Sets the participant ID for joining the Space This is optional.
SpaceConfiguration.Builder	setRole(Signals.Participant.ParticipantRole role)	Set the Role for the participant that will join

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setId

public SpaceConfiguration.Builder setId(java.lang.String spaceId)

setParticipantId

public SpaceConfiguration.Builder setParticipantId(java.lang.String participantId)

Sets the participant ID for joining the Space This is optional. If a JWT is provided it must be consistent with that (i.e. the JWT must not claim a different participant ID).

Parameters:

participantId -

Returns:

setManagedSubscriptions

public SpaceConfiguration.Builder setManagedSubscriptions(boolean managedSubscriptions)

Set if we should default to managed (i.e. manual) subscriptions. Managed means the server will dynamically pick a set of participants to subscribe to based on activity. Defaults to true.

Parameters:

managedSubscriptions -

Returns:

setManagedSubscriptions

public SpaceConfiguration.Builder setManagedSubscriptions(int managedSubscriptions)

Directly set the number of things to subscribe to 0 means it's manual

Parameters:

managedSubscriptions -

Returns:

setRole

public SpaceConfiguration.Builder setRole(Signals.Participant.ParticipantRole role)

Set the Role for the participant that will join

Parameters:

role -

setJWT

public SpaceConfiguration.Builder setJWT(java.lang.String rawToken)

Set the complete JWT value

Parameters:

rawToken -

Returns:

build

public SpaceConfiguration build()
                         throws SpaceConfigurationException

Throws:

SpaceConfigurationException