code
stringlengths 17
247k
| docstring
stringlengths 30
30.3k
| func_name
stringlengths 1
89
| language
stringclasses 1
value | repo
stringlengths 7
63
| path
stringlengths 7
153
| url
stringlengths 51
209
| license
stringclasses 4
values |
|---|---|---|---|---|---|---|---|
public function getEmptyTimeout()
{
return $this->empty_timeout;
} | number of seconds to keep the room open if no one joins
Generated from protobuf field <code>uint32 empty_timeout = 2;</code>
@return int | getEmptyTimeout | php | agence104/livekit-server-sdk-php | src/proto/Livekit/CreateRoomRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/CreateRoomRequest.php | Apache-2.0 |
public function setEmptyTimeout($var)
{
GPBUtil::checkUint32($var);
$this->empty_timeout = $var;
return $this;
} | number of seconds to keep the room open if no one joins
Generated from protobuf field <code>uint32 empty_timeout = 2;</code>
@param int $var
@return $this | setEmptyTimeout | php | agence104/livekit-server-sdk-php | src/proto/Livekit/CreateRoomRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/CreateRoomRequest.php | Apache-2.0 |
public function getDepartureTimeout()
{
return $this->departure_timeout;
} | number of seconds to keep the room open after everyone leaves
Generated from protobuf field <code>uint32 departure_timeout = 10;</code>
@return int | getDepartureTimeout | php | agence104/livekit-server-sdk-php | src/proto/Livekit/CreateRoomRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/CreateRoomRequest.php | Apache-2.0 |
public function setDepartureTimeout($var)
{
GPBUtil::checkUint32($var);
$this->departure_timeout = $var;
return $this;
} | number of seconds to keep the room open after everyone leaves
Generated from protobuf field <code>uint32 departure_timeout = 10;</code>
@param int $var
@return $this | setDepartureTimeout | php | agence104/livekit-server-sdk-php | src/proto/Livekit/CreateRoomRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/CreateRoomRequest.php | Apache-2.0 |
public function getMaxParticipants()
{
return $this->max_participants;
} | limit number of participants that can be in a room
Generated from protobuf field <code>uint32 max_participants = 3;</code>
@return int | getMaxParticipants | php | agence104/livekit-server-sdk-php | src/proto/Livekit/CreateRoomRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/CreateRoomRequest.php | Apache-2.0 |
public function setMaxParticipants($var)
{
GPBUtil::checkUint32($var);
$this->max_participants = $var;
return $this;
} | limit number of participants that can be in a room
Generated from protobuf field <code>uint32 max_participants = 3;</code>
@param int $var
@return $this | setMaxParticipants | php | agence104/livekit-server-sdk-php | src/proto/Livekit/CreateRoomRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/CreateRoomRequest.php | Apache-2.0 |
public function getEgress()
{
return $this->egress;
} | auto-egress configurations
Generated from protobuf field <code>.livekit.RoomEgress egress = 6;</code>
@return \Livekit\RoomEgress|null | getEgress | php | agence104/livekit-server-sdk-php | src/proto/Livekit/CreateRoomRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/CreateRoomRequest.php | Apache-2.0 |
public function setEgress($var)
{
GPBUtil::checkMessage($var, \Livekit\RoomEgress::class);
$this->egress = $var;
return $this;
} | auto-egress configurations
Generated from protobuf field <code>.livekit.RoomEgress egress = 6;</code>
@param \Livekit\RoomEgress $var
@return $this | setEgress | php | agence104/livekit-server-sdk-php | src/proto/Livekit/CreateRoomRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/CreateRoomRequest.php | Apache-2.0 |
public function getMinPlayoutDelay()
{
return $this->min_playout_delay;
} | playout delay of subscriber
Generated from protobuf field <code>uint32 min_playout_delay = 7;</code>
@return int | getMinPlayoutDelay | php | agence104/livekit-server-sdk-php | src/proto/Livekit/CreateRoomRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/CreateRoomRequest.php | Apache-2.0 |
public function setMinPlayoutDelay($var)
{
GPBUtil::checkUint32($var);
$this->min_playout_delay = $var;
return $this;
} | playout delay of subscriber
Generated from protobuf field <code>uint32 min_playout_delay = 7;</code>
@param int $var
@return $this | setMinPlayoutDelay | php | agence104/livekit-server-sdk-php | src/proto/Livekit/CreateRoomRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/CreateRoomRequest.php | Apache-2.0 |
public function getMaxPlayoutDelay()
{
return $this->max_playout_delay;
} | Generated from protobuf field <code>uint32 max_playout_delay = 8;</code>
@return int | getMaxPlayoutDelay | php | agence104/livekit-server-sdk-php | src/proto/Livekit/CreateRoomRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/CreateRoomRequest.php | Apache-2.0 |
public function setMaxPlayoutDelay($var)
{
GPBUtil::checkUint32($var);
$this->max_playout_delay = $var;
return $this;
} | Generated from protobuf field <code>uint32 max_playout_delay = 8;</code>
@param int $var
@return $this | setMaxPlayoutDelay | php | agence104/livekit-server-sdk-php | src/proto/Livekit/CreateRoomRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/CreateRoomRequest.php | Apache-2.0 |
public function getSyncStreams()
{
return $this->sync_streams;
} | improves A/V sync when playout_delay set to a value larger than 200ms. It will disables transceiver re-use
so not recommended for rooms with frequent subscription changes
Generated from protobuf field <code>bool sync_streams = 9;</code>
@return bool | getSyncStreams | php | agence104/livekit-server-sdk-php | src/proto/Livekit/CreateRoomRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/CreateRoomRequest.php | Apache-2.0 |
public function setSyncStreams($var)
{
GPBUtil::checkBool($var);
$this->sync_streams = $var;
return $this;
} | improves A/V sync when playout_delay set to a value larger than 200ms. It will disables transceiver re-use
so not recommended for rooms with frequent subscription changes
Generated from protobuf field <code>bool sync_streams = 9;</code>
@param bool $var
@return $this | setSyncStreams | php | agence104/livekit-server-sdk-php | src/proto/Livekit/CreateRoomRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/CreateRoomRequest.php | Apache-2.0 |
public function getReplayEnabled()
{
return $this->replay_enabled;
} | replay
Generated from protobuf field <code>bool replay_enabled = 13;</code>
@return bool | getReplayEnabled | php | agence104/livekit-server-sdk-php | src/proto/Livekit/CreateRoomRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/CreateRoomRequest.php | Apache-2.0 |
public function setReplayEnabled($var)
{
GPBUtil::checkBool($var);
$this->replay_enabled = $var;
return $this;
} | replay
Generated from protobuf field <code>bool replay_enabled = 13;</code>
@param bool $var
@return $this | setReplayEnabled | php | agence104/livekit-server-sdk-php | src/proto/Livekit/CreateRoomRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/CreateRoomRequest.php | Apache-2.0 |
public function getAgents()
{
return $this->agents;
} | Define agents that should be dispatched to this room
Generated from protobuf field <code>repeated .livekit.RoomAgentDispatch agents = 14;</code>
@return \Google\Protobuf\Internal\RepeatedField | getAgents | php | agence104/livekit-server-sdk-php | src/proto/Livekit/CreateRoomRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/CreateRoomRequest.php | Apache-2.0 |
public function setAgents($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Livekit\RoomAgentDispatch::class);
$this->agents = $arr;
return $this;
} | Define agents that should be dispatched to this room
Generated from protobuf field <code>repeated .livekit.RoomAgentDispatch agents = 14;</code>
@param \Livekit\RoomAgentDispatch[]|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setAgents | php | agence104/livekit-server-sdk-php | src/proto/Livekit/CreateRoomRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/CreateRoomRequest.php | Apache-2.0 |
public function getQuality()
{
return $this->quality;
} | for tracks with a single layer, this should be HIGH
Generated from protobuf field <code>.livekit.VideoQuality quality = 1;</code>
@return int | getQuality | php | agence104/livekit-server-sdk-php | src/proto/Livekit/VideoLayer.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/VideoLayer.php | Apache-2.0 |
public function setQuality($var)
{
GPBUtil::checkEnum($var, \Livekit\VideoQuality::class);
$this->quality = $var;
return $this;
} | for tracks with a single layer, this should be HIGH
Generated from protobuf field <code>.livekit.VideoQuality quality = 1;</code>
@param int $var
@return $this | setQuality | php | agence104/livekit-server-sdk-php | src/proto/Livekit/VideoLayer.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/VideoLayer.php | Apache-2.0 |
public function getWidth()
{
return $this->width;
} | Generated from protobuf field <code>uint32 width = 2;</code>
@return int | getWidth | php | agence104/livekit-server-sdk-php | src/proto/Livekit/VideoLayer.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/VideoLayer.php | Apache-2.0 |
public function setWidth($var)
{
GPBUtil::checkUint32($var);
$this->width = $var;
return $this;
} | Generated from protobuf field <code>uint32 width = 2;</code>
@param int $var
@return $this | setWidth | php | agence104/livekit-server-sdk-php | src/proto/Livekit/VideoLayer.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/VideoLayer.php | Apache-2.0 |
public function getHeight()
{
return $this->height;
} | Generated from protobuf field <code>uint32 height = 3;</code>
@return int | getHeight | php | agence104/livekit-server-sdk-php | src/proto/Livekit/VideoLayer.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/VideoLayer.php | Apache-2.0 |
public function setHeight($var)
{
GPBUtil::checkUint32($var);
$this->height = $var;
return $this;
} | Generated from protobuf field <code>uint32 height = 3;</code>
@param int $var
@return $this | setHeight | php | agence104/livekit-server-sdk-php | src/proto/Livekit/VideoLayer.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/VideoLayer.php | Apache-2.0 |
public function getBitrate()
{
return $this->bitrate;
} | target bitrate in bit per second (bps), server will measure actual
Generated from protobuf field <code>uint32 bitrate = 4;</code>
@return int | getBitrate | php | agence104/livekit-server-sdk-php | src/proto/Livekit/VideoLayer.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/VideoLayer.php | Apache-2.0 |
public function setBitrate($var)
{
GPBUtil::checkUint32($var);
$this->bitrate = $var;
return $this;
} | target bitrate in bit per second (bps), server will measure actual
Generated from protobuf field <code>uint32 bitrate = 4;</code>
@param int $var
@return $this | setBitrate | php | agence104/livekit-server-sdk-php | src/proto/Livekit/VideoLayer.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/VideoLayer.php | Apache-2.0 |
public function getSsrc()
{
return $this->ssrc;
} | Generated from protobuf field <code>uint32 ssrc = 5;</code>
@return int | getSsrc | php | agence104/livekit-server-sdk-php | src/proto/Livekit/VideoLayer.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/VideoLayer.php | Apache-2.0 |
public function setSsrc($var)
{
GPBUtil::checkUint32($var);
$this->ssrc = $var;
return $this;
} | Generated from protobuf field <code>uint32 ssrc = 5;</code>
@param int $var
@return $this | setSsrc | php | agence104/livekit-server-sdk-php | src/proto/Livekit/VideoLayer.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/VideoLayer.php | Apache-2.0 |
public function getAddOutputUrls()
{
return $this->add_output_urls;
} | Generated from protobuf field <code>repeated string add_output_urls = 2;</code>
@return \Google\Protobuf\Internal\RepeatedField | getAddOutputUrls | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UpdateStreamRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UpdateStreamRequest.php | Apache-2.0 |
public function setAddOutputUrls($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->add_output_urls = $arr;
return $this;
} | Generated from protobuf field <code>repeated string add_output_urls = 2;</code>
@param string[]|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setAddOutputUrls | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UpdateStreamRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UpdateStreamRequest.php | Apache-2.0 |
public function getRemoveOutputUrls()
{
return $this->remove_output_urls;
} | Generated from protobuf field <code>repeated string remove_output_urls = 3;</code>
@return \Google\Protobuf\Internal\RepeatedField | getRemoveOutputUrls | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UpdateStreamRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UpdateStreamRequest.php | Apache-2.0 |
public function setRemoveOutputUrls($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->remove_output_urls = $arr;
return $this;
} | Generated from protobuf field <code>repeated string remove_output_urls = 3;</code>
@param string[]|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setRemoveOutputUrls | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UpdateStreamRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UpdateStreamRequest.php | Apache-2.0 |
public function setWidth($var)
{
GPBUtil::checkInt32($var);
$this->width = $var;
return $this;
} | (default 1920)
Generated from protobuf field <code>int32 width = 1;</code>
@param int $var
@return $this | setWidth | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function setHeight($var)
{
GPBUtil::checkInt32($var);
$this->height = $var;
return $this;
} | (default 1080)
Generated from protobuf field <code>int32 height = 2;</code>
@param int $var
@return $this | setHeight | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function getDepth()
{
return $this->depth;
} | (default 24)
Generated from protobuf field <code>int32 depth = 3;</code>
@return int | getDepth | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function setDepth($var)
{
GPBUtil::checkInt32($var);
$this->depth = $var;
return $this;
} | (default 24)
Generated from protobuf field <code>int32 depth = 3;</code>
@param int $var
@return $this | setDepth | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function getFramerate()
{
return $this->framerate;
} | (default 30)
Generated from protobuf field <code>int32 framerate = 4;</code>
@return int | getFramerate | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function setFramerate($var)
{
GPBUtil::checkInt32($var);
$this->framerate = $var;
return $this;
} | (default 30)
Generated from protobuf field <code>int32 framerate = 4;</code>
@param int $var
@return $this | setFramerate | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function getAudioCodec()
{
return $this->audio_codec;
} | (default OPUS)
Generated from protobuf field <code>.livekit.AudioCodec audio_codec = 5;</code>
@return int | getAudioCodec | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function setAudioCodec($var)
{
GPBUtil::checkEnum($var, \Livekit\AudioCodec::class);
$this->audio_codec = $var;
return $this;
} | (default OPUS)
Generated from protobuf field <code>.livekit.AudioCodec audio_codec = 5;</code>
@param int $var
@return $this | setAudioCodec | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function getAudioBitrate()
{
return $this->audio_bitrate;
} | (default 128)
Generated from protobuf field <code>int32 audio_bitrate = 6;</code>
@return int | getAudioBitrate | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function setAudioBitrate($var)
{
GPBUtil::checkInt32($var);
$this->audio_bitrate = $var;
return $this;
} | (default 128)
Generated from protobuf field <code>int32 audio_bitrate = 6;</code>
@param int $var
@return $this | setAudioBitrate | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function getAudioQuality()
{
return $this->audio_quality;
} | quality setting on audio encoder
Generated from protobuf field <code>int32 audio_quality = 11;</code>
@return int | getAudioQuality | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function setAudioQuality($var)
{
GPBUtil::checkInt32($var);
$this->audio_quality = $var;
return $this;
} | quality setting on audio encoder
Generated from protobuf field <code>int32 audio_quality = 11;</code>
@param int $var
@return $this | setAudioQuality | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function getAudioFrequency()
{
return $this->audio_frequency;
} | (default 44100)
Generated from protobuf field <code>int32 audio_frequency = 7;</code>
@return int | getAudioFrequency | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function setAudioFrequency($var)
{
GPBUtil::checkInt32($var);
$this->audio_frequency = $var;
return $this;
} | (default 44100)
Generated from protobuf field <code>int32 audio_frequency = 7;</code>
@param int $var
@return $this | setAudioFrequency | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function getVideoCodec()
{
return $this->video_codec;
} | (default H264_MAIN)
Generated from protobuf field <code>.livekit.VideoCodec video_codec = 8;</code>
@return int | getVideoCodec | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function setVideoCodec($var)
{
GPBUtil::checkEnum($var, \Livekit\VideoCodec::class);
$this->video_codec = $var;
return $this;
} | (default H264_MAIN)
Generated from protobuf field <code>.livekit.VideoCodec video_codec = 8;</code>
@param int $var
@return $this | setVideoCodec | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function getVideoBitrate()
{
return $this->video_bitrate;
} | (default 4500)
Generated from protobuf field <code>int32 video_bitrate = 9;</code>
@return int | getVideoBitrate | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function setVideoBitrate($var)
{
GPBUtil::checkInt32($var);
$this->video_bitrate = $var;
return $this;
} | (default 4500)
Generated from protobuf field <code>int32 video_bitrate = 9;</code>
@param int $var
@return $this | setVideoBitrate | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function getVideoQuality()
{
return $this->video_quality;
} | quality setting on video encoder
Generated from protobuf field <code>int32 video_quality = 12;</code>
@return int | getVideoQuality | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function setVideoQuality($var)
{
GPBUtil::checkInt32($var);
$this->video_quality = $var;
return $this;
} | quality setting on video encoder
Generated from protobuf field <code>int32 video_quality = 12;</code>
@param int $var
@return $this | setVideoQuality | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function getKeyFrameInterval()
{
return $this->key_frame_interval;
} | in seconds (default 4s for streaming, segment duration for segmented output, encoder default for files)
Generated from protobuf field <code>double key_frame_interval = 10;</code>
@return float | getKeyFrameInterval | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function setKeyFrameInterval($var)
{
GPBUtil::checkDouble($var);
$this->key_frame_interval = $var;
return $this;
} | in seconds (default 4s for streaming, segment duration for segmented output, encoder default for files)
Generated from protobuf field <code>double key_frame_interval = 10;</code>
@param float $var
@return $this | setKeyFrameInterval | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EncodingOptions.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EncodingOptions.php | Apache-2.0 |
public function getKind()
{
return $this->kind;
} | Generated from protobuf field <code>.livekit.SIPTrunkInfo.TrunkKind kind = 14;</code>
@return int | getKind | php | agence104/livekit-server-sdk-php | src/proto/Livekit/SIPTrunkInfo.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/SIPTrunkInfo.php | Apache-2.0 |
public function setKind($var)
{
GPBUtil::checkEnum($var, \Livekit\SIPTrunkInfo\TrunkKind::class);
$this->kind = $var;
return $this;
} | Generated from protobuf field <code>.livekit.SIPTrunkInfo.TrunkKind kind = 14;</code>
@param int $var
@return $this | setKind | php | agence104/livekit-server-sdk-php | src/proto/Livekit/SIPTrunkInfo.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/SIPTrunkInfo.php | Apache-2.0 |
public function getTransport()
{
return $this->transport;
} | Transport used for inbound and outbound calls.
Generated from protobuf field <code>.livekit.SIPTransport transport = 13;</code>
@return int | getTransport | php | agence104/livekit-server-sdk-php | src/proto/Livekit/SIPTrunkInfo.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/SIPTrunkInfo.php | Apache-2.0 |
public function setTransport($var)
{
GPBUtil::checkEnum($var, \Livekit\SIPTransport::class);
$this->transport = $var;
return $this;
} | Transport used for inbound and outbound calls.
Generated from protobuf field <code>.livekit.SIPTransport transport = 13;</code>
@param int $var
@return $this | setTransport | php | agence104/livekit-server-sdk-php | src/proto/Livekit/SIPTrunkInfo.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/SIPTrunkInfo.php | Apache-2.0 |
public function getPreset()
{
return $this->readOneof(1);
} | (default H264_720P_30)
Generated from protobuf field <code>.livekit.EncodingOptionsPreset preset = 1;</code>
@return int | getPreset | php | agence104/livekit-server-sdk-php | src/proto/Livekit/AutoParticipantEgress.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/AutoParticipantEgress.php | Apache-2.0 |
public function setPreset($var)
{
GPBUtil::checkEnum($var, \Livekit\EncodingOptionsPreset::class);
$this->writeOneof(1, $var);
return $this;
} | (default H264_720P_30)
Generated from protobuf field <code>.livekit.EncodingOptionsPreset preset = 1;</code>
@param int $var
@return $this | setPreset | php | agence104/livekit-server-sdk-php | src/proto/Livekit/AutoParticipantEgress.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/AutoParticipantEgress.php | Apache-2.0 |
public function getAdvanced()
{
return $this->readOneof(2);
} | (optional)
Generated from protobuf field <code>.livekit.EncodingOptions advanced = 2;</code>
@return \Livekit\EncodingOptions|null | getAdvanced | php | agence104/livekit-server-sdk-php | src/proto/Livekit/AutoParticipantEgress.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/AutoParticipantEgress.php | Apache-2.0 |
public function setAdvanced($var)
{
GPBUtil::checkMessage($var, \Livekit\EncodingOptions::class);
$this->writeOneof(2, $var);
return $this;
} | (optional)
Generated from protobuf field <code>.livekit.EncodingOptions advanced = 2;</code>
@param \Livekit\EncodingOptions $var
@return $this | setAdvanced | php | agence104/livekit-server-sdk-php | src/proto/Livekit/AutoParticipantEgress.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/AutoParticipantEgress.php | Apache-2.0 |
public function getFileOutputs()
{
return $this->file_outputs;
} | Generated from protobuf field <code>repeated .livekit.EncodedFileOutput file_outputs = 3;</code>
@return \Google\Protobuf\Internal\RepeatedField | getFileOutputs | php | agence104/livekit-server-sdk-php | src/proto/Livekit/AutoParticipantEgress.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/AutoParticipantEgress.php | Apache-2.0 |
public function setFileOutputs($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Livekit\EncodedFileOutput::class);
$this->file_outputs = $arr;
return $this;
} | Generated from protobuf field <code>repeated .livekit.EncodedFileOutput file_outputs = 3;</code>
@param \Livekit\EncodedFileOutput[]|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setFileOutputs | php | agence104/livekit-server-sdk-php | src/proto/Livekit/AutoParticipantEgress.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/AutoParticipantEgress.php | Apache-2.0 |
public function getSegmentOutputs()
{
return $this->segment_outputs;
} | Generated from protobuf field <code>repeated .livekit.SegmentedFileOutput segment_outputs = 4;</code>
@return \Google\Protobuf\Internal\RepeatedField | getSegmentOutputs | php | agence104/livekit-server-sdk-php | src/proto/Livekit/AutoParticipantEgress.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/AutoParticipantEgress.php | Apache-2.0 |
public function setSegmentOutputs($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::MESSAGE, \Livekit\SegmentedFileOutput::class);
$this->segment_outputs = $arr;
return $this;
} | Generated from protobuf field <code>repeated .livekit.SegmentedFileOutput segment_outputs = 4;</code>
@param \Livekit\SegmentedFileOutput[]|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setSegmentOutputs | php | agence104/livekit-server-sdk-php | src/proto/Livekit/AutoParticipantEgress.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/AutoParticipantEgress.php | Apache-2.0 |
public function getParticipantSid()
{
@trigger_error('participant_sid is deprecated.', E_USER_DEPRECATED);
return $this->participant_sid;
} | participant ID of user that sent the message
Generated from protobuf field <code>string participant_sid = 1 [deprecated = true];</code>
@return string
@deprecated | getParticipantSid | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function setParticipantSid($var)
{
@trigger_error('participant_sid is deprecated.', E_USER_DEPRECATED);
GPBUtil::checkString($var, True);
$this->participant_sid = $var;
return $this;
} | participant ID of user that sent the message
Generated from protobuf field <code>string participant_sid = 1 [deprecated = true];</code>
@param string $var
@return $this
@deprecated | setParticipantSid | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function getParticipantIdentity()
{
@trigger_error('participant_identity is deprecated.', E_USER_DEPRECATED);
return $this->participant_identity;
} | Generated from protobuf field <code>string participant_identity = 5 [deprecated = true];</code>
@return string
@deprecated | getParticipantIdentity | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function setParticipantIdentity($var)
{
@trigger_error('participant_identity is deprecated.', E_USER_DEPRECATED);
GPBUtil::checkString($var, True);
$this->participant_identity = $var;
return $this;
} | Generated from protobuf field <code>string participant_identity = 5 [deprecated = true];</code>
@param string $var
@return $this
@deprecated | setParticipantIdentity | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function getPayload()
{
return $this->payload;
} | user defined payload
Generated from protobuf field <code>bytes payload = 2;</code>
@return string | getPayload | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function setPayload($var)
{
GPBUtil::checkString($var, False);
$this->payload = $var;
return $this;
} | user defined payload
Generated from protobuf field <code>bytes payload = 2;</code>
@param string $var
@return $this | setPayload | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function getDestinationSids()
{
@trigger_error('destination_sids is deprecated.', E_USER_DEPRECATED);
return $this->destination_sids;
} | the ID of the participants who will receive the message (sent to all by default)
Generated from protobuf field <code>repeated string destination_sids = 3 [deprecated = true];</code>
@return \Google\Protobuf\Internal\RepeatedField
@deprecated | getDestinationSids | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function setDestinationSids($var)
{
@trigger_error('destination_sids is deprecated.', E_USER_DEPRECATED);
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->destination_sids = $arr;
return $this;
} | the ID of the participants who will receive the message (sent to all by default)
Generated from protobuf field <code>repeated string destination_sids = 3 [deprecated = true];</code>
@param string[]|\Google\Protobuf\Internal\RepeatedField $var
@return $this
@deprecated | setDestinationSids | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function getDestinationIdentities()
{
@trigger_error('destination_identities is deprecated.', E_USER_DEPRECATED);
return $this->destination_identities;
} | identities of participants who will receive the message (sent to all by default)
Generated from protobuf field <code>repeated string destination_identities = 6 [deprecated = true];</code>
@return \Google\Protobuf\Internal\RepeatedField
@deprecated | getDestinationIdentities | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function setDestinationIdentities($var)
{
@trigger_error('destination_identities is deprecated.', E_USER_DEPRECATED);
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->destination_identities = $arr;
return $this;
} | identities of participants who will receive the message (sent to all by default)
Generated from protobuf field <code>repeated string destination_identities = 6 [deprecated = true];</code>
@param string[]|\Google\Protobuf\Internal\RepeatedField $var
@return $this
@deprecated | setDestinationIdentities | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function getTopic()
{
return isset($this->topic) ? $this->topic : '';
} | topic under which the message was published
Generated from protobuf field <code>optional string topic = 4;</code>
@return string | getTopic | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function setTopic($var)
{
GPBUtil::checkString($var, True);
$this->topic = $var;
return $this;
} | topic under which the message was published
Generated from protobuf field <code>optional string topic = 4;</code>
@param string $var
@return $this | setTopic | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function getId()
{
return isset($this->id) ? $this->id : '';
} | Unique ID to indentify the message
Generated from protobuf field <code>optional string id = 8;</code>
@return string | getId | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function getStartTime()
{
return isset($this->start_time) ? $this->start_time : 0;
} | start and end time allow relating the message to specific media time
Generated from protobuf field <code>optional uint64 start_time = 9;</code>
@return int|string | getStartTime | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function setStartTime($var)
{
GPBUtil::checkUint64($var);
$this->start_time = $var;
return $this;
} | start and end time allow relating the message to specific media time
Generated from protobuf field <code>optional uint64 start_time = 9;</code>
@param int|string $var
@return $this | setStartTime | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function getEndTime()
{
return isset($this->end_time) ? $this->end_time : 0;
} | Generated from protobuf field <code>optional uint64 end_time = 10;</code>
@return int|string | getEndTime | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function setEndTime($var)
{
GPBUtil::checkUint64($var);
$this->end_time = $var;
return $this;
} | Generated from protobuf field <code>optional uint64 end_time = 10;</code>
@param int|string $var
@return $this | setEndTime | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function getNonce()
{
return $this->nonce;
} | added by SDK to enable de-duping of messages, for INTERNAL USE ONLY
Generated from protobuf field <code>bytes nonce = 11;</code>
@return string | getNonce | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function setNonce($var)
{
GPBUtil::checkString($var, False);
$this->nonce = $var;
return $this;
} | added by SDK to enable de-duping of messages, for INTERNAL USE ONLY
Generated from protobuf field <code>bytes nonce = 11;</code>
@param string $var
@return $this | setNonce | php | agence104/livekit-server-sdk-php | src/proto/Livekit/UserPacket.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/UserPacket.php | Apache-2.0 |
public function getUnixMicro()
{
return $this->unix_micro;
} | Generated from protobuf field <code>int64 unix_micro = 1;</code>
@return int|string | getUnixMicro | php | agence104/livekit-server-sdk-php | src/proto/Livekit/TimedVersion.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/TimedVersion.php | Apache-2.0 |
public function setUnixMicro($var)
{
GPBUtil::checkInt64($var);
$this->unix_micro = $var;
return $this;
} | Generated from protobuf field <code>int64 unix_micro = 1;</code>
@param int|string $var
@return $this | setUnixMicro | php | agence104/livekit-server-sdk-php | src/proto/Livekit/TimedVersion.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/TimedVersion.php | Apache-2.0 |
public function getTicks()
{
return $this->ticks;
} | Generated from protobuf field <code>int32 ticks = 2;</code>
@return int | getTicks | php | agence104/livekit-server-sdk-php | src/proto/Livekit/TimedVersion.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/TimedVersion.php | Apache-2.0 |
public function setTicks($var)
{
GPBUtil::checkInt32($var);
$this->ticks = $var;
return $this;
} | Generated from protobuf field <code>int32 ticks = 2;</code>
@param int $var
@return $this | setTicks | php | agence104/livekit-server-sdk-php | src/proto/Livekit/TimedVersion.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/TimedVersion.php | Apache-2.0 |
public function getPage()
{
return $this->page;
} | Generated from protobuf field <code>.livekit.Pagination page = 3;</code>
@return \Livekit\Pagination|null | getPage | php | agence104/livekit-server-sdk-php | src/proto/Livekit/ListSIPOutboundTrunkRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/ListSIPOutboundTrunkRequest.php | Apache-2.0 |
public function setPage($var)
{
GPBUtil::checkMessage($var, \Livekit\Pagination::class);
$this->page = $var;
return $this;
} | Generated from protobuf field <code>.livekit.Pagination page = 3;</code>
@param \Livekit\Pagination $var
@return $this | setPage | php | agence104/livekit-server-sdk-php | src/proto/Livekit/ListSIPOutboundTrunkRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/ListSIPOutboundTrunkRequest.php | Apache-2.0 |
public function getNumbers()
{
return $this->numbers;
} | Only list trunks that contain one of the numbers, including wildcard trunks.
Generated from protobuf field <code>repeated string numbers = 2;</code>
@return \Google\Protobuf\Internal\RepeatedField | getNumbers | php | agence104/livekit-server-sdk-php | src/proto/Livekit/ListSIPOutboundTrunkRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/ListSIPOutboundTrunkRequest.php | Apache-2.0 |
public function setNumbers($var)
{
$arr = GPBUtil::checkRepeatedField($var, \Google\Protobuf\Internal\GPBType::STRING);
$this->numbers = $arr;
return $this;
} | Only list trunks that contain one of the numbers, including wildcard trunks.
Generated from protobuf field <code>repeated string numbers = 2;</code>
@param string[]|\Google\Protobuf\Internal\RepeatedField $var
@return $this | setNumbers | php | agence104/livekit-server-sdk-php | src/proto/Livekit/ListSIPOutboundTrunkRequest.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/ListSIPOutboundTrunkRequest.php | Apache-2.0 |
public function getLabel()
{
return $this->label;
} | Generated from protobuf field <code>uint32 label = 1;</code>
@return int | getLabel | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EventMetric.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EventMetric.php | Apache-2.0 |
public function setLabel($var)
{
GPBUtil::checkUint32($var);
$this->label = $var;
return $this;
} | Generated from protobuf field <code>uint32 label = 1;</code>
@param int $var
@return $this | setLabel | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EventMetric.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EventMetric.php | Apache-2.0 |
public function setParticipantIdentity($var)
{
GPBUtil::checkUint32($var);
$this->participant_identity = $var;
return $this;
} | index into `str_data`
Generated from protobuf field <code>uint32 participant_identity = 2;</code>
@param int $var
@return $this | setParticipantIdentity | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EventMetric.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EventMetric.php | Apache-2.0 |
public function getTrackSid()
{
return $this->track_sid;
} | index into `str_data`
Generated from protobuf field <code>uint32 track_sid = 3;</code>
@return int | getTrackSid | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EventMetric.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EventMetric.php | Apache-2.0 |
public function setTrackSid($var)
{
GPBUtil::checkUint32($var);
$this->track_sid = $var;
return $this;
} | index into `str_data`
Generated from protobuf field <code>uint32 track_sid = 3;</code>
@param int $var
@return $this | setTrackSid | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EventMetric.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EventMetric.php | Apache-2.0 |
public function getStartTimestampMs()
{
return $this->start_timestamp_ms;
} | start time of event based on a monotonic clock (in milliseconds)
Generated from protobuf field <code>int64 start_timestamp_ms = 4;</code>
@return int|string | getStartTimestampMs | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EventMetric.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EventMetric.php | Apache-2.0 |
public function setStartTimestampMs($var)
{
GPBUtil::checkInt64($var);
$this->start_timestamp_ms = $var;
return $this;
} | start time of event based on a monotonic clock (in milliseconds)
Generated from protobuf field <code>int64 start_timestamp_ms = 4;</code>
@param int|string $var
@return $this | setStartTimestampMs | php | agence104/livekit-server-sdk-php | src/proto/Livekit/EventMetric.php | https://github.com/agence104/livekit-server-sdk-php/blob/master/src/proto/Livekit/EventMetric.php | Apache-2.0 |
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.