Class SessionClient

Namespace

Vonage.Video.Sessions

Assembly

Vonage.dll

Represents a client exposing session features.

public class SessionClient

Inheritance

object

SessionClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

ChangeStreamLayoutAsync(Result<ChangeStreamLayoutRequest>)

Changes how the stream is displayed in the layout of a composed Vonage Video archive.

public Task<Result<Unit>> ChangeStreamLayoutAsync(Result<ChangeStreamLayoutRequest> request)

Parameters

request Result<ChangeStreamLayoutRequest>

The request.

Returns

Task<Result<Unit>>

Success if the operation succeeds, Failure it if fails.

Examples

var request = ChangeStreamLayoutRequest.Build()
    .WithApplicationId(applicationId)
    .WithSessionId(sessionId)
    .WithItems(new[] { new ChangeStreamLayoutRequest.LayoutItem("streamId", new[] { "full" }) })
    .Create();
var result = await client.VideoClient.SessionClient.ChangeStreamLayoutAsync(request);

CreateSessionAsync(Result<CreateSessionRequest>)

Creates a new session.

public Task<Result<CreateSessionResponse>> CreateSessionAsync(Result<CreateSessionRequest> request)

Parameters

request Result<CreateSessionRequest>

The request.

Returns

Task<Result<CreateSessionResponse>>

Success if the operation succeeds, Failure it if fails.

Examples

var request = CreateSessionRequest.Build()
    .WithLocation("192.168.1.1")
    .WithMediaMode(MediaMode.Routed)
    .WithArchiveMode(ArchiveMode.Manual)
    .Create();
var result = await client.VideoClient.SessionClient.CreateSessionAsync(request);

GetStreamAsync(Result<GetStreamRequest>)

Retrieves a stream.

public Task<Result<GetStreamResponse>> GetStreamAsync(Result<GetStreamRequest> request)

Parameters

request Result<GetStreamRequest>

The request.

Returns

Task<Result<GetStreamResponse>>

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

Examples

var request = GetStreamRequest.Build()
    .WithApplicationId(applicationId)
    .WithSessionId(sessionId)
    .WithStreamId(streamId)
    .Create();
var result = await client.VideoClient.SessionClient.GetStreamAsync(request);

GetStreamsAsync(Result<GetStreamsRequest>)

Retrieves information on all Vonage Video streams in a session.

public Task<Result<GetStreamsResponse>> GetStreamsAsync(Result<GetStreamsRequest> request)

Parameters

request Result<GetStreamsRequest>

The request.

Returns

Task<Result<GetStreamsResponse>>

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

Examples

var request = GetStreamsRequest.Build()
    .WithApplicationId(applicationId)
    .WithSessionId(sessionId)
    .Create();
var result = await client.VideoClient.SessionClient.GetStreamsAsync(request);

ListConnections(Result<ListConnectionsRequest>)

List the connections from a Vonage Video session associated with an application.

public Task<Result<ListConnectionsResponse>> ListConnections(Result<ListConnectionsRequest> request)

Parameters

request Result<ListConnectionsRequest>

The request.

Returns

Task<Result<ListConnectionsResponse>>

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

Examples

var request = ListConnectionsRequest.Build()
    .WithApplicationId(applicationId)
    .WithSessionId(sessionId)
    .Create();
var result = await client.VideoClient.SessionClient.ListConnections(request);