fork/rust-sdks

git clone https://git.julia.blue/fork/rust-sdks

zesun96Fix carah error of get session stats request (#490)15a5a7f

main
13.7 KiB461 linesraw
1// Copyright 2023 LiveKit, Inc.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15syntax = "proto2";
16
17package livekit.proto;
18option csharp_namespace = "LiveKit.Proto";
19
20
21enum DataChannelState {
22    DC_CONNECTING = 0;
23    DC_OPEN = 1;
24    DC_CLOSING = 2;
25    DC_CLOSED = 3;
26}
27
28enum QualityLimitationReason {
29    LIMITATION_NONE = 0;
30    LIMITATION_CPU = 1;
31    LIMITATION_BANDWIDTH = 2;
32    LIMITATION_OTHER = 3;
33}
34
35enum IceRole {
36    ICE_UNKNOWN = 0;
37    ICE_CONTROLLING = 1;
38    ICE_CONTROLLED = 2;
39}
40
41enum DtlsTransportState {
42    DTLS_TRANSPORT_NEW = 0;
43    DTLS_TRANSPORT_CONNECTING = 1;
44    DTLS_TRANSPORT_CONNECTED = 2;
45    DTLS_TRANSPORT_CLOSED = 3;
46    DTLS_TRANSPORT_FAILED = 4;
47}
48
49enum IceTransportState {
50    ICE_TRANSPORT_NEW = 0;
51    ICE_TRANSPORT_CHECKING = 1;
52    ICE_TRANSPORT_CONNECTED = 2;
53    ICE_TRANSPORT_COMPLETED = 3;
54    ICE_TRANSPORT_DISCONNECTED = 4;
55    ICE_TRANSPORT_FAILED = 5;
56    ICE_TRANSPORT_CLOSED = 6;
57}
58
59enum DtlsRole {
60    DTLS_CLIENT = 0;
61    DTLS_SERVER = 1;
62    DTLS_UNKNOWN = 2;
63}
64
65enum IceCandidatePairState {
66    PAIR_FROZEN = 0;
67    PAIR_WAITING = 1;
68    PAIR_IN_PROGRESS = 2;
69    PAIR_FAILED = 3;
70    PAIR_SUCCEEDED = 4;
71}
72
73enum IceCandidateType {
74    HOST = 0;
75    SRFLX = 1;
76    PRFLX = 2;
77    RELAY = 3;
78}
79
80enum IceServerTransportProtocol {
81    TRANSPORT_UDP = 0;
82    TRANSPORT_TCP = 1;
83    TRANSPORT_TLS = 2;
84}
85
86enum IceTcpCandidateType {
87    CANDIDATE_ACTIVE = 0;
88    CANDIDATE_PASSIVE = 1;
89    CANDIDATE_SO = 2;
90}
91
92message RtcStats {
93    message Codec {
94        required RtcStatsData rtc = 1;
95    	required CodecStats codec = 2;
96    }
97
98    message InboundRtp {
99        required RtcStatsData rtc = 1;
100        required RtpStreamStats stream = 2;
101        required ReceivedRtpStreamStats received = 3;
102        required InboundRtpStreamStats inbound = 4;
103    }
104
105    message OutboundRtp {
106        required RtcStatsData rtc = 1;
107        required RtpStreamStats stream = 2;
108        required SentRtpStreamStats sent = 3;
109        required OutboundRtpStreamStats outbound = 4;
110    }
111
112    message RemoteInboundRtp {
113        required RtcStatsData rtc = 1;
114        required RtpStreamStats stream = 2;
115        required ReceivedRtpStreamStats received = 3;
116        required RemoteInboundRtpStreamStats remote_inbound = 4;
117    }
118
119    message RemoteOutboundRtp {
120        required RtcStatsData rtc = 1;
121        required RtpStreamStats stream = 2;
122        required SentRtpStreamStats sent = 3;
123        required RemoteOutboundRtpStreamStats remote_outbound = 4;
124    }
125
126    message MediaSource {
127        required RtcStatsData rtc = 1;
128        required MediaSourceStats source = 2;
129        required AudioSourceStats audio = 3;
130        required VideoSourceStats video = 4;
131    }
132
133    message MediaPlayout {
134        required RtcStatsData rtc = 1;
135        required AudioPlayoutStats audio_playout = 2;
136    }
137
138    message PeerConnection {
139        required RtcStatsData rtc = 1;
140	    required PeerConnectionStats pc = 2;
141    }
142
143    message DataChannel {
144        required RtcStatsData rtc = 1;
145	    required DataChannelStats dc = 2;
146    }
147
148    message Transport {
149        required RtcStatsData rtc = 1;
150	    required TransportStats transport  = 2;
151    }
152
153    message CandidatePair {
154        required RtcStatsData rtc = 1;
155	    required CandidatePairStats candidate_pair = 2;
156    }
157
158    message LocalCandidate {
159        required RtcStatsData rtc = 1;
160	required IceCandidateStats candidate = 2;
161    }
162
163    message RemoteCandidate {
164        required RtcStatsData rtc = 1;
165	    required IceCandidateStats candidate = 2;
166    }
167
168    message Certificate {
169        required RtcStatsData rtc = 1;
170	    required CertificateStats certificate = 2;
171    }
172
173    message Stream {
174        required RtcStatsData rtc = 1;
175	    required StreamStats stream = 2;
176    }
177
178    message Track {
179	// Deprecated
180    }
181
182    oneof stats {
183	Codec codec = 3;
184	InboundRtp inbound_rtp = 4;
185	OutboundRtp outbound_rtp = 5;
186	RemoteInboundRtp remote_inbound_rtp = 6;
187	RemoteOutboundRtp remote_outbound_rtp = 7;
188	MediaSource media_source = 8;
189	MediaPlayout media_playout = 9;
190	PeerConnection peer_connection = 10;
191	DataChannel data_channel = 11;
192	Transport transport = 12;
193	CandidatePair candidate_pair = 13;
194	LocalCandidate local_candidate = 14;
195	RemoteCandidate remote_candidate = 15;
196	Certificate certificate = 16;
197    Stream stream = 17;
198	Track track = 18;
199    }
200}
201
202message RtcStatsData {
203    required string id = 1;
204    required int64 timestamp = 2;
205}
206
207message CodecStats {
208    required uint32 payload_type = 1;
209    required string transport_id = 2;
210    required string mime_type = 3;
211    required uint32 clock_rate = 4;
212    required uint32 channels = 5;
213    required string sdp_fmtp_line = 6;
214}
215
216message RtpStreamStats {
217    required uint32 ssrc = 1;
218    required string kind = 2;
219    required string transport_id = 3;
220    required string codec_id = 4;
221}
222
223message ReceivedRtpStreamStats {
224    required uint64 packets_received = 1;
225    required int64 packets_lost = 2;
226    required double jitter = 3;
227}
228
229message InboundRtpStreamStats {
230    required string track_identifier = 1;
231    required string mid = 2;
232    required string remote_id = 3;
233    required uint32 frames_decoded = 4;
234    required uint32 key_frames_decoded = 5;
235    required uint32 frames_rendered = 6;
236    required uint32 frames_dropped = 7;
237    required uint32 frame_width = 8;
238    required uint32 frame_height = 9;
239    required double frames_per_second = 10;
240    required uint64 qp_sum = 11;
241    required double total_decode_time = 12;
242    required double total_inter_frame_delay = 13;
243    required double total_squared_inter_frame_delay = 14;
244    required uint32 pause_count = 15;
245    required double total_pause_duration = 16;
246    required uint32 freeze_count = 17;
247    required double total_freeze_duration = 18;
248    required double last_packet_received_timestamp = 19;
249    required uint64 header_bytes_received = 20;
250    required uint64 packets_discarded = 21;
251    required  uint64 fec_bytes_received = 22;
252    required uint64 fec_packets_received = 23;
253    required uint64 fec_packets_discarded = 24;
254    required uint64 bytes_received = 25;
255    required uint32 nack_count = 26;
256    required uint32 fir_count = 27;
257    required uint32 pli_count = 28;
258    required double total_processing_delay = 29;
259    required double estimated_playout_timestamp = 30;
260    required double jitter_buffer_delay = 31;
261    required double jitter_buffer_target_delay = 32;
262    required uint64 jitter_buffer_emitted_count = 33;
263    required double jitter_buffer_minimum_delay = 34;
264    required uint64 total_samples_received = 35;
265    required uint64 concealed_samples = 36;
266    required uint64 silent_concealed_samples = 37;
267    required uint64 concealment_events = 38;
268    required uint64 inserted_samples_for_deceleration = 39;
269    required uint64 removed_samples_for_acceleration = 40;
270    required double audio_level = 41;
271    required double total_audio_energy = 42;
272    required double total_samples_duration = 43;
273    required uint64 frames_received = 44;
274    required string decoder_implementation = 45;
275    required string playout_id = 46;
276    required  bool power_efficient_decoder = 47;
277    required uint64 frames_assembled_from_multiple_packets = 48;
278    required double total_assembly_time = 49;
279    required uint64 retransmitted_packets_received = 50;
280    required  uint64 retransmitted_bytes_received = 51;
281    required uint32 rtx_ssrc = 52;
282    required uint32 fec_ssrc = 53;
283}
284
285message SentRtpStreamStats {
286    required uint64 packets_sent = 1;
287    required uint64 bytes_sent = 2;
288}
289
290message OutboundRtpStreamStats {
291    required string mid = 1;
292    required string media_source_id = 2;
293    required string remote_id = 3;
294    required string rid = 4;
295    required uint64 header_bytes_sent = 5;
296    required uint64 retransmitted_packets_sent = 6;
297    required uint64 retransmitted_bytes_sent = 7;
298    required uint32 rtx_ssrc = 8;
299    required double target_bitrate = 9;
300    required uint64 total_encoded_bytes_target = 10;
301    required uint32 frame_width = 11;
302    required uint32 frame_height = 12;
303    required double frames_per_second = 13;
304    required uint32 frames_sent = 14;
305    required uint32 huge_frames_sent = 15;
306    required uint32 frames_encoded = 16;
307    required uint32 key_frames_encoded = 17;
308    required uint64 qp_sum = 18;
309    required double total_encode_time = 19;
310    required double total_packet_send_delay = 20;
311    required QualityLimitationReason quality_limitation_reason = 21;
312    map<string, double> quality_limitation_durations = 22;
313    required uint32 quality_limitation_resolution_changes = 23;
314    required uint32 nack_count = 24;
315    required uint32 fir_count = 25;
316    required uint32 pli_count = 26;
317    required string encoder_implementation = 27;
318    required bool power_efficient_encoder = 28;
319    required bool active = 29;
320    required string scalability_mode = 30;
321}
322
323message RemoteInboundRtpStreamStats {
324    required string local_id = 1;
325    required double round_trip_time = 2;
326    required double total_round_trip_time = 3;
327    required double fraction_lost = 4;
328    required uint64 round_trip_time_measurements = 5;
329}
330
331message RemoteOutboundRtpStreamStats {
332    required string local_id = 1;
333    required double remote_timestamp = 2;
334    required uint64 reports_sent = 3;
335    required double round_trip_time = 4;
336    required double total_round_trip_time = 5;
337    required uint64 round_trip_time_measurements = 6;
338}
339
340message MediaSourceStats {
341    required string track_identifier = 1;
342    required string kind = 2;
343}
344
345message AudioSourceStats {
346    required double audio_level = 1;
347    required double total_audio_energy = 2;
348    required double total_samples_duration = 3;
349    required double echo_return_loss = 4;
350    required double echo_return_loss_enhancement = 5;
351    required double dropped_samples_duration = 6;
352    required uint32 dropped_samples_events = 7;
353    required double total_capture_delay = 8;
354    required uint64 total_samples_captured = 9;
355}
356
357message VideoSourceStats {
358    required uint32 width = 1;
359    required uint32 height = 2;
360    required uint32 frames = 3;
361    required double frames_per_second = 4;
362}
363
364message AudioPlayoutStats {
365    required string kind = 1;
366    required double synthesized_samples_duration = 2;
367    required uint32 synthesized_samples_events = 3;
368    required double total_samples_duration = 4;
369    required double total_playout_delay = 5;
370    required uint64 total_samples_count = 6;
371}
372
373message PeerConnectionStats {
374    required uint32 data_channels_opened = 1;
375    required uint32 data_channels_closed = 2;
376}
377
378message DataChannelStats {
379    required string label = 1;
380    required string protocol = 2;
381    required int32 data_channel_identifier = 3;
382    optional DataChannelState state = 4;
383    required uint32 messages_sent = 5;
384    required uint64 bytes_sent = 6;
385    required uint32 messages_received = 7;
386    required uint64 bytes_received = 8;
387}
388
389message TransportStats {
390    required uint64 packets_sent = 1;
391    required uint64 packets_received = 2;
392    required uint64 bytes_sent = 3;
393    required uint64 bytes_received = 4;
394    required IceRole ice_role = 5;
395    required string ice_local_username_fragment = 6;
396    optional DtlsTransportState dtls_state = 7;
397    optional IceTransportState ice_state = 8;
398    required string selected_candidate_pair_id = 9;
399    required string local_certificate_id = 10;
400    required string remote_certificate_id = 11;
401    required string tls_version = 12;
402    required string dtls_cipher = 13;
403    required DtlsRole dtls_role = 14;
404    required string srtp_cipher = 15;
405    required uint32 selected_candidate_pair_changes = 16;
406}
407
408message CandidatePairStats {
409    required string transport_id = 1;
410    required string local_candidate_id = 2;
411    required string remote_candidate_id = 3;
412    optional IceCandidatePairState state = 4;
413    required bool nominated = 5;
414    required uint64 packets_sent = 6;
415    required uint64 packets_received = 7;
416    required uint64 bytes_sent = 8;
417    required uint64 bytes_received = 9;
418    required double last_packet_sent_timestamp = 10;
419    required double last_packet_received_timestamp = 11;
420    required double total_round_trip_time = 12;
421    required double current_round_trip_time = 13;
422    required double available_outgoing_bitrate = 14;
423    required double available_incoming_bitrate = 15;
424    required uint64 requests_received = 16;
425    required uint64 requests_sent = 17;
426    required uint64 responses_received = 18;
427    required uint64 responses_sent = 19;
428    required uint64 consent_requests_sent = 20;
429    required uint32 packets_discarded_on_send = 21;
430    required uint64 bytes_discarded_on_send = 22;
431}
432
433message IceCandidateStats {
434    required string transport_id = 1;
435    required string address = 2;
436    required int32 port = 3;
437    required string protocol = 4;
438    optional IceCandidateType candidate_type = 5;
439    required int32 priority = 6;
440    required string url = 7;
441    optional IceServerTransportProtocol relay_protocol = 8;
442    required string foundation = 9;
443    required string related_address = 10;
444    required int32 related_port = 11;
445    required string username_fragment = 12;
446    optional IceTcpCandidateType tcp_type = 13;
447}
448
449message CertificateStats {
450    required string fingerprint = 1;
451    required string fingerprint_algorithm = 2;
452    required string base64_certificate = 3;
453    required string issuer_certificate_id = 4;
454}
455
456message StreamStats {
457    required string id = 1;
458    required string stream_identifier = 2;
459    // required int64 timestamp = 3;
460}
461