Documentation

FeatureUsageInfo extends Message
in package

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

Table of Contents

Properties

$feature  : mixed
Generated from protobuf field <code>.livekit.FeatureUsageInfo.Feature feature = 1;</code>
$participant_id  : mixed
Generated from protobuf field <code>string participant_id = 6;</code>
$participant_identity  : mixed
Generated from protobuf field <code>string participant_identity = 5;</code>
$project_id  : mixed
Generated from protobuf field <code>string project_id = 2;</code>
$room_id  : mixed
Generated from protobuf field <code>string room_id = 4;</code>
$room_name  : mixed
Generated from protobuf field <code>string room_name = 3;</code>
$track_id  : mixed
Generated from protobuf field <code>string track_id = 7;</code>
$time_ranges  : mixed
time ranges during which the feature was enabled.

Methods

__construct()  : mixed
Constructor.
getFeature()  : int
Generated from protobuf field <code>.livekit.FeatureUsageInfo.Feature feature = 1;</code>
getParticipantId()  : string
Generated from protobuf field <code>string participant_id = 6;</code>
getParticipantIdentity()  : string
Generated from protobuf field <code>string participant_identity = 5;</code>
getProjectId()  : string
Generated from protobuf field <code>string project_id = 2;</code>
getRoomId()  : string
Generated from protobuf field <code>string room_id = 4;</code>
getRoomName()  : string
Generated from protobuf field <code>string room_name = 3;</code>
getTimeRanges()  : RepeatedField<string|int, TimeRange>
time ranges during which the feature was enabled.
getTrackId()  : string
Generated from protobuf field <code>string track_id = 7;</code>
setFeature()  : $this
Generated from protobuf field <code>.livekit.FeatureUsageInfo.Feature feature = 1;</code>
setParticipantId()  : $this
Generated from protobuf field <code>string participant_id = 6;</code>
setParticipantIdentity()  : $this
Generated from protobuf field <code>string participant_identity = 5;</code>
setProjectId()  : $this
Generated from protobuf field <code>string project_id = 2;</code>
setRoomId()  : $this
Generated from protobuf field <code>string room_id = 4;</code>
setRoomName()  : $this
Generated from protobuf field <code>string room_name = 3;</code>
setTimeRanges()  : $this
time ranges during which the feature was enabled.
setTrackId()  : $this
Generated from protobuf field <code>string track_id = 7;</code>

Properties

$feature

Generated from protobuf field <code>.livekit.FeatureUsageInfo.Feature feature = 1;</code>

protected mixed $feature = 0

$participant_id

Generated from protobuf field <code>string participant_id = 6;</code>

protected mixed $participant_id = ''

$participant_identity

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

protected mixed $participant_identity = ''

$project_id

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

protected mixed $project_id = ''

$room_id

Generated from protobuf field <code>string room_id = 4;</code>

protected mixed $room_id = ''

$room_name

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

protected mixed $room_name = ''

$track_id

Generated from protobuf field <code>string track_id = 7;</code>

protected mixed $track_id = ''

$time_ranges

time ranges during which the feature was enabled.

private mixed $time_ranges

for e. g., noise cancellation may not be applied when a media track is paused/muted, this allows reporting only periods during which a feature is avtive.

Generated from protobuf field repeated .livekit.TimeRange time_ranges = 8;

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 int $feature
@type string $project_id
@type string $room_name
@type string $room_id
@type string $participant_identity
@type string $participant_id
@type string $track_id
@type \Livekit\TimeRange[] $time_ranges
      time ranges during which the feature was enabled.
      for e. g., noise cancellation may not be applied when a media track is paused/muted,
      this allows reporting only periods during which a feature is avtive.

}

getFeature()

Generated from protobuf field <code>.livekit.FeatureUsageInfo.Feature feature = 1;</code>

public getFeature() : int
Return values
int

getParticipantId()

Generated from protobuf field <code>string participant_id = 6;</code>

public getParticipantId() : string
Return values
string

getParticipantIdentity()

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

public getParticipantIdentity() : string
Return values
string

getProjectId()

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

public getProjectId() : string
Return values
string

getRoomId()

Generated from protobuf field <code>string room_id = 4;</code>

public getRoomId() : string
Return values
string

getRoomName()

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

public getRoomName() : string
Return values
string

getTimeRanges()

time ranges during which the feature was enabled.

public getTimeRanges() : RepeatedField<string|int, TimeRange>

for e. g., noise cancellation may not be applied when a media track is paused/muted, this allows reporting only periods during which a feature is avtive.

Generated from protobuf field repeated .livekit.TimeRange time_ranges = 8;

Return values
RepeatedField<string|int, TimeRange>

getTrackId()

Generated from protobuf field <code>string track_id = 7;</code>

public getTrackId() : string
Return values
string

setFeature()

Generated from protobuf field <code>.livekit.FeatureUsageInfo.Feature feature = 1;</code>

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

setParticipantId()

Generated from protobuf field <code>string participant_id = 6;</code>

public setParticipantId(string $var) : $this
Parameters
$var : string
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

setProjectId()

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

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

setRoomId()

Generated from protobuf field <code>string room_id = 4;</code>

public setRoomId(string $var) : $this
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

setTimeRanges()

time ranges during which the feature was enabled.

public setTimeRanges(array<string|int, TimeRange> $var) : $this

for e. g., noise cancellation may not be applied when a media track is paused/muted, this allows reporting only periods during which a feature is avtive.

Generated from protobuf field repeated .livekit.TimeRange time_ranges = 8;

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

setTrackId()

Generated from protobuf field <code>string track_id = 7;</code>

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results