Struct CreateSessionRequest

Namespace

Vonage.Video.Sessions.CreateSession

Assembly

Vonage.dll

Represents a request for creating a session.

public readonly struct CreateSessionRequest : IVonageRequest

Implements

IVonageRequest

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

ArchiveMode

Set to always to have the session archived automatically. With the archiveMode set to manual (the default), you can archive the session by calling the REST /archive POST method. If you set the archiveMode to always, you must also set the p2p.preference parameter to disabled (the default).

public ArchiveMode ArchiveMode { get; }

Property Value

ArchiveMode

Default

Creates a default request with empty ip address, relayed media mode and manual archive mode.

public static CreateSessionRequest Default { get; }

Property Value

CreateSessionRequest

EndToEndEncryption

Whether end-to-end encryption is enabled for the session (true) or not (false)

public bool EndToEndEncryption { get; }

Property Value

bool

Location

The IP address that the Vonage Video APi will use to situate the session in its global network. If no location hint is passed in (which is recommended), the session uses a media server based on the location of the first client connecting to the session. Pass a location hint in only if you know the general geographic region (and a representative IP address) and you think the first client connecting may not be in that region. Specify an IP address that is representative of the geographical location for the session.

public IpAddress Location { get; }

Property Value

IpAddress

MediaMode

Indicates how streams are sent.

public MediaMode MediaMode { get; }

Property Value

MediaMode

Methods

Build()

Initializes a builder.

public static IBuilderForLocation Build()

Returns

IBuilderForLocation

The builder.

BuildRequestMessage()

Converts the request to a HttpRequest.

public HttpRequestMessage BuildRequestMessage()

Returns

HttpRequestMessage

The Http request.

GetUrlEncoded()

Retrieves the encoded Url.

public string GetUrlEncoded()

Returns

string

The encoded Url.