io.openvidu.java.client

Class SessionProperties.Builder

java.lang.Object

io.openvidu.java.client.SessionProperties.Builder

Enclosing class:

SessionProperties

public static class SessionProperties.Builder
extends Object

Builder for SessionProperties

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SessionProperties	build() Returns the SessionProperties object properly configured
SessionProperties.Builder	customSessionId(String customSessionId) Call this method to fix the sessionId that will be assigned to the session.
SessionProperties.Builder	defaultCustomLayout(String path) Call this method to set the default value used to initialize property RecordingProperties.customLayout() of every recording of this session.
SessionProperties.Builder	defaultRecordingLayout(RecordingLayout layout) Call this method to set the the default value used to initialize property RecordingProperties.recordingLayout() of every recording of this session.
SessionProperties.Builder	mediaMode(MediaMode mediaMode) Call this method to set how the media streams will be sent and received by your clients: routed through OpenVidu Media Server (MediaMode.ROUTED) or attempting direct p2p connections (MediaMode.RELAYED, not available yet) Default value is MediaMode.ROUTED
SessionProperties.Builder	recordingMode(RecordingMode recordingMode) Call this method to set whether the Session will be automatically recorded (RecordingMode.ALWAYS) or not (RecordingMode.MANUAL) Default value is RecordingMode.MANUAL

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

build

public SessionProperties build()

Returns the SessionProperties object properly configured

mediaMode

public SessionProperties.Builder mediaMode(MediaMode mediaMode)

Call this method to set how the media streams will be sent and received by your clients: routed through OpenVidu Media Server (MediaMode.ROUTED) or attempting direct p2p connections (MediaMode.RELAYED, not available yet) Default value is MediaMode.ROUTED

recordingMode

public SessionProperties.Builder recordingMode(RecordingMode recordingMode)

Call this method to set whether the Session will be automatically recorded (RecordingMode.ALWAYS) or not (RecordingMode.MANUAL) Default value is RecordingMode.MANUAL

defaultRecordingLayout

public SessionProperties.Builder defaultRecordingLayout(RecordingLayout layout)

Call this method to set the the default value used to initialize property RecordingProperties.recordingLayout() of every recording of this session. You can easily override this value later when initializing a Recording by calling RecordingProperties.Builder.recordingLayout(RecordingLayout) with any other value Default value is RecordingLayout.BEST_FIT

defaultCustomLayout

public SessionProperties.Builder defaultCustomLayout(String path)

Call this method to set the default value used to initialize property RecordingProperties.customLayout() of every recording of this session. You can easily override this value later when initializing a Recording by calling RecordingProperties.Builder.customLayout(String) with any other value

customSessionId

public SessionProperties.Builder customSessionId(String customSessionId)

Call this method to fix the sessionId that will be assigned to the session. You can take advantage of this property to facilitate the mapping between OpenVidu Server 'session' entities and your own 'session' entities. If this parameter is undefined or an empty string, OpenVidu Server will generate a random sessionId for you.