Table of Contents

Interface IBuilderForOptional

Namespace
Vonage.Video.Archives.CreateArchive
Assembly
Vonage.dll
public interface IBuilderForOptional : IVonageRequestBuilder<CreateArchiveRequest>
Inherited Members

Methods

DisableAudio()

Disables audio recording for the archive. By default, audio is recorded. If you disable both audio and video, the request results in an error.

IBuilderForOptional DisableAudio()

Returns

IBuilderForOptional

Examples

.DisableAudio()

DisableVideo()

Disables video recording for the archive. By default, video is recorded. If you disable both audio and video, the request results in an error.

IBuilderForOptional DisableVideo()

Returns

IBuilderForOptional

Examples

.DisableVideo()

EnableTranscription()

Enables transcription of the audio of the session. Disabled by default.

IBuilderForOptional EnableTranscription()

Returns

IBuilderForOptional

Examples

.EnableTranscription()

WithLayout(Layout)

Sets the archive's layout.

IBuilderForOptional WithLayout(Layout value)

Parameters

value Layout

Returns

IBuilderForOptional

Examples

.WithLayout(new Layout(null, null, LayoutType.BestFit))

WithMaxBitrate(int)

Sets the maximum video bitrate for the archive, in bits per second. Only valid for composed archives. Valid range: 1,000,000 to 6,000,000. This maximum applies to the video bitrate only; audio bits are excluded from the limit.

IBuilderForOptional WithMaxBitrate(int value)

Parameters

value int

Returns

IBuilderForOptional

Examples

.WithMaxBitrate(2000000)

WithMultiArchiveTag(string)

Sets a unique tag to support recording multiple archives for the same session simultaneously. You must also set this option when manually starting an archive in a session that is automatically archived. If you do not specify a unique multiArchiveTag, you can only record one archive at a time for a given session.

IBuilderForOptional WithMultiArchiveTag(string value)

Parameters

value string

Returns

IBuilderForOptional

Examples

.WithMultiArchiveTag("my-multi-archive")

WithName(string)

Sets the name of the archive (for your own identification).

IBuilderForOptional WithName(string value)

Parameters

value string

Returns

IBuilderForOptional

Examples

.WithName("My Archive")

WithOutputMode(Maybe<OutputMode>)

Sets whether all streams in the archive are recorded to a single file ("composed", the default) or to individual files ("individual").

IBuilderForOptional WithOutputMode(Maybe<OutputMode> value)

Parameters

value Maybe<OutputMode>

Returns

IBuilderForOptional

Examples

.WithOutputMode(OutputMode.Individual)

WithQuantizationParameter(int)

Sets the quantization parameter (QP) for composed archives. Smaller values (min 15) generate higher quality and larger archives; larger values (max 40) generate lower quality and smaller archives. Uses variable bitrate (VBR).

IBuilderForOptional WithQuantizationParameter(int value)

Parameters

value int

Returns

IBuilderForOptional

Examples

.WithQuantizationParameter(25)

WithResolution(RenderResolution)

Sets the resolution of the archive. Only applies to composed archives. If you set this and set the outputMode to "individual", the request results in an error. Available resolutions: "640x480" (SD landscape, the default), "1280x720" (HD landscape), "1920x1080" (FHD landscape), "480x640" (SD portrait), "720x1280" (HD portrait), or "1080x1920" (FHD portrait).

IBuilderForOptional WithResolution(RenderResolution value)

Parameters

value RenderResolution

Returns

IBuilderForOptional

Examples

.WithResolution(RenderResolution.HighDefinitionLandscape)

WithStreamMode(Maybe<StreamMode>)

Sets whether streams included in the archive are selected automatically ("auto", the default) or manually ("manual"). In manual mode, you specify streams to be included and whether a stream's audio, video, or both are included. In composed archives, the archive composer includes streams based on stream prioritization rules.

IBuilderForOptional WithStreamMode(Maybe<StreamMode> value)

Parameters

value Maybe<StreamMode>

Returns

IBuilderForOptional

Examples

.WithStreamMode(StreamMode.Manual)

WithTranscription(TranscriptionProperties)

Sets the transcription configuration.

IBuilderForOptional WithTranscription(TranscriptionProperties value)

Parameters

value TranscriptionProperties

Returns

IBuilderForOptional

Examples

.WithTranscription(new TranscriptionProperties { PrimaryLanguageCode = "en-US", HasSummary = true })