Package com.opentok
Class SessionProperties
- java.lang.Object
-
- com.opentok.SessionProperties
-
public class SessionProperties extends java.lang.Object
Defines values for theproperties
parameter of theOpenTok.createSession(SessionProperties)
method.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SessionProperties.Builder
Use this class to create a SessionProperties object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ArchiveMode
archiveMode()
Defines whether the session will be automatically archived (ArchiveMode.ALWAYS
) or not (ArchiveMode.MANUAL
).java.lang.String
archiveName()
Indicates the archive resolution for all the archives in auto archived session.Resolution
archiveResolution()
Indicates the archive resolution for all the archives in auto archived session.java.lang.String
getLocation()
The location hint IP address.boolean
isEndToEndEncrypted()
Defines whether the session will use end-to-end encryption.MediaMode
mediaMode()
Defines whether the session will transmit streams using the OpenTok Media Server or attempt to transmit streams directly between clients.java.util.Map<java.lang.String,java.util.List<java.lang.String>>
toMap()
Serializes the properties for making a request.
-
-
-
Method Detail
-
getLocation
public java.lang.String getLocation()
The location hint IP address. SeeSessionProperties.Builder.location(String location)
.
-
mediaMode
public MediaMode mediaMode()
Defines whether the session will transmit streams using the OpenTok Media Server or attempt to transmit streams directly between clients. SeeSessionProperties.Builder.mediaMode(MediaMode mediaMode)
.
-
archiveMode
public ArchiveMode archiveMode()
Defines whether the session will be automatically archived (ArchiveMode.ALWAYS
) or not (ArchiveMode.MANUAL
). SeeSessionProperties.Builder.archiveMode(ArchiveMode archiveMode)
-
archiveName
public java.lang.String archiveName()
Indicates the archive resolution for all the archives in auto archived session. A session that begins with archive modeArchiveMode.ALWAYS
will use this resolution for all archives of that session.- Returns:
- The archive name, or
null
if not set (the default).
-
archiveResolution
public Resolution archiveResolution()
Indicates the archive resolution for all the archives in auto archived session. A session that begins with archive modeArchiveMode.ALWAYS
will use this resolution for all archives of that session.- Returns:
- The archive resolution enum, or
null
if not set (the default).
-
isEndToEndEncrypted
public boolean isEndToEndEncrypted()
Defines whether the session will use end-to-end encryption. SeeSessionProperties.Builder.endToEndEncryption()
.- Returns:
true
if end-to-end encryption is enabled,false
otherwise.
-
toMap
public java.util.Map<java.lang.String,java.util.List<java.lang.String>> toMap()
Serializes the properties for making a request.- Returns:
- The session properties as a Map.
-
-