Documentation

SegmentedFileOutput extends Message
in package

Used to generate HLS segments or other kind of segmented output

Generated from protobuf message livekit.SegmentedFileOutput

Table of Contents

Properties

$disable_manifest  : mixed
disable upload of manifest file (default false)
$filename_prefix  : mixed
(optional)
$filename_suffix  : mixed
(optional, default INDEX)
$live_playlist_name  : mixed
(optional, disabled if not provided). Path of a live playlist
$output  : mixed
$playlist_name  : mixed
(optional)
$protocol  : mixed
(optional)
$segment_duration  : mixed
in seconds (optional)

Methods

__construct()  : mixed
Constructor.
getAliOSS()  : AliOSSUpload|null
Generated from protobuf field <code>.livekit.AliOSSUpload aliOSS = 9;</code>
getAzure()  : AzureBlobUpload|null
Generated from protobuf field <code>.livekit.AzureBlobUpload azure = 7;</code>
getDisableManifest()  : bool
disable upload of manifest file (default false)
getFilenamePrefix()  : string
(optional)
getFilenameSuffix()  : int
(optional, default INDEX)
getGcp()  : GCPUpload|null
Generated from protobuf field <code>.livekit.GCPUpload gcp = 6;</code>
getLivePlaylistName()  : string
(optional, disabled if not provided). Path of a live playlist
getOutput()  : string
getPlaylistName()  : string
(optional)
getProtocol()  : int
(optional)
getS3()  : S3Upload|null
Generated from protobuf field <code>.livekit.S3Upload s3 = 5;</code>
getSegmentDuration()  : int
in seconds (optional)
hasAliOSS()  : mixed
hasAzure()  : mixed
hasGcp()  : mixed
hasS3()  : mixed
setAliOSS()  : $this
Generated from protobuf field <code>.livekit.AliOSSUpload aliOSS = 9;</code>
setAzure()  : $this
Generated from protobuf field <code>.livekit.AzureBlobUpload azure = 7;</code>
setDisableManifest()  : $this
disable upload of manifest file (default false)
setFilenamePrefix()  : $this
(optional)
setFilenameSuffix()  : $this
(optional, default INDEX)
setGcp()  : $this
Generated from protobuf field <code>.livekit.GCPUpload gcp = 6;</code>
setLivePlaylistName()  : $this
(optional, disabled if not provided). Path of a live playlist
setPlaylistName()  : $this
(optional)
setProtocol()  : $this
(optional)
setS3()  : $this
Generated from protobuf field <code>.livekit.S3Upload s3 = 5;</code>
setSegmentDuration()  : $this
in seconds (optional)

Properties

$disable_manifest

disable upload of manifest file (default false)

protected mixed $disable_manifest = false

Generated from protobuf field bool disable_manifest = 8;

$filename_prefix

(optional)

protected mixed $filename_prefix = ''

Generated from protobuf field string filename_prefix = 2;

$filename_suffix

(optional, default INDEX)

protected mixed $filename_suffix = 0

Generated from protobuf field .livekit.SegmentedFileSuffix filename_suffix = 10;

$live_playlist_name

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

protected mixed $live_playlist_name = ''

Generated from protobuf field string live_playlist_name = 11;

$playlist_name

(optional)

protected mixed $playlist_name = ''

Generated from protobuf field string playlist_name = 3;

$protocol

(optional)

protected mixed $protocol = 0

Generated from protobuf field .livekit.SegmentedFileProtocol protocol = 1;

$segment_duration

in seconds (optional)

protected mixed $segment_duration = 0

Generated from protobuf field uint32 segment_duration = 4;

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 int $protocol
      (optional)
@type string $filename_prefix
      (optional)
@type string $playlist_name
      (optional)
@type string $live_playlist_name
      (optional, disabled if not provided). Path of a live playlist
@type int $segment_duration
      in seconds (optional)
@type int $filename_suffix
      (optional, default INDEX)
@type bool $disable_manifest
      disable upload of manifest file (default false)
@type \Livekit\S3Upload $s3
@type \Livekit\GCPUpload $gcp
@type \Livekit\AzureBlobUpload $azure
@type \Livekit\AliOSSUpload $aliOSS

}

getDisableManifest()

disable upload of manifest file (default false)

public getDisableManifest() : bool

Generated from protobuf field bool disable_manifest = 8;

Return values
bool

getFilenamePrefix()

(optional)

public getFilenamePrefix() : string

Generated from protobuf field string filename_prefix = 2;

Return values
string

getFilenameSuffix()

(optional, default INDEX)

public getFilenameSuffix() : int

Generated from protobuf field .livekit.SegmentedFileSuffix filename_suffix = 10;

Return values
int

getLivePlaylistName()

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

public getLivePlaylistName() : string

Generated from protobuf field string live_playlist_name = 11;

Return values
string

getPlaylistName()

(optional)

public getPlaylistName() : string

Generated from protobuf field string playlist_name = 3;

Return values
string

getProtocol()

(optional)

public getProtocol() : int

Generated from protobuf field .livekit.SegmentedFileProtocol protocol = 1;

Return values
int

getSegmentDuration()

in seconds (optional)

public getSegmentDuration() : int

Generated from protobuf field uint32 segment_duration = 4;

Return values
int

setDisableManifest()

disable upload of manifest file (default false)

public setDisableManifest(bool $var) : $this

Generated from protobuf field bool disable_manifest = 8;

Parameters
$var : bool
Return values
$this

setFilenamePrefix()

(optional)

public setFilenamePrefix(string $var) : $this

Generated from protobuf field string filename_prefix = 2;

Parameters
$var : string
Return values
$this

setFilenameSuffix()

(optional, default INDEX)

public setFilenameSuffix(int $var) : $this

Generated from protobuf field .livekit.SegmentedFileSuffix filename_suffix = 10;

Parameters
$var : int
Return values
$this

setLivePlaylistName()

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

public setLivePlaylistName(string $var) : $this

Generated from protobuf field string live_playlist_name = 11;

Parameters
$var : string
Return values
$this

setPlaylistName()

(optional)

public setPlaylistName(string $var) : $this

Generated from protobuf field string playlist_name = 3;

Parameters
$var : string
Return values
$this

setProtocol()

(optional)

public setProtocol(int $var) : $this

Generated from protobuf field .livekit.SegmentedFileProtocol protocol = 1;

Parameters
$var : int
Return values
$this

setSegmentDuration()

in seconds (optional)

public setSegmentDuration(int $var) : $this

Generated from protobuf field uint32 segment_duration = 4;

Parameters
$var : int
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results