com.opentok.SessionProperties
public class SessionProperties extends Object
Defines values for the properties parameter of the
OpenTok.createSession(SessionProperties) method.
See Also:
: - OpenTok.createSession(com.opentok.SessionProperties properties)
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 MethodsInstance MethodsConcrete Methods
Modifier and Type
Method
Description
ArchiveMode
archiveMode()
Defines whether the session will be automatically archived (ArchiveMode.ALWAYS)
or not (ArchiveMode.MANUAL).
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.
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.
Map<String,List<String>>
toMap()
Serializes the properties for making a request.
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Method Details
getLocation
public String getLocation()
The location hint IP address. See SessionProperties.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. See
SessionProperties.Builder.mediaMode(MediaMode mediaMode).
archiveMode
public ArchiveMode archiveMode()
Defines whether the session will be automatically archived (ArchiveMode.ALWAYS)
or not (ArchiveMode.MANUAL). See
SessionProperties.Builder.archiveMode(ArchiveMode archiveMode)
archiveName
public String archiveName()
Indicates the archive resolution for all the archives in auto archived session. A session that begins with
archive mode ArchiveMode.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 mode ArchiveMode.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.
See SessionProperties.Builder.endToEndEncryption().
Returns:
: true if end-to-end encryption is enabled, false otherwise.
toMap
public Map<String,List<String>> toMap()
Serializes the properties for making a request.
Returns: : The session properties as a Map.