Class ArchiveClient

Namespace

Vonage.Video.Archives

Assembly

Vonage.dll

Represents a client exposing archiving features.

public class ArchiveClient

Inheritance

object

ArchiveClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

AddStreamAsync(Result<AddStreamRequest>)

Adds the stream included in a composed archive that was started with the streamMode set to "manual".

public Task<Result<Unit>> AddStreamAsync(Result<AddStreamRequest> request)

Parameters

request Result<AddStreamRequest>

The request.

Returns

Task<Result<Unit>>

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

Examples

var request = AddStreamRequest.Build()
    .WithApplicationId(applicationId)
    .WithArchiveId(archiveId)
    .WithStreamId(streamId)
    .Create();
var result = await client.VideoClient.ArchiveClient.AddStreamAsync(request);

ChangeLayoutAsync(Result<ChangeLayoutRequest>)

Changes the layout type of a composed archive while it is being recorded.

public Task<Result<Unit>> ChangeLayoutAsync(Result<ChangeLayoutRequest> request)

Parameters

request Result<ChangeLayoutRequest>

The request.

Returns

Task<Result<Unit>>

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

Examples

var request = ChangeLayoutRequest.Build()
    .WithApplicationId(applicationId)
    .WithArchiveId(archiveId)
    .WithLayout(new Layout(null, null, LayoutType.BestFit))
    .Create();
var result = await client.VideoClient.ArchiveClient.ChangeLayoutAsync(request);

CreateArchiveAsync(Result<CreateArchiveRequest>)

Creates a new archive.

public Task<Result<Archive>> CreateArchiveAsync(Result<CreateArchiveRequest> request)

Parameters

request Result<CreateArchiveRequest>

The request.

Returns

Task<Result<Archive>>

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

Examples

var request = CreateArchiveRequest.Build()
    .WithApplicationId(applicationId)
    .WithSessionId(sessionId)
    .WithName("My Archive")
    .Create();
var result = await client.VideoClient.ArchiveClient.CreateArchiveAsync(request);

DeleteArchiveAsync(Result<DeleteArchiveRequest>)

Deletes the specified archive.

public Task<Result<Unit>> DeleteArchiveAsync(Result<DeleteArchiveRequest> request)

Parameters

request Result<DeleteArchiveRequest>

The request.

Returns

Task<Result<Unit>>

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

Examples

var request = DeleteArchiveRequest.Build()
    .WithApplicationId(applicationId)
    .WithArchiveId(archiveId)
    .Create();
var result = await client.VideoClient.ArchiveClient.DeleteArchiveAsync(request);

GetArchiveAsync(Result<GetArchiveRequest>)

Return the archive information of a specific archive.

public Task<Result<Archive>> GetArchiveAsync(Result<GetArchiveRequest> request)

Parameters

request Result<GetArchiveRequest>

The request.

Returns

Task<Result<Archive>>

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

Examples

var request = GetArchiveRequest.Build()
    .WithApplicationId(applicationId)
    .WithArchiveId(archiveId)
    .Create();
var result = await client.VideoClient.ArchiveClient.GetArchiveAsync(request);

GetArchivesAsync(Result<GetArchivesRequest>)

Retrieves all archives from an application.

public Task<Result<GetArchivesResponse>> GetArchivesAsync(Result<GetArchivesRequest> request)

Parameters

request Result<GetArchivesRequest>

The request.

Returns

Task<Result<GetArchivesResponse>>

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

Examples

var request = GetArchivesRequest.Build()
    .WithApplicationId(applicationId)
    .Create();
var result = await client.VideoClient.ArchiveClient.GetArchivesAsync(request);

RemoveStreamAsync(Result<RemoveStreamRequest>)

Removes the stream included in a composed archive that was started with the streamMode set to "manual".

public Task<Result<Unit>> RemoveStreamAsync(Result<RemoveStreamRequest> request)

Parameters

request Result<RemoveStreamRequest>

The request.

Returns

Task<Result<Unit>>

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

Examples

var request = RemoveStreamRequest.Build()
    .WithApplicationId(applicationId)
    .WithArchiveId(archiveId)
    .WithStreamId(streamId)
    .Create();
var result = await client.VideoClient.ArchiveClient.RemoveStreamAsync(request);

StopArchiveAsync(Result<StopArchiveRequest>)

Stops an archive.

public Task<Result<Archive>> StopArchiveAsync(Result<StopArchiveRequest> request)

Parameters

request Result<StopArchiveRequest>

The request.

Returns

Task<Result<Archive>>

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

Examples

var request = StopArchiveRequest.Build()
    .WithApplicationId(applicationId)
    .WithArchiveId(archiveId)
    .Create();
var result = await client.VideoClient.ArchiveClient.StopArchiveAsync(request);