Class Session

Namespace

Vonage.Video.ExperienceComposer

Assembly

Vonage.dll

Represents an Experience Composer session.

public record Session : IEquatable<Session>

Inheritance

object

Session

Implements

IEquatable<Session>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Session(string, string, Guid, long, Uri, long, string, Uri, RenderResolution, SessionStatus, string, string)

Represents an Experience Composer session.

public Session(string Id, string SessionId, Guid ApplicationId, long CreatedAt, Uri CallbackUrl, long UpdatedAt, string Name, Uri Url, RenderResolution Resolution, SessionStatus Status, string StreamId, string Reason)

Parameters

Id string

The unique ID for the Experience Composer.

SessionId string

The session ID of the Vonage Video session you are working with

ApplicationId Guid

A Vonage Application ID

CreatedAt long

The time the Experience Composer started, expressed in milliseconds since the Unix epoch (January 1, 1970, 00:00:00 UTC).

CallbackUrl Uri

The callback URL for Experience Composer events (if one was set).

UpdatedAt long

This is the UNIX timestamp when the Experience Composer status was last updated. For this start method, this timestamp matches the createdAt timestamp.

Name string

The name of the composed output stream which is published to the session.

Url Uri

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

Resolution RenderResolution

The resolution of the archive, either "640x480" (SD landscape, the default), "1280x720" (HD landscape), "1920x1080" (FHD landscape), "480x640" (SD portrait), "720x1280" (HD portrait), or "1080x1920" (FHD portrait). You may want to use a portrait aspect ratio for archives that include video streams from mobile devices (which often use the portrait aspect ratio). This property only applies to composed archives. If you set this property and set the outputMode property to "individual", the call to the REST method results in an error.

Status SessionStatus

The session status.

StreamId string

The ID of the composed stream being published.

Reason string

The reason field is only available when the status is either "stopped" or "failed". If the status is stopped, the reason field will contain either "Max Duration Exceeded" or "Stop Requested." If the status is failed, the reason will contain a more specific error message.

Properties

ApplicationId

A Vonage Application ID

public Guid ApplicationId { get; init; }

Property Value

Guid

CallbackUrl

The callback URL for Experience Composer events (if one was set).

public Uri CallbackUrl { get; init; }

Property Value

Uri

CreatedAt

The time the Experience Composer started, expressed in milliseconds since the Unix epoch (January 1, 1970, 00:00:00 UTC).

public long CreatedAt { get; init; }

Property Value

long

Id

The unique ID for the Experience Composer.

public string Id { get; init; }

Property Value

string

Name

The name of the composed output stream which is published to the session.

public string Name { get; init; }

Property Value

string

Reason

The reason field is only available when the status is either "stopped" or "failed". If the status is stopped, the reason field will contain either "Max Duration Exceeded" or "Stop Requested." If the status is failed, the reason will contain a more specific error message.

public string Reason { get; init; }

Property Value

string

Resolution

The resolution of the archive, either "640x480" (SD landscape, the default), "1280x720" (HD landscape), "1920x1080" (FHD landscape), "480x640" (SD portrait), "720x1280" (HD portrait), or "1080x1920" (FHD portrait). You may want to use a portrait aspect ratio for archives that include video streams from mobile devices (which often use the portrait aspect ratio). This property only applies to composed archives. If you set this property and set the outputMode property to "individual", the call to the REST method results in an error.

[JsonConverter(typeof(EnumDescriptionJsonConverter<RenderResolution>))]
public RenderResolution Resolution { get; init; }

Property Value

RenderResolution

SessionId

The session ID of the Vonage Video session you are working with

public string SessionId { get; init; }

Property Value

string

Status

The session status.

[JsonConverter(typeof(EnumDescriptionJsonConverter<SessionStatus>))]
public SessionStatus Status { get; init; }

Property Value

SessionStatus

StreamId

The ID of the composed stream being published.

public string StreamId { get; init; }

Property Value

string

UpdatedAt

This is the UNIX timestamp when the Experience Composer status was last updated. For this start method, this timestamp matches the createdAt timestamp.

public long UpdatedAt { get; init; }

Property Value

long

Url

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

public Uri Url { get; init; }

Property Value

Uri