Package io.openvidu.java.client
Class SessionProperties
- java.lang.Object
-
- io.openvidu.java.client.SessionProperties
-
public class SessionProperties extends Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SessionProperties.Builder
Builder forSessionProperties
static class
SessionProperties.DefaultValues
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
customSessionId()
Fixes the value of the sessionId property of the Session.RecordingProperties
defaultRecordingProperties()
Defines the default recording properties of this session.VideoCodec
forcedVideoCodec()
Defines which video codec is being forced to be used in the browser/client.static SessionProperties.Builder
fromJson(Map<String,?> params)
Obtain aSessionProperties.Builder
directly from a JSON object in the form of a MapBoolean
isTranscodingAllowed()
Defines if transcoding is allowed or not whenforcedVideoCodec
is not a compatible codec with the browser/client.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
)com.google.gson.JsonObject
toJson()
-
-
-
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
)
-
defaultRecordingProperties
public RecordingProperties defaultRecordingProperties()
Defines the default recording properties of this session. You can easily override this value later when starting aRecording
by providing newRecordingProperties
-
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.
-
forcedVideoCodec
public VideoCodec forcedVideoCodec()
Defines which video codec is being forced to be used in the browser/client. This is the raw value that was configured. It might get resolved into a different one for actual usage in the server.
-
isTranscodingAllowed
public Boolean isTranscodingAllowed()
Defines if transcoding is allowed or not whenforcedVideoCodec
is not a compatible codec with the browser/client.
-
toJson
public com.google.gson.JsonObject toJson()
-
fromJson
public static SessionProperties.Builder fromJson(Map<String,?> params) throws IllegalArgumentException
Obtain aSessionProperties.Builder
directly from a JSON object in the form of a Map- Returns:
- A
SessionProperties.Builder
- Throws:
IllegalArgumentException
- If some parameter has a wrong type or an invalid value
-
-