io.openvidu.java.client

Class SessionProperties

java.lang.Object

io.openvidu.java.client.SessionProperties

public class SessionProperties
extends Object

See OpenVidu.createSession(SessionProperties)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SessionProperties.Builder Builder for SessionProperties

Method Summary

Modifier and Type	Method and Description
String	customSessionId() Fixes the value of the sessionId property of the Session.
String	defaultCustomLayout() Defines the default value used to initialize property RecordingProperties.customLayout() of every recording of this session.
Recording.OutputMode	defaultOutputMode() Defines the default value used to initialize property RecordingProperties.outputMode() of every recording of this session.
RecordingLayout	defaultRecordingLayout() Defines the default value used to initialize property RecordingProperties.recordingLayout() of every recording of this session.
MediaMode	mediaMode() Defines how the media streams will be sent and received by your clients: routed through OpenVidu Media Node (MediaMode.ROUTED) or attempting direct p2p connections (MediaMode.RELAYED, not available yet)
String	mediaNode() PRO The Media Node where to host the session.
RecordingMode	recordingMode() Defines whether the Session will be automatically recorded (RecordingMode.ALWAYS) or not (RecordingMode.MANUAL)

Methods inherited from class java.lang.Object

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

Method Detail

mediaMode

public MediaMode mediaMode()

Defines how the media streams will be sent and received by your clients: routed through OpenVidu Media Node (MediaMode.ROUTED) or attempting direct p2p connections (MediaMode.RELAYED, not available yet)

recordingMode

public RecordingMode recordingMode()

Defines whether the Session will be automatically recorded (RecordingMode.ALWAYS) or not (RecordingMode.MANUAL)

defaultOutputMode

public Recording.OutputMode defaultOutputMode()

Defines the default value used to initialize property RecordingProperties.outputMode() of every recording of this session. You can easily override this value later when starting a Recording by calling RecordingProperties.Builder.outputMode(Recording.OutputMode) with any other value

defaultRecordingLayout

public RecordingLayout defaultRecordingLayout()

Defines the default value used to initialize property RecordingProperties.recordingLayout() of every recording of this session. You can easily override this value later when starting a Recording by calling RecordingProperties.Builder.recordingLayout(RecordingLayout) with any other value.
Recording layouts are only applicable to recordings with OutputMode Recording.OutputMode.COMPOSED or Recording.OutputMode.COMPOSED_QUICK_START

defaultCustomLayout

public String defaultCustomLayout()

Defines the default value used to initialize property RecordingProperties.customLayout() of every recording of this session. You can easily override this value later when starting a Recording by calling RecordingProperties.Builder.customLayout(String) with any other value.
Custom layouts are only applicable to recordings with OutputMode Recording.OutputMode.COMPOSED (or Recording.OutputMode.COMPOSED_QUICK_START) and RecordingLayout RecordingLayout.CUSTOM

customSessionId

public String customSessionId()

Fixes the value of the sessionId property of 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.

mediaNode

public String mediaNode()

PRO The Media Node where to host the session. The default option if this property is not defined is the less loaded Media Node at the moment the first user joins the session.