Documentation

SIPCallInfo extends Message
in package

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

Table of Contents

Properties

$audio_codec  : mixed
Generated from protobuf field <code>string audio_codec = 20;</code>
$call_direction  : mixed
Generated from protobuf field <code>.livekit.SIPCallDirection call_direction = 15;</code>
$call_id  : mixed
Generated from protobuf field <code>string call_id = 1;</code>
$call_status  : mixed
Generated from protobuf field <code>.livekit.SIPCallStatus call_status = 8;</code>
$call_status_code  : mixed
Generated from protobuf field <code>.livekit.SIPStatus call_status_code = 19;</code>
$created_at  : mixed
Generated from protobuf field <code>int64 created_at = 9 [deprecated = true];</code>
$created_at_ns  : mixed
Generated from protobuf field <code>int64 created_at_ns = 22;</code>
$disconnect_reason  : mixed
Generated from protobuf field <code>.livekit.DisconnectReason disconnect_reason = 12;</code>
$dispatch_rule_id  : mixed
Generated from protobuf field <code>string dispatch_rule_id = 16;</code>
$ended_at  : mixed
Generated from protobuf field <code>int64 ended_at = 11 [deprecated = true];</code>
$ended_at_ns  : mixed
Generated from protobuf field <code>int64 ended_at_ns = 24;</code>
$error  : mixed
Generated from protobuf field <code>string error = 13;</code>
$from_uri  : mixed
Generated from protobuf field <code>.livekit.SIPUri from_uri = 6;</code>
$media_encryption  : mixed
Generated from protobuf field <code>string media_encryption = 21;</code>
$participant_identity  : mixed
Generated from protobuf field <code>string participant_identity = 5;</code>
$pcap_file_link  : mixed
Generated from protobuf field <code>string pcap_file_link = 25;</code>
$provider_info  : mixed
Generated from protobuf field <code>.livekit.ProviderInfo provider_info = 27;</code>
$region  : mixed
Generated from protobuf field <code>string region = 17;</code>
$room_id  : mixed
ID of the current/previous room published to
$room_name  : mixed
Generated from protobuf field <code>string room_name = 3;</code>
$started_at  : mixed
Generated from protobuf field <code>int64 started_at = 10 [deprecated = true];</code>
$started_at_ns  : mixed
Generated from protobuf field <code>int64 started_at_ns = 23;</code>
$to_uri  : mixed
Generated from protobuf field <code>.livekit.SIPUri to_uri = 7;</code>
$trunk_id  : mixed
Generated from protobuf field <code>string trunk_id = 2;</code>
$call_context  : mixed
Generated from protobuf field <code>repeated .google.protobuf.Any call_context = 26;</code>
$enabled_features  : mixed
Generated from protobuf field <code>repeated .livekit.SIPFeature enabled_features = 14;</code>
$participant_attributes  : mixed
Generated from protobuf field <code>map<string, string> participant_attributes = 18 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>

Methods

__construct()  : mixed
Constructor.
clearCallStatusCode()  : mixed
clearFromUri()  : mixed
clearProviderInfo()  : mixed
clearToUri()  : mixed
getAudioCodec()  : string
Generated from protobuf field <code>string audio_codec = 20;</code>
getCallContext()  : RepeatedField<string|int, Any>
Generated from protobuf field <code>repeated .google.protobuf.Any call_context = 26;</code>
getCallDirection()  : int
Generated from protobuf field <code>.livekit.SIPCallDirection call_direction = 15;</code>
getCallId()  : string
Generated from protobuf field <code>string call_id = 1;</code>
getCallStatus()  : int
Generated from protobuf field <code>.livekit.SIPCallStatus call_status = 8;</code>
getCallStatusCode()  : SIPStatus|null
Generated from protobuf field <code>.livekit.SIPStatus call_status_code = 19;</code>
getCreatedAt()  : int|string
Generated from protobuf field <code>int64 created_at = 9 [deprecated = true];</code>
getCreatedAtNs()  : int|string
Generated from protobuf field <code>int64 created_at_ns = 22;</code>
getDisconnectReason()  : int
Generated from protobuf field <code>.livekit.DisconnectReason disconnect_reason = 12;</code>
getDispatchRuleId()  : string
Generated from protobuf field <code>string dispatch_rule_id = 16;</code>
getEnabledFeatures()  : RepeatedField<string|int, int>
Generated from protobuf field <code>repeated .livekit.SIPFeature enabled_features = 14;</code>
getEndedAt()  : int|string
Generated from protobuf field <code>int64 ended_at = 11 [deprecated = true];</code>
getEndedAtNs()  : int|string
Generated from protobuf field <code>int64 ended_at_ns = 24;</code>
getError()  : string
Generated from protobuf field <code>string error = 13;</code>
getFromUri()  : SIPUri|null
Generated from protobuf field <code>.livekit.SIPUri from_uri = 6;</code>
getMediaEncryption()  : string
Generated from protobuf field <code>string media_encryption = 21;</code>
getParticipantAttributes()  : MapField
Generated from protobuf field <code>map<string, string> participant_attributes = 18 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
getParticipantIdentity()  : string
Generated from protobuf field <code>string participant_identity = 5;</code>
getPcapFileLink()  : string
Generated from protobuf field <code>string pcap_file_link = 25;</code>
getProviderInfo()  : ProviderInfo|null
Generated from protobuf field <code>.livekit.ProviderInfo provider_info = 27;</code>
getRegion()  : string
Generated from protobuf field <code>string region = 17;</code>
getRoomId()  : string
ID of the current/previous room published to
getRoomName()  : string
Generated from protobuf field <code>string room_name = 3;</code>
getStartedAt()  : int|string
Generated from protobuf field <code>int64 started_at = 10 [deprecated = true];</code>
getStartedAtNs()  : int|string
Generated from protobuf field <code>int64 started_at_ns = 23;</code>
getToUri()  : SIPUri|null
Generated from protobuf field <code>.livekit.SIPUri to_uri = 7;</code>
getTrunkId()  : string
Generated from protobuf field <code>string trunk_id = 2;</code>
hasCallStatusCode()  : mixed
hasFromUri()  : mixed
hasProviderInfo()  : mixed
hasToUri()  : mixed
setAudioCodec()  : $this
Generated from protobuf field <code>string audio_codec = 20;</code>
setCallContext()  : $this
Generated from protobuf field <code>repeated .google.protobuf.Any call_context = 26;</code>
setCallDirection()  : $this
Generated from protobuf field <code>.livekit.SIPCallDirection call_direction = 15;</code>
setCallId()  : $this
Generated from protobuf field <code>string call_id = 1;</code>
setCallStatus()  : $this
Generated from protobuf field <code>.livekit.SIPCallStatus call_status = 8;</code>
setCallStatusCode()  : $this
Generated from protobuf field <code>.livekit.SIPStatus call_status_code = 19;</code>
setCreatedAt()  : $this
Generated from protobuf field <code>int64 created_at = 9 [deprecated = true];</code>
setCreatedAtNs()  : $this
Generated from protobuf field <code>int64 created_at_ns = 22;</code>
setDisconnectReason()  : $this
Generated from protobuf field <code>.livekit.DisconnectReason disconnect_reason = 12;</code>
setDispatchRuleId()  : $this
Generated from protobuf field <code>string dispatch_rule_id = 16;</code>
setEnabledFeatures()  : $this
Generated from protobuf field <code>repeated .livekit.SIPFeature enabled_features = 14;</code>
setEndedAt()  : $this
Generated from protobuf field <code>int64 ended_at = 11 [deprecated = true];</code>
setEndedAtNs()  : $this
Generated from protobuf field <code>int64 ended_at_ns = 24;</code>
setError()  : $this
Generated from protobuf field <code>string error = 13;</code>
setFromUri()  : $this
Generated from protobuf field <code>.livekit.SIPUri from_uri = 6;</code>
setMediaEncryption()  : $this
Generated from protobuf field <code>string media_encryption = 21;</code>
setParticipantAttributes()  : $this
Generated from protobuf field <code>map<string, string> participant_attributes = 18 [(.logger.redact) = true, (.logger.redact_format) = "<redacted ({{ .Size }} bytes)>"];</code>
setParticipantIdentity()  : $this
Generated from protobuf field <code>string participant_identity = 5;</code>
setPcapFileLink()  : $this
Generated from protobuf field <code>string pcap_file_link = 25;</code>
setProviderInfo()  : $this
Generated from protobuf field <code>.livekit.ProviderInfo provider_info = 27;</code>
setRegion()  : $this
Generated from protobuf field <code>string region = 17;</code>
setRoomId()  : $this
ID of the current/previous room published to
setRoomName()  : $this
Generated from protobuf field <code>string room_name = 3;</code>
setStartedAt()  : $this
Generated from protobuf field <code>int64 started_at = 10 [deprecated = true];</code>
setStartedAtNs()  : $this
Generated from protobuf field <code>int64 started_at_ns = 23;</code>
setToUri()  : $this
Generated from protobuf field <code>.livekit.SIPUri to_uri = 7;</code>
setTrunkId()  : $this
Generated from protobuf field <code>string trunk_id = 2;</code>

Properties

$audio_codec

Generated from protobuf field <code>string audio_codec = 20;</code>

protected mixed $audio_codec = ''

$call_direction

Generated from protobuf field <code>.livekit.SIPCallDirection call_direction = 15;</code>

protected mixed $call_direction = 0

$call_id

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

protected mixed $call_id = ''

$call_status

Generated from protobuf field <code>.livekit.SIPCallStatus call_status = 8;</code>

protected mixed $call_status = 0

$call_status_code

Generated from protobuf field <code>.livekit.SIPStatus call_status_code = 19;</code>

protected mixed $call_status_code = null

$created_at

Generated from protobuf field <code>int64 created_at = 9 [deprecated = true];</code>

protected mixed $created_at = 0

$created_at_ns

Generated from protobuf field <code>int64 created_at_ns = 22;</code>

protected mixed $created_at_ns = 0

$disconnect_reason

Generated from protobuf field <code>.livekit.DisconnectReason disconnect_reason = 12;</code>

protected mixed $disconnect_reason = 0

$dispatch_rule_id

Generated from protobuf field <code>string dispatch_rule_id = 16;</code>

protected mixed $dispatch_rule_id = ''

$ended_at

Generated from protobuf field <code>int64 ended_at = 11 [deprecated = true];</code>

protected mixed $ended_at = 0

$ended_at_ns

Generated from protobuf field <code>int64 ended_at_ns = 24;</code>

protected mixed $ended_at_ns = 0

$error

Generated from protobuf field <code>string error = 13;</code>

protected mixed $error = ''

$from_uri

Generated from protobuf field <code>.livekit.SIPUri from_uri = 6;</code>

protected mixed $from_uri = null

$media_encryption

Generated from protobuf field <code>string media_encryption = 21;</code>

protected mixed $media_encryption = ''

$participant_identity

Generated from protobuf field <code>string participant_identity = 5;</code>

protected mixed $participant_identity = ''

$pcap_file_link

Generated from protobuf field <code>string pcap_file_link = 25;</code>

protected mixed $pcap_file_link = ''

$provider_info

Generated from protobuf field <code>.livekit.ProviderInfo provider_info = 27;</code>

protected mixed $provider_info = null

$region

Generated from protobuf field <code>string region = 17;</code>

protected mixed $region = ''

$room_id

ID of the current/previous room published to

protected mixed $room_id = ''

Generated from protobuf field string room_id = 4;

$room_name

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

protected mixed $room_name = ''

$started_at

Generated from protobuf field <code>int64 started_at = 10 [deprecated = true];</code>

protected mixed $started_at = 0

$started_at_ns

Generated from protobuf field <code>int64 started_at_ns = 23;</code>

protected mixed $started_at_ns = 0

$to_uri

Generated from protobuf field <code>.livekit.SIPUri to_uri = 7;</code>

protected mixed $to_uri = null

$trunk_id

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

protected mixed $trunk_id = ''

$call_context

Generated from protobuf field <code>repeated .google.protobuf.Any call_context = 26;</code>

private mixed $call_context

$enabled_features

Generated from protobuf field <code>repeated .livekit.SIPFeature enabled_features = 14;</code>

private mixed $enabled_features

$participant_attributes

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

private mixed $participant_attributes

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 $call_id
@type string $trunk_id
@type string $dispatch_rule_id
@type string $region
@type string $room_name
@type string $room_id
      ID of the current/previous room published to
@type string $participant_identity
@type array|\Google\Protobuf\Internal\MapField $participant_attributes
@type \Livekit\SIPUri $from_uri
@type \Livekit\SIPUri $to_uri
@type int|string $created_at
@type int|string $started_at
@type int|string $ended_at
@type int[] $enabled_features
@type int $call_direction
@type int $call_status
@type int|string $created_at_ns
@type int|string $started_at_ns
@type int|string $ended_at_ns
@type int $disconnect_reason
@type string $error
@type \Livekit\SIPStatus $call_status_code
@type string $audio_codec
@type string $media_encryption
@type string $pcap_file_link
@type \Google\Protobuf\Any[] $call_context
@type \Livekit\ProviderInfo $provider_info

}

clearCallStatusCode()

public clearCallStatusCode() : mixed

clearProviderInfo()

public clearProviderInfo() : mixed

getAudioCodec()

Generated from protobuf field <code>string audio_codec = 20;</code>

public getAudioCodec() : string
Return values
string

getCallContext()

Generated from protobuf field <code>repeated .google.protobuf.Any call_context = 26;</code>

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

getCallDirection()

Generated from protobuf field <code>.livekit.SIPCallDirection call_direction = 15;</code>

public getCallDirection() : int
Return values
int

getCallId()

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

public getCallId() : string
Return values
string

getCallStatus()

Generated from protobuf field <code>.livekit.SIPCallStatus call_status = 8;</code>

public getCallStatus() : int
Return values
int

getCallStatusCode()

Generated from protobuf field <code>.livekit.SIPStatus call_status_code = 19;</code>

public getCallStatusCode() : SIPStatus|null
Return values
SIPStatus|null

getCreatedAt()

Generated from protobuf field <code>int64 created_at = 9 [deprecated = true];</code>

public getCreatedAt() : int|string
Return values
int|string

getCreatedAtNs()

Generated from protobuf field <code>int64 created_at_ns = 22;</code>

public getCreatedAtNs() : int|string
Return values
int|string

getDisconnectReason()

Generated from protobuf field <code>.livekit.DisconnectReason disconnect_reason = 12;</code>

public getDisconnectReason() : int
Return values
int

getDispatchRuleId()

Generated from protobuf field <code>string dispatch_rule_id = 16;</code>

public getDispatchRuleId() : string
Return values
string

getEnabledFeatures()

Generated from protobuf field <code>repeated .livekit.SIPFeature enabled_features = 14;</code>

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

getEndedAt()

Generated from protobuf field <code>int64 ended_at = 11 [deprecated = true];</code>

public getEndedAt() : int|string
Return values
int|string

getEndedAtNs()

Generated from protobuf field <code>int64 ended_at_ns = 24;</code>

public getEndedAtNs() : int|string
Return values
int|string

getError()

Generated from protobuf field <code>string error = 13;</code>

public getError() : string
Return values
string

getFromUri()

Generated from protobuf field <code>.livekit.SIPUri from_uri = 6;</code>

public getFromUri() : SIPUri|null
Return values
SIPUri|null

getMediaEncryption()

Generated from protobuf field <code>string media_encryption = 21;</code>

public getMediaEncryption() : string
Return values
string

getParticipantAttributes()

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

public getParticipantAttributes() : MapField
Return values
MapField

getParticipantIdentity()

Generated from protobuf field <code>string participant_identity = 5;</code>

public getParticipantIdentity() : string
Return values
string

getPcapFileLink()

Generated from protobuf field <code>string pcap_file_link = 25;</code>

public getPcapFileLink() : string
Return values
string

getProviderInfo()

Generated from protobuf field <code>.livekit.ProviderInfo provider_info = 27;</code>

public getProviderInfo() : ProviderInfo|null
Return values
ProviderInfo|null

getRegion()

Generated from protobuf field <code>string region = 17;</code>

public getRegion() : string
Return values
string

getRoomId()

ID of the current/previous room published to

public getRoomId() : string

Generated from protobuf field string room_id = 4;

Return values
string

getRoomName()

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

public getRoomName() : string
Return values
string

getStartedAt()

Generated from protobuf field <code>int64 started_at = 10 [deprecated = true];</code>

public getStartedAt() : int|string
Return values
int|string

getStartedAtNs()

Generated from protobuf field <code>int64 started_at_ns = 23;</code>

public getStartedAtNs() : int|string
Return values
int|string

getToUri()

Generated from protobuf field <code>.livekit.SIPUri to_uri = 7;</code>

public getToUri() : SIPUri|null
Return values
SIPUri|null

getTrunkId()

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

public getTrunkId() : string
Return values
string

hasCallStatusCode()

public hasCallStatusCode() : mixed

setAudioCodec()

Generated from protobuf field <code>string audio_codec = 20;</code>

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

setCallContext()

Generated from protobuf field <code>repeated .google.protobuf.Any call_context = 26;</code>

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

setCallDirection()

Generated from protobuf field <code>.livekit.SIPCallDirection call_direction = 15;</code>

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

setCallId()

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

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

setCallStatus()

Generated from protobuf field <code>.livekit.SIPCallStatus call_status = 8;</code>

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

setCallStatusCode()

Generated from protobuf field <code>.livekit.SIPStatus call_status_code = 19;</code>

public setCallStatusCode(SIPStatus $var) : $this
Parameters
$var : SIPStatus
Return values
$this

setCreatedAt()

Generated from protobuf field <code>int64 created_at = 9 [deprecated = true];</code>

public setCreatedAt(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setCreatedAtNs()

Generated from protobuf field <code>int64 created_at_ns = 22;</code>

public setCreatedAtNs(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setDisconnectReason()

Generated from protobuf field <code>.livekit.DisconnectReason disconnect_reason = 12;</code>

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

setDispatchRuleId()

Generated from protobuf field <code>string dispatch_rule_id = 16;</code>

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

setEnabledFeatures()

Generated from protobuf field <code>repeated .livekit.SIPFeature enabled_features = 14;</code>

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

setEndedAt()

Generated from protobuf field <code>int64 ended_at = 11 [deprecated = true];</code>

public setEndedAt(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setEndedAtNs()

Generated from protobuf field <code>int64 ended_at_ns = 24;</code>

public setEndedAtNs(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setError()

Generated from protobuf field <code>string error = 13;</code>

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

setFromUri()

Generated from protobuf field <code>.livekit.SIPUri from_uri = 6;</code>

public setFromUri(SIPUri $var) : $this
Parameters
$var : SIPUri
Return values
$this

setMediaEncryption()

Generated from protobuf field <code>string media_encryption = 21;</code>

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

setParticipantAttributes()

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

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

setParticipantIdentity()

Generated from protobuf field <code>string participant_identity = 5;</code>

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

setPcapFileLink()

Generated from protobuf field <code>string pcap_file_link = 25;</code>

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

setProviderInfo()

Generated from protobuf field <code>.livekit.ProviderInfo provider_info = 27;</code>

public setProviderInfo(ProviderInfo $var) : $this
Parameters
$var : ProviderInfo
Return values
$this

setRegion()

Generated from protobuf field <code>string region = 17;</code>

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

setRoomId()

ID of the current/previous room published to

public setRoomId(string $var) : $this

Generated from protobuf field string room_id = 4;

Parameters
$var : string
Return values
$this

setRoomName()

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

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

setStartedAt()

Generated from protobuf field <code>int64 started_at = 10 [deprecated = true];</code>

public setStartedAt(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setStartedAtNs()

Generated from protobuf field <code>int64 started_at_ns = 23;</code>

public setStartedAtNs(int|string $var) : $this
Parameters
$var : int|string
Return values
$this

setToUri()

Generated from protobuf field <code>.livekit.SIPUri to_uri = 7;</code>

public setToUri(SIPUri $var) : $this
Parameters
$var : SIPUri
Return values
$this

setTrunkId()

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

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results