Documentation

TurnCredentials extends Message
in package

Generated from protobuf message <code>plugnmeet.TurnCredentials</code>

Table of Contents

Properties

$fallback_on_flapping  : mixed
Generated from protobuf field <code>optional .plugnmeet.FallbackOnFlapping fallback_on_flapping = 7;</code>
$fallback_timer_duration  : mixed
The duration in Seconds to wait with a poor connection before triggering the fallback.
$fallback_turn  : mixed
Generated from protobuf field <code>bool fallback_turn = 5;</code>
$force_turn  : mixed
Generated from protobuf field <code>bool force_turn = 4;</code>
$password  : mixed
Generated from protobuf field <code>string password = 2;</code>
$username  : mixed
Generated from protobuf field <code>string username = 1;</code>
$uris  : mixed
Generated from protobuf field <code>repeated string uris = 3;</code>

Methods

__construct()  : mixed
Constructor.
clearFallbackOnFlapping()  : mixed
getFallbackOnFlapping()  : FallbackOnFlapping|null
Generated from protobuf field <code>optional .plugnmeet.FallbackOnFlapping fallback_on_flapping = 7;</code>
getFallbackTimerDuration()  : int|string
The duration in Seconds to wait with a poor connection before triggering the fallback.
getFallbackTurn()  : bool
Generated from protobuf field <code>bool fallback_turn = 5;</code>
getForceTurn()  : bool
Generated from protobuf field <code>bool force_turn = 4;</code>
getPassword()  : string
Generated from protobuf field <code>string password = 2;</code>
getUris()  : RepeatedField<string|int, string>
Generated from protobuf field <code>repeated string uris = 3;</code>
getUsername()  : string
Generated from protobuf field <code>string username = 1;</code>
hasFallbackOnFlapping()  : mixed
setFallbackOnFlapping()  : $this
Generated from protobuf field <code>optional .plugnmeet.FallbackOnFlapping fallback_on_flapping = 7;</code>
setFallbackTimerDuration()  : $this
The duration in Seconds to wait with a poor connection before triggering the fallback.
setFallbackTurn()  : $this
Generated from protobuf field <code>bool fallback_turn = 5;</code>
setForceTurn()  : $this
Generated from protobuf field <code>bool force_turn = 4;</code>
setPassword()  : $this
Generated from protobuf field <code>string password = 2;</code>
setUris()  : $this
Generated from protobuf field <code>repeated string uris = 3;</code>
setUsername()  : $this
Generated from protobuf field <code>string username = 1;</code>

Properties

$fallback_on_flapping

Generated from protobuf field <code>optional .plugnmeet.FallbackOnFlapping fallback_on_flapping = 7;</code>

protected mixed $fallback_on_flapping = null

$fallback_timer_duration

The duration in Seconds to wait with a poor connection before triggering the fallback.

protected mixed $fallback_timer_duration = 0

Generated from protobuf field int64 fallback_timer_duration = 6;

$fallback_turn

Generated from protobuf field <code>bool fallback_turn = 5;</code>

protected mixed $fallback_turn = false

$force_turn

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

protected mixed $force_turn = false

$password

Generated from protobuf field <code>string password = 2;</code>

protected mixed $password = ''

$username

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

protected mixed $username = ''

$uris

Generated from protobuf field <code>repeated string uris = 3;</code>

private mixed $uris

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 $username
@type string $password
@type string[] $uris
@type bool $force_turn
@type bool $fallback_turn
@type int|string $fallback_timer_duration
      The duration in Seconds to wait with a poor connection before triggering the fallback.
@type \Mynaparrot\PlugnmeetProto\FallbackOnFlapping $fallback_on_flapping

}

getFallbackTimerDuration()

The duration in Seconds to wait with a poor connection before triggering the fallback.

public getFallbackTimerDuration() : int|string

Generated from protobuf field int64 fallback_timer_duration = 6;

Return values
int|string

getFallbackTurn()

Generated from protobuf field <code>bool fallback_turn = 5;</code>

public getFallbackTurn() : bool
Return values
bool

getForceTurn()

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

public getForceTurn() : bool
Return values
bool

getPassword()

Generated from protobuf field <code>string password = 2;</code>

public getPassword() : string
Return values
string

getUris()

Generated from protobuf field <code>repeated string uris = 3;</code>

public getUris() : RepeatedField<string|int, string>
Return values
RepeatedField<string|int, string>

getUsername()

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

public getUsername() : string
Return values
string

setFallbackOnFlapping()

Generated from protobuf field <code>optional .plugnmeet.FallbackOnFlapping fallback_on_flapping = 7;</code>

public setFallbackOnFlapping(FallbackOnFlapping $var) : $this
Parameters
$var : FallbackOnFlapping
Return values
$this

setFallbackTimerDuration()

The duration in Seconds to wait with a poor connection before triggering the fallback.

public setFallbackTimerDuration(int|string $var) : $this

Generated from protobuf field int64 fallback_timer_duration = 6;

Parameters
$var : int|string
Return values
$this

setFallbackTurn()

Generated from protobuf field <code>bool fallback_turn = 5;</code>

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

setForceTurn()

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

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

setPassword()

Generated from protobuf field <code>string password = 2;</code>

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

setUris()

Generated from protobuf field <code>repeated string uris = 3;</code>

public setUris(array<string|int, string> $var) : $this
Parameters
$var : array<string|int, string>
Return values
$this

setUsername()

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

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

        
On this page

Search results