Class SegmentedFileOutput

Namespace

LiveKit.Proto

Assembly

LiveKit.AspNetCore.ServerSdk.Abstractions.dll

Used to generate HLS segments or other kind of segmented output

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

Inheritance

object

SegmentedFileOutput

Implements

IMessage<SegmentedFileOutput>

IEquatable<SegmentedFileOutput>

IDeepCloneable<SegmentedFileOutput>

IBufferMessage

IMessage

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

SegmentedFileOutput()

public SegmentedFileOutput()

SegmentedFileOutput(SegmentedFileOutput)

public SegmentedFileOutput(SegmentedFileOutput other)

Parameters

other SegmentedFileOutput

Fields

AliOSSFieldNumber

Field number for the "aliOSS" field.

public const int AliOSSFieldNumber = 9

Field Value

int

AzureFieldNumber

Field number for the "azure" field.

public const int AzureFieldNumber = 7

Field Value

int

DisableManifestFieldNumber

Field number for the "disable_manifest" field.

public const int DisableManifestFieldNumber = 8

Field Value

int

FilenamePrefixFieldNumber

Field number for the "filename_prefix" field.

public const int FilenamePrefixFieldNumber = 2

Field Value

int

FilenameSuffixFieldNumber

Field number for the "filename_suffix" field.

public const int FilenameSuffixFieldNumber = 10

Field Value

int

GcpFieldNumber

Field number for the "gcp" field.

public const int GcpFieldNumber = 6

Field Value

int

LivePlaylistNameFieldNumber

Field number for the "live_playlist_name" field.

public const int LivePlaylistNameFieldNumber = 11

Field Value

int

PlaylistNameFieldNumber

Field number for the "playlist_name" field.

public const int PlaylistNameFieldNumber = 3

Field Value

int

ProtocolFieldNumber

Field number for the "protocol" field.

public const int ProtocolFieldNumber = 1

Field Value

int

S3FieldNumber

Field number for the "s3" field.

public const int S3FieldNumber = 5

Field Value

int

SegmentDurationFieldNumber

Field number for the "segment_duration" field.

public const int SegmentDurationFieldNumber = 4

Field Value

int

Properties

AliOSS

public AliOSSUpload AliOSS { get; set; }

Property Value

AliOSSUpload

Azure

public AzureBlobUpload Azure { get; set; }

Property Value

AzureBlobUpload

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 SegmentedFileSuffix FilenameSuffix { get; set; }

Property Value

SegmentedFileSuffix

Gcp

public GCPUpload Gcp { get; set; }

Property Value

GCPUpload

LivePlaylistName

(optional, disabled if not provided). Path of a live playlist

public string LivePlaylistName { get; set; }

Property Value

string

OutputCase

public SegmentedFileOutput.OutputOneofCase OutputCase { get; }

Property Value

SegmentedFileOutput.OutputOneofCase

Parser

public static MessageParser<SegmentedFileOutput> Parser { get; }

Property Value

MessageParser<SegmentedFileOutput>

PlaylistName

(optional)

public string PlaylistName { get; set; }

Property Value

string

Protocol

(optional)

public SegmentedFileProtocol Protocol { get; set; }

Property Value

SegmentedFileProtocol

S3

public S3Upload S3 { get; set; }

Property Value

S3Upload

SegmentDuration

in seconds (optional)

public uint SegmentDuration { get; set; }

Property Value

uint

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 SegmentedFileOutput Clone()

Returns

SegmentedFileOutput

A deep clone of this object.

Equals(SegmentedFileOutput)

public bool Equals(SegmentedFileOutput other)

Parameters

other SegmentedFileOutput

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(SegmentedFileOutput)

Merges the given message into this one.

public void MergeFrom(SegmentedFileOutput other)

Parameters

other SegmentedFileOutput

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.