Documentation

SIPMediaConfig extends Message
in package

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

Table of Contents

Properties

$encryption  : mixed
Generated from protobuf field <code>optional .livekit.SIPMediaEncryption encryption = 3;</code>
$media_timeout  : mixed
Use specific media timeout. If zero or not specified, will use default timeout.
$only_listed_codecs  : mixed
if set, ignore the default codecs and use the list below.
$codecs  : mixed
List of allowed codecs. If only_listed_codecs is not set, this list is added to default codecs.

Methods

__construct()  : mixed
Constructor.
clearEncryption()  : mixed
clearMediaTimeout()  : mixed
getCodecs()  : RepeatedField<string|int, SIPCodec>
List of allowed codecs. If only_listed_codecs is not set, this list is added to default codecs.
getEncryption()  : int
Generated from protobuf field <code>optional .livekit.SIPMediaEncryption encryption = 3;</code>
getMediaTimeout()  : Duration|null
Use specific media timeout. If zero or not specified, will use default timeout.
getOnlyListedCodecs()  : bool
if set, ignore the default codecs and use the list below.
hasEncryption()  : mixed
hasMediaTimeout()  : mixed
setCodecs()  : $this
List of allowed codecs. If only_listed_codecs is not set, this list is added to default codecs.
setEncryption()  : $this
Generated from protobuf field <code>optional .livekit.SIPMediaEncryption encryption = 3;</code>
setMediaTimeout()  : $this
Use specific media timeout. If zero or not specified, will use default timeout.
setOnlyListedCodecs()  : $this
if set, ignore the default codecs and use the list below.

Properties

$encryption

Generated from protobuf field <code>optional .livekit.SIPMediaEncryption encryption = 3;</code>

protected mixed $encryption = null

$media_timeout

Use specific media timeout. If zero or not specified, will use default timeout.

protected mixed $media_timeout = null

Generated from protobuf field optional .google.protobuf.Duration media_timeout = 4;

$only_listed_codecs

if set, ignore the default codecs and use the list below.

protected mixed $only_listed_codecs = false

Generated from protobuf field bool only_listed_codecs = 1;

$codecs

List of allowed codecs. If only_listed_codecs is not set, this list is added to default codecs.

private mixed $codecs

Generated from protobuf field repeated .livekit.SIPCodec codecs = 2;

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 bool $only_listed_codecs
      if set, ignore the default codecs and use the list below.
@type \Livekit\SIPCodec[] $codecs
      List of allowed codecs. If only_listed_codecs is not set, this list is added to default codecs.
@type int $encryption
@type \Google\Protobuf\Duration $media_timeout
      Use specific media timeout. If zero or not specified, will use default timeout.

}

getCodecs()

List of allowed codecs. If only_listed_codecs is not set, this list is added to default codecs.

public getCodecs() : RepeatedField<string|int, SIPCodec>

Generated from protobuf field repeated .livekit.SIPCodec codecs = 2;

Return values
RepeatedField<string|int, SIPCodec>

getEncryption()

Generated from protobuf field <code>optional .livekit.SIPMediaEncryption encryption = 3;</code>

public getEncryption() : int
Return values
int

getMediaTimeout()

Use specific media timeout. If zero or not specified, will use default timeout.

public getMediaTimeout() : Duration|null

Generated from protobuf field optional .google.protobuf.Duration media_timeout = 4;

Return values
Duration|null

getOnlyListedCodecs()

if set, ignore the default codecs and use the list below.

public getOnlyListedCodecs() : bool

Generated from protobuf field bool only_listed_codecs = 1;

Return values
bool

setCodecs()

List of allowed codecs. If only_listed_codecs is not set, this list is added to default codecs.

public setCodecs(array<string|int, SIPCodec> $var) : $this

Generated from protobuf field repeated .livekit.SIPCodec codecs = 2;

Parameters
$var : array<string|int, SIPCodec>
Return values
$this

setEncryption()

Generated from protobuf field <code>optional .livekit.SIPMediaEncryption encryption = 3;</code>

public setEncryption(int $var) : $this
Parameters
$var : int
Return values
$this

setMediaTimeout()

Use specific media timeout. If zero or not specified, will use default timeout.

public setMediaTimeout(Duration $var) : $this

Generated from protobuf field optional .google.protobuf.Duration media_timeout = 4;

Parameters
$var : Duration
Return values
$this

setOnlyListedCodecs()

if set, ignore the default codecs and use the list below.

public setOnlyListedCodecs(bool $var) : $this

Generated from protobuf field bool only_listed_codecs = 1;

Parameters
$var : bool
Return values
$this
On this page

Search results