Class ExperienceComposerClient

Namespace

Vonage.Video.ExperienceComposer

Assembly

Vonage.dll

Represents a client exposing Experience Composer features.

public class ExperienceComposerClient

Inheritance

object

ExperienceComposerClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

GetSessionAsync(Result<GetSessionRequest>)

Retrieves details on an Experience Composer session.

public Task<Result<Session>> GetSessionAsync(Result<GetSessionRequest> request)

Parameters

request Result<GetSessionRequest>

The request.

Returns

Task<Result<Session>>

A success state with the archive if the operation succeeded. A failure state with the error message if it failed.

Examples

var request = GetSessionRequest.Build()
    .WithApplicationId(applicationId)
    .WithSessionId(sessionId)
    .Create();
var result = await client.VideoClient.ExperienceComposerClient.GetSessionAsync(request);

GetSessionsAsync(Result<GetSessionsRequest>)

Retrieves all experience composer sessions in an application.

public Task<Result<GetSessionsResponse>> GetSessionsAsync(Result<GetSessionsRequest> request)

Parameters

request Result<GetSessionsRequest>

The request.

Returns

Task<Result<GetSessionsResponse>>

A success state with the archive if the operation succeeded. A failure state with the error message if it failed.

Examples

var request = GetSessionsRequest.Build()
    .WithApplicationId(applicationId)
    .Create();
var result = await client.VideoClient.ExperienceComposerClient.GetSessionsAsync(request);

StartAsync(Result<StartRequest>)

Starts an Experience Composer session.

public Task<Result<Session>> StartAsync(Result<StartRequest> request)

Parameters

request Result<StartRequest>

The request.

Returns

Task<Result<Session>>

A success state with the archive if the operation succeeded. A failure state with the error message if it failed.

Examples

var request = StartRequest.Build()
    .WithApplicationId(applicationId)
    .WithSessionId(sessionId)
    .WithToken(token)
    .WithUrl(new Uri("https://example.com/composer"))
    .WithResolution(RenderResolution.HighDefinitionLandscape)
    .WithName("My Composer")
    .Create();
var result = await client.VideoClient.ExperienceComposerClient.StartAsync(request);

StopAsync(Result<StopRequest>)

Stops an Experience Composer session.

public Task<Result<Unit>> StopAsync(Result<StopRequest> request)

Parameters

request Result<StopRequest>

The request.

Returns

Task<Result<Unit>>

A success state with the archive if the operation succeeded. A failure state with the error message if it failed.

Examples

var request = StopRequest.Build()
    .WithApplicationId(applicationId)
    .WithSessionId(sessionId)
    .Create();
var result = await client.VideoClient.ExperienceComposerClient.StopAsync(request);