Documentation

WebSource extends Message
in package

Record a custom URL via headless browser.

Generated from protobuf message livekit.WebSource

Table of Contents

Properties

$audio_only  : mixed
Generated from protobuf field <code>bool audio_only = 2;</code>
$await_start_signal  : mixed
Generated from protobuf field <code>bool await_start_signal = 4;</code>
$url  : mixed
Generated from protobuf field <code>string url = 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>
getAwaitStartSignal()  : bool
Generated from protobuf field <code>bool await_start_signal = 4;</code>
getUrl()  : string
Generated from protobuf field <code>string url = 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>
setAwaitStartSignal()  : $this
Generated from protobuf field <code>bool await_start_signal = 4;</code>
setUrl()  : $this
Generated from protobuf field <code>string url = 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

$await_start_signal

Generated from protobuf field <code>bool await_start_signal = 4;</code>

protected mixed $await_start_signal = false

$url

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

protected mixed $url = ''

$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 $url
@type bool $audio_only
@type bool $video_only
@type bool $await_start_signal

}

getAudioOnly()

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

public getAudioOnly() : bool
Return values
bool

getAwaitStartSignal()

Generated from protobuf field <code>bool await_start_signal = 4;</code>

public getAwaitStartSignal() : bool
Return values
bool

getUrl()

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

public getUrl() : 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

setAwaitStartSignal()

Generated from protobuf field <code>bool await_start_signal = 4;</code>

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

setUrl()

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

public setUrl(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