Struct StartRequest

Namespace

Vonage.Video.ExperienceComposer.Start

Assembly

Vonage.dll

public readonly struct StartRequest : IVonageRequest

Implements

IVonageRequest

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

ApplicationId

The Vonage Application UUID.

[JsonIgnore]
public Guid ApplicationId { get; }

Property Value

Guid

MaxDuration

The maximum time allowed for the Experience Composer, in seconds. The minimum value is 60 (1 minute), the maximum is 36000 (10 hours), and the default is 7200 (2 hours).

[JsonPropertyOrder(3)]
public int MaxDuration { get; }

Property Value

int

Properties

The initial configuration of Publisher properties for the composed output stream.

[JsonPropertyOrder(5)]
public StartProperties Properties { get; }

Property Value

StartProperties

Resolution

The resolution of the Experience Composer output.

[JsonPropertyOrder(4)]
public RenderResolution Resolution { get; }

Property Value

RenderResolution

SessionId

The Vonage Video session ID.

[JsonPropertyOrder(0)]
public string SessionId { get; }

Property Value

string

Token

A valid Vonage Video token with a Publisher role and (optionally) connection data to be associated with the output stream.

[JsonPropertyOrder(1)]
public string Token { get; }

Property Value

string

Url

A publicly reachable URL controlled by the customer and capable of generating the content to be rendered without user intervention. Must be between 15 and 2048 characters.

[JsonPropertyOrder(2)]
public Uri Url { get; }

Property Value

Uri

Methods

Build()

Initializes a builder.

public static IBuilderForApplicationId Build()

Returns

IBuilderForApplicationId

The builder.

BuildRequestMessage()

Converts the request to a HttpRequest.

public HttpRequestMessage BuildRequestMessage()

Returns

HttpRequestMessage

The Http request.