Package com.vonage.client.video

Class CreateSessionRequest

java.lang.Object

com.vonage.client.video.CreateSessionRequest

All Implemented Interfaces:

QueryParamsRequest

public class CreateSessionRequest
extends Object
implements QueryParamsRequest

Defines the properties used to create a new video session.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CreateSessionRequest.Builder	Builder for constructing CreateSessionRequest.

Method Summary

Modifier and Type	Method	Description
static CreateSessionRequest.Builder	builder()	Instantiates a Builder, used to construct this object.
ArchiveMode	getArchiveMode()	Defines whether the session will be automatically archived (ArchiveMode.ALWAYS) or not (ArchiveMode.MANUAL).
Boolean	getE2ee()	Defines whether the session will be end-to-end encrypted.
InetAddress	getLocation()	The location hint IP address.
MediaMode	getMediaMode()	Defines whether the session will transmit streams using the Vonage Media Server or attempt to transmit streams directly between clients.
Map<String,String>	makeParams()	Internal method for serializing the fields of this class into query parameters.

Methods inherited from class java.lang.Object

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

Method Details

makeParams

public Map<String,String> makeParams()

Description copied from interface: QueryParamsRequest

Internal method for serializing the fields of this class into query parameters. The Map should be mutable so that subclasses can add fields, otherwise the method or implementing class should be marked as final. Duplicate entries can be handled by mapping the key to a list of the entries.

Specified by:

makeParams in interface QueryParamsRequest

Returns:

The query parameters as unique key-value pairs.

getLocation

public InetAddress getLocation()

The location hint IP address.

Returns:

The IP address, or null if unspecified.

getMediaMode

public MediaMode getMediaMode()

Defines whether the session will transmit streams using the Vonage Media Server or attempt to transmit streams directly between clients.

Returns:

The MediaMode as an enum, or null if unspecified.

getArchiveMode

public ArchiveMode getArchiveMode()

Defines whether the session will be automatically archived (ArchiveMode.ALWAYS) or not (ArchiveMode.MANUAL).

Returns:

The ArchiveMode as an enum, or null if unspecified.

getE2ee

public Boolean getE2ee()

Defines whether the session will be end-to-end encrypted.

Returns:

true if end-to-end encryption is enabled, null if unspecified.

Since:

8.12.0

builder

public static CreateSessionRequest.Builder builder()

Instantiates a Builder, used to construct this object.

Returns:

A new CreateSessionRequest.Builder.