Documentation

TemplateSource extends Message
in package

Room composite recording via layout template.

Service generates token, constructs recorder URL, awaits start signal.

Generated from protobuf message livekit.TemplateSource

Table of Contents

Properties

$audio_only  : mixed
Generated from protobuf field <code>bool audio_only = 2;</code>
$custom_base_url  : mixed
Generated from protobuf field <code>string custom_base_url = 4;</code>
$layout  : mixed
Generated from protobuf field <code>string layout = 1;</code>
$video_only  : mixed
Generated from protobuf field <code>bool video_only = 3;</code>

Methods

__construct()  : mixed
Constructor.
getAudioOnly()  : bool
Generated from protobuf field <code>bool audio_only = 2;</code>
getCustomBaseUrl()  : string
Generated from protobuf field <code>string custom_base_url = 4;</code>
getLayout()  : string
Generated from protobuf field <code>string layout = 1;</code>
getVideoOnly()  : bool
Generated from protobuf field <code>bool video_only = 3;</code>
setAudioOnly()  : $this
Generated from protobuf field <code>bool audio_only = 2;</code>
setCustomBaseUrl()  : $this
Generated from protobuf field <code>string custom_base_url = 4;</code>
setLayout()  : $this
Generated from protobuf field <code>string layout = 1;</code>
setVideoOnly()  : $this
Generated from protobuf field <code>bool video_only = 3;</code>

Properties

$audio_only

Generated from protobuf field <code>bool audio_only = 2;</code>

protected mixed $audio_only = false

$custom_base_url

Generated from protobuf field <code>string custom_base_url = 4;</code>

protected mixed $custom_base_url = ''

$layout

Generated from protobuf field <code>string layout = 1;</code>

protected mixed $layout = ''

$video_only

Generated from protobuf field <code>bool video_only = 3;</code>

protected mixed $video_only = false

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 string $layout
@type bool $audio_only
@type bool $video_only
@type string $custom_base_url

}

getAudioOnly()

Generated from protobuf field <code>bool audio_only = 2;</code>

public getAudioOnly() : bool
Return values
bool

getCustomBaseUrl()

Generated from protobuf field <code>string custom_base_url = 4;</code>

public getCustomBaseUrl() : string
Return values
string

getLayout()

Generated from protobuf field <code>string layout = 1;</code>

public getLayout() : string
Return values
string

getVideoOnly()

Generated from protobuf field <code>bool video_only = 3;</code>

public getVideoOnly() : bool
Return values
bool

setAudioOnly()

Generated from protobuf field <code>bool audio_only = 2;</code>

public setAudioOnly(bool $var) : $this
Parameters
$var : bool
Return values
$this

setCustomBaseUrl()

Generated from protobuf field <code>string custom_base_url = 4;</code>

public setCustomBaseUrl(string $var) : $this
Parameters
$var : string
Return values
$this

setLayout()

Generated from protobuf field <code>string layout = 1;</code>

public setLayout(string $var) : $this
Parameters
$var : string
Return values
$this

setVideoOnly()

Generated from protobuf field <code>bool video_only = 3;</code>

public setVideoOnly(bool $var) : $this
Parameters
$var : bool
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results