Class ImageOutput

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

Capture images at a specified interval

public sealed class ImageOutput : IMessage<ImageOutput>, IEquatable<ImageOutput>, IDeepCloneable<ImageOutput>, IBufferMessage, IMessage

Inheritance

object

ImageOutput

Implements

IMessage<ImageOutput>

IEquatable<ImageOutput>

IDeepCloneable<ImageOutput>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

ImageOutput()

public ImageOutput()

ImageOutput(ImageOutput)

public ImageOutput(ImageOutput other)

Parameters

other ImageOutput

Fields

AliOSSFieldNumber

Field number for the "aliOSS" field.

public const int AliOSSFieldNumber = 11

Field Value

int

AzureFieldNumber

Field number for the "azure" field.

public const int AzureFieldNumber = 10

Field Value

int

CaptureIntervalFieldNumber

Field number for the "capture_interval" field.

public const int CaptureIntervalFieldNumber = 1

Field Value

int

DisableManifestFieldNumber

Field number for the "disable_manifest" field.

public const int DisableManifestFieldNumber = 7

Field Value

int

FilenamePrefixFieldNumber

Field number for the "filename_prefix" field.

public const int FilenamePrefixFieldNumber = 4

Field Value

int

FilenameSuffixFieldNumber

Field number for the "filename_suffix" field.

public const int FilenameSuffixFieldNumber = 5

Field Value

int

GcpFieldNumber

Field number for the "gcp" field.

public const int GcpFieldNumber = 9

Field Value

int

HeightFieldNumber

Field number for the "height" field.

public const int HeightFieldNumber = 3

Field Value

int

ImageCodecFieldNumber

Field number for the "image_codec" field.

public const int ImageCodecFieldNumber = 6

Field Value

int

S3FieldNumber

Field number for the "s3" field.

public const int S3FieldNumber = 8

Field Value

int

WidthFieldNumber

Field number for the "width" field.

public const int WidthFieldNumber = 2

Field Value

int

Properties

AliOSS

public AliOSSUpload AliOSS { get; set; }

Property Value

AliOSSUpload

Azure

public AzureBlobUpload Azure { get; set; }

Property Value

AzureBlobUpload

CaptureInterval

in seconds (required)

public uint CaptureInterval { get; set; }

Property Value

uint

Descriptor

public static MessageDescriptor Descriptor { get; }

Property Value

MessageDescriptor

DisableManifest

disable upload of manifest file (default false)

public bool DisableManifest { get; set; }

Property Value

bool

FilenamePrefix

(optional)

public string FilenamePrefix { get; set; }

Property Value

string

FilenameSuffix

(optional, default INDEX)

public ImageFileSuffix FilenameSuffix { get; set; }

Property Value

ImageFileSuffix

Gcp

public GCPUpload Gcp { get; set; }

Property Value

GCPUpload

Height

(optional, defaults to track height)

public int Height { get; set; }

Property Value

int

ImageCodec

(optional)

public ImageCodec ImageCodec { get; set; }

Property Value

ImageCodec

OutputCase

public ImageOutput.OutputOneofCase OutputCase { get; }

Property Value

ImageOutput.OutputOneofCase

Parser

public static MessageParser<ImageOutput> Parser { get; }

Property Value

MessageParser<ImageOutput>

S3

public S3Upload S3 { get; set; }

Property Value

S3Upload

Width

(optional, defaults to track width)

public int Width { get; set; }

Property Value

int

Methods

CalculateSize()

Calculates the size of this message in Protocol Buffer wire format, in bytes.

public int CalculateSize()

Returns

int

The number of bytes required to write this message to a coded output stream.

ClearOutput()

public void ClearOutput()

Clone()

Creates a deep clone of this object.

public ImageOutput Clone()

Returns

ImageOutput

A deep clone of this object.

Equals(ImageOutput)

public bool Equals(ImageOutput other)

Parameters

other ImageOutput

Returns

bool

Equals(object)

public override bool Equals(object other)

Parameters

other object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

MergeFrom(CodedInputStream)

Merges the data from the specified coded input stream with the current message.

public void MergeFrom(CodedInputStream input)

Parameters

input CodedInputStream

Remarks

See the user guide for precise merge semantics.

MergeFrom(ImageOutput)

Merges the given message into this one.

public void MergeFrom(ImageOutput other)

Parameters

other ImageOutput

Remarks

See the user guide for precise merge semantics.

ToString()

public override string ToString()

Returns

string

WriteTo(CodedOutputStream)

Writes the data to the given coded output stream.

public void WriteTo(CodedOutputStream output)

Parameters

output CodedOutputStream

Coded output stream to write the data to. Must not be null.