Documentation

Output extends Message
in package

Generated from protobuf message <code>livekit.Output</code>

Table of Contents

Properties

$config  : mixed
$storage  : mixed
Per-output storage override (falls back to request, then server)

Methods

__construct()  : mixed
Constructor.
clearStorage()  : mixed
getConfig()  : string
getFile()  : FileOutput|null
Generated from protobuf field <code>.livekit.FileOutput file = 1;</code>
getImages()  : ImageOutput|null
5 reserved for mcap;
getSegments()  : SegmentedFileOutput|null
Generated from protobuf field <code>.livekit.SegmentedFileOutput segments = 3;</code>
getStorage()  : StorageConfig|null
Per-output storage override (falls back to request, then server)
getStream()  : StreamOutput|null
Generated from protobuf field <code>.livekit.StreamOutput stream = 2;</code>
hasFile()  : mixed
hasImages()  : mixed
hasSegments()  : mixed
hasStorage()  : mixed
hasStream()  : mixed
setFile()  : $this
Generated from protobuf field <code>.livekit.FileOutput file = 1;</code>
setImages()  : $this
5 reserved for mcap;
setSegments()  : $this
Generated from protobuf field <code>.livekit.SegmentedFileOutput segments = 3;</code>
setStorage()  : $this
Per-output storage override (falls back to request, then server)
setStream()  : $this
Generated from protobuf field <code>.livekit.StreamOutput stream = 2;</code>

Properties

$storage

Per-output storage override (falls back to request, then server)

protected mixed $storage = null

Generated from protobuf field .livekit.StorageConfig storage = 6;

Methods

__construct()

Constructor.

public __construct([array<string|int, mixed> $data = null ]) : mixed
Parameters
$data : array<string|int, mixed> = null

{ Optional. Data for populating the Message object.

@type \Livekit\FileOutput $file
@type \Livekit\StreamOutput $stream
@type \Livekit\SegmentedFileOutput $segments
@type \Livekit\ImageOutput $images
      5 reserved for mcap;
@type \Livekit\StorageConfig $storage
      Per-output storage override (falls back to request, then server)

}

clearStorage()

public clearStorage() : mixed

getConfig()

public getConfig() : string
Return values
string

getFile()

Generated from protobuf field <code>.livekit.FileOutput file = 1;</code>

public getFile() : FileOutput|null
Return values
FileOutput|null

getImages()

5 reserved for mcap;

public getImages() : ImageOutput|null

Generated from protobuf field .livekit.ImageOutput images = 4;

Return values
ImageOutput|null

getStorage()

Per-output storage override (falls back to request, then server)

public getStorage() : StorageConfig|null

Generated from protobuf field .livekit.StorageConfig storage = 6;

Return values
StorageConfig|null

getStream()

Generated from protobuf field <code>.livekit.StreamOutput stream = 2;</code>

public getStream() : StreamOutput|null
Return values
StreamOutput|null

hasFile()

public hasFile() : mixed

hasImages()

public hasImages() : mixed

hasSegments()

public hasSegments() : mixed

hasStorage()

public hasStorage() : mixed

hasStream()

public hasStream() : mixed

setFile()

Generated from protobuf field <code>.livekit.FileOutput file = 1;</code>

public setFile(FileOutput $var) : $this
Parameters
$var : FileOutput
Return values
$this

setImages()

5 reserved for mcap;

public setImages(ImageOutput $var) : $this

Generated from protobuf field .livekit.ImageOutput images = 4;

Parameters
$var : ImageOutput
Return values
$this

setStorage()

Per-output storage override (falls back to request, then server)

public setStorage(StorageConfig $var) : $this

Generated from protobuf field .livekit.StorageConfig storage = 6;

Parameters
$var : StorageConfig
Return values
$this

setStream()

Generated from protobuf field <code>.livekit.StreamOutput stream = 2;</code>

public setStream(StreamOutput $var) : $this
Parameters
$var : StreamOutput
Return values
$this

        
On this page

Search results