Class Video

Namespace

Vonage.Applications.Capabilities

Assembly

Vonage.dll

Represents the Video capability.

public class Video

Inheritance

object

Video

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Video()

Initializes a new instance of the Video class.

public Video()

Properties

Storage

Storage settings for video recordings, including encryption options.

[JsonProperty("storage", DefaultValueHandling = DefaultValueHandling.Ignore)]
public Video.VideoStorage Storage { get; }

Property Value

Video.VideoStorage

Webhooks

Represents the collection of Webhook URLs with their configuration.

[JsonProperty("webhooks")]
public IDictionary<VideoWebhookType, Video.VideoWebhook> Webhooks { get; set; }

Property Value

IDictionary<VideoWebhookType, Video.VideoWebhook>

Methods

Build()

Creates a new Video capability builder for fluent configuration.

public static Video Build()

Returns

Video

A new Video capability instance.

Examples

var videoCapability = Video.Build()
    .EnableCloudStorage()
    .EnableServerSideEncryption()
    .WithSessionCreated("https://example.com/webhooks/session-created")
    .WithArchiveStatus("https://example.com/webhooks/archive-status");

EnableCloudStorage()

Enables cloud storage for video recordings.

public Video EnableCloudStorage()

Returns

Video

The Video capability instance for fluent chaining.

Examples

var video = Video.Build()
    .EnableCloudStorage();

EnableEndToEndEncryption()

Enables end-to-end encryption for video streams.

public Video EnableEndToEndEncryption()

Returns

Video

The Video capability instance for fluent chaining.

Examples

var video = Video.Build()
    .EnableEndToEndEncryption();

EnableServerSideEncryption()

Enables server-side encryption for video recordings.

public Video EnableServerSideEncryption()

Returns

Video

The Video capability instance for fluent chaining.

Examples

var video = Video.Build()
    .EnableServerSideEncryption();

WithArchiveStatus(string, bool)

Sets the archive status webhook for Video capability.

public Video WithArchiveStatus(string url, bool active = true)

Parameters

url string

The webhook URL.

active bool

Whether the webhook is active.

Returns

Video

The Video capability instance for fluent chaining.

Examples

var video = Video.Build()
    .WithArchiveStatus("https://example.com/webhooks/archive-status");

WithBroadcastStatus(string, bool)

Sets the broadcast status webhook for Video capability.

public Video WithBroadcastStatus(string url, bool active = true)

Parameters

url string

The webhook URL.

active bool

Whether the webhook is active.

Returns

Video

The Video capability instance for fluent chaining.

WithCaptionsStatus(string, bool)

Sets the captions status webhook for Video capability.

public Video WithCaptionsStatus(string url, bool active = true)

Parameters

url string

The webhook URL.

active bool

Whether the webhook is active.

Returns

Video

The Video capability instance for fluent chaining.

WithConnectionCreated(string, bool)

Sets the connection created webhook for Video capability.

public Video WithConnectionCreated(string url, bool active = true)

Parameters

url string

The webhook URL.

active bool

Whether the webhook is active.

Returns

Video

The Video capability instance for fluent chaining.

WithConnectionDestroyed(string, bool)

Sets the connection destroyed webhook for Video capability.

public Video WithConnectionDestroyed(string url, bool active = true)

Parameters

url string

The webhook URL.

active bool

Whether the webhook is active.

Returns

Video

The Video capability instance for fluent chaining.

WithRenderStatus(string, bool)

Sets the render status webhook for Video capability.

public Video WithRenderStatus(string url, bool active = true)

Parameters

url string

The webhook URL.

active bool

Whether the webhook is active.

Returns

Video

The Video capability instance for fluent chaining.

WithSessionCreated(string, bool)

Sets the session created webhook for Video capability.

public Video WithSessionCreated(string url, bool active = true)

Parameters

url string

The webhook URL.

active bool

Whether the webhook is active.

Returns

Video

The Video capability instance for fluent chaining.

WithSessionDestroyed(string, bool)

Sets the session destroyed webhook for Video capability.

public Video WithSessionDestroyed(string url, bool active = true)

Parameters

url string

The webhook URL.

active bool

Whether the webhook is active.

Returns

Video

The Video capability instance for fluent chaining.

WithSessionNotification(string, bool)

Sets the session notification webhook for Video capability.

public Video WithSessionNotification(string url, bool active = true)

Parameters

url string

The webhook URL.

active bool

Whether the webhook is active.

Returns

Video

The Video capability instance for fluent chaining.

WithSipCallCreated(string, bool)

Sets the sip call created webhook for Video capability.

public Video WithSipCallCreated(string url, bool active = true)

Parameters

url string

The webhook URL.

active bool

Whether the webhook is active.

Returns

Video

The Video capability instance for fluent chaining.

WithSipCallDestroyed(string, bool)

Sets the sip call destroyed webhook for Video capability.

public Video WithSipCallDestroyed(string url, bool active = true)

Parameters

url string

The webhook URL.

active bool

Whether the webhook is active.

Returns

Video

The Video capability instance for fluent chaining.

WithSipCallMuteForced(string, bool)

Sets the sip call mute forced webhook for Video capability.

public Video WithSipCallMuteForced(string url, bool active = true)

Parameters

url string

The webhook URL.

active bool

Whether the webhook is active.

Returns

Video

The Video capability instance for fluent chaining.

WithSipCallUpdated(string, bool)

Sets the sip call updated webhook for Video capability.

public Video WithSipCallUpdated(string url, bool active = true)

Parameters

url string

The webhook URL.

active bool

Whether the webhook is active.

Returns

Video

The Video capability instance for fluent chaining.

WithStreamCreated(string, bool)

Sets the stream created webhook for Video capability.

public Video WithStreamCreated(string url, bool active = true)

Parameters

url string

The webhook URL.

active bool

Whether the webhook is active.

Returns

Video

The Video capability instance for fluent chaining.

WithStreamDestroyed(string, bool)

Sets the stream destroyed webhook for Video capability.

public Video WithStreamDestroyed(string url, bool active = true)

Parameters

url string

The webhook URL.

active bool

Whether the webhook is active.

Returns

Video

The Video capability instance for fluent chaining.