Documentation

SIPOutboundConfig extends Message
in package

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

Table of Contents

Properties

$auth_password  : mixed
Generated from protobuf field <code>string auth_password = 4 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
$auth_username  : mixed
Username and password used to authenticate with SIP server.
$destination_country  : mixed
country where the call terminates as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will be used by the livekit infrastructure to route calls.
$hostname  : mixed
SIP server address
$transport  : mixed
SIP Transport used for outbound call.
$attributes_to_headers  : mixed
Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
$headers_to_attributes  : mixed
Map SIP X-* headers from 200 OK to SIP participant attributes.

Methods

__construct()  : mixed
Constructor.
getAttributesToHeaders()  : MapField
Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
getAuthPassword()  : string
Generated from protobuf field <code>string auth_password = 4 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
getAuthUsername()  : string
Username and password used to authenticate with SIP server.
getDestinationCountry()  : string
country where the call terminates as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will be used by the livekit infrastructure to route calls.
getHeadersToAttributes()  : MapField
Map SIP X-* headers from 200 OK to SIP participant attributes.
getHostname()  : string
SIP server address
getTransport()  : int
SIP Transport used for outbound call.
setAttributesToHeaders()  : $this
Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
setAuthPassword()  : $this
Generated from protobuf field <code>string auth_password = 4 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
setAuthUsername()  : $this
Username and password used to authenticate with SIP server.
setDestinationCountry()  : $this
country where the call terminates as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will be used by the livekit infrastructure to route calls.
setHeadersToAttributes()  : $this
Map SIP X-* headers from 200 OK to SIP participant attributes.
setHostname()  : $this
SIP server address
setTransport()  : $this
SIP Transport used for outbound call.

Properties

$auth_password

Generated from protobuf field <code>string auth_password = 4 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>

protected mixed $auth_password = ''

$auth_username

Username and password used to authenticate with SIP server.

protected mixed $auth_username = ''

May be empty to have no authentication.

Generated from protobuf field string auth_username = 3 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

$destination_country

country where the call terminates as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will be used by the livekit infrastructure to route calls.

protected mixed $destination_country = ''

Generated from protobuf field string destination_country = 7;

$hostname

SIP server address

protected mixed $hostname = ''

Generated from protobuf field string hostname = 1;

$transport

SIP Transport used for outbound call.

protected mixed $transport = 0

Generated from protobuf field .livekit.SIPTransport transport = 2;

$attributes_to_headers

Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.

private mixed $attributes_to_headers

Keys are the names of attributes and values are the names of X-* headers they will be mapped to.

Generated from protobuf field map<string, string> attributes_to_headers = 6;

$headers_to_attributes

Map SIP X-* headers from 200 OK to SIP participant attributes.

private mixed $headers_to_attributes

Keys are the names of X-* headers and values are the names of attributes they will be mapped to.

Generated from protobuf field map<string, string> headers_to_attributes = 5;

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 $hostname
      SIP server address
@type string $destination_country
      country where the call terminates as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will be used by the livekit infrastructure to route calls.
@type int $transport
      SIP Transport used for outbound call.
@type string $auth_username
      Username and password used to authenticate with SIP server.
      May be empty to have no authentication.
@type string $auth_password
@type array|\Google\Protobuf\Internal\MapField $headers_to_attributes
      Map SIP X-* headers from 200 OK to SIP participant attributes.
      Keys are the names of X-* headers and values are the names of attributes they will be mapped to.
@type array|\Google\Protobuf\Internal\MapField $attributes_to_headers
      Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
      Keys are the names of attributes and values are the names of X-* headers they will be mapped to.

}

getAttributesToHeaders()

Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.

public getAttributesToHeaders() : MapField

Keys are the names of attributes and values are the names of X-* headers they will be mapped to.

Generated from protobuf field map<string, string> attributes_to_headers = 6;

Return values
MapField

getAuthPassword()

Generated from protobuf field <code>string auth_password = 4 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>

public getAuthPassword() : string
Return values
string

getAuthUsername()

Username and password used to authenticate with SIP server.

public getAuthUsername() : string

May be empty to have no authentication.

Generated from protobuf field string auth_username = 3 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Return values
string

getDestinationCountry()

country where the call terminates as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will be used by the livekit infrastructure to route calls.

public getDestinationCountry() : string

Generated from protobuf field string destination_country = 7;

Return values
string

getHeadersToAttributes()

Map SIP X-* headers from 200 OK to SIP participant attributes.

public getHeadersToAttributes() : MapField

Keys are the names of X-* headers and values are the names of attributes they will be mapped to.

Generated from protobuf field map<string, string> headers_to_attributes = 5;

Return values
MapField

getHostname()

SIP server address

public getHostname() : string

Generated from protobuf field string hostname = 1;

Return values
string

getTransport()

SIP Transport used for outbound call.

public getTransport() : int

Generated from protobuf field .livekit.SIPTransport transport = 2;

Return values
int

setAttributesToHeaders()

Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.

public setAttributesToHeaders(array<string|int, mixed>|MapField $var) : $this

Keys are the names of attributes and values are the names of X-* headers they will be mapped to.

Generated from protobuf field map<string, string> attributes_to_headers = 6;

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

setAuthPassword()

Generated from protobuf field <code>string auth_password = 4 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>

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

setAuthUsername()

Username and password used to authenticate with SIP server.

public setAuthUsername(string $var) : $this

May be empty to have no authentication.

Generated from protobuf field string auth_username = 3 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];

Parameters
$var : string
Return values
$this

setDestinationCountry()

country where the call terminates as ISO 3166-1 alpha-2 (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2). This will be used by the livekit infrastructure to route calls.

public setDestinationCountry(string $var) : $this

Generated from protobuf field string destination_country = 7;

Parameters
$var : string
Return values
$this

setHeadersToAttributes()

Map SIP X-* headers from 200 OK to SIP participant attributes.

public setHeadersToAttributes(array<string|int, mixed>|MapField $var) : $this

Keys are the names of X-* headers and values are the names of attributes they will be mapped to.

Generated from protobuf field map<string, string> headers_to_attributes = 5;

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

setHostname()

SIP server address

public setHostname(string $var) : $this

Generated from protobuf field string hostname = 1;

Parameters
$var : string
Return values
$this

setTransport()

SIP Transport used for outbound call.

public setTransport(int $var) : $this

Generated from protobuf field .livekit.SIPTransport transport = 2;

Parameters
$var : int
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results