Class SegmentedFileOutput

Used to generate HLS segments or other kind of segmented output

Generated

from message livekit.SegmentedFileOutput

Hierarchy

Constructors

constructor

Properties

disableManifest filenamePrefix filenameSuffix livePlaylistName output playlistName protocol segmentDuration fields runtime typeName

Methods

equals fromBinary fromJson fromJsonString

Constructors

constructor

Properties

disableManifest

disableManifest: boolean = false

disable upload of manifest file (default false)

Generated

from field: bool disable_manifest = 8;

filenamePrefix

filenamePrefix: string = ""

(optional)

Generated

from field: string filename_prefix = 2;

filenameSuffix

filenameSuffix: SegmentedFileSuffix = SegmentedFileSuffix.INDEX

(optional, default INDEX)

Generated

from field: livekit.SegmentedFileSuffix filename_suffix = 10;

livePlaylistName

livePlaylistName: string = ""

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

Generated

from field: string live_playlist_name = 11;

output

output: {
    case: "s3";
    value: S3Upload;
} | {
    case: "gcp";
    value: GCPUpload;
} | {
    case: "azure";
    value: AzureBlobUpload;
} | {
    case: "aliOSS";
    value: AliOSSUpload;
} | {
    case: undefined;
    value?: undefined;
} = ...

required

Type declaration

  • case: "s3"
  • value: S3Upload

    Generated

    from field: livekit.S3Upload s3 = 5;

Type declaration

  • case: "gcp"
  • value: GCPUpload

    Generated

    from field: livekit.GCPUpload gcp = 6;

Type declaration

  • case: "azure"
  • value: AzureBlobUpload

    Generated

    from field: livekit.AzureBlobUpload azure = 7;

Type declaration

  • case: "aliOSS"
  • value: AliOSSUpload

    Generated

    from field: livekit.AliOSSUpload aliOSS = 9;

Type declaration

  • case: undefined
  • Optional value?: undefined

Generated

from oneof livekit.SegmentedFileOutput.output

playlistName

playlistName: string = ""

(optional)

Generated

from field: string playlist_name = 3;

protocol

protocol: SegmentedFileProtocol = SegmentedFileProtocol.DEFAULT_SEGMENTED_FILE_PROTOCOL

(optional)

Generated

from field: livekit.SegmentedFileProtocol protocol = 1;

segmentDuration

segmentDuration: number = 0

in seconds (optional)

Generated

from field: uint32 segment_duration = 4;

Static Readonly fields

fields: FieldList = ...

Static Readonly runtime

runtime: ProtoRuntime = proto3

Static Readonly typeName

typeName: "livekit.SegmentedFileOutput" = "livekit.SegmentedFileOutput"

Methods

Static equals

Static fromBinary

Static fromJson

Static fromJsonString

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc