livekit 1.2.1__py3-none-win_arm64.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- livekit/rtc/__init__.py +264 -0
- livekit/rtc/_ffi_client.py +321 -0
- livekit/rtc/_proto/__init__.py +0 -0
- livekit/rtc/_proto/audio_frame_pb2.py +159 -0
- livekit/rtc/_proto/audio_frame_pb2.pyi +1560 -0
- livekit/rtc/_proto/capture_pb2.py +70 -0
- livekit/rtc/_proto/capture_pb2.pyi +559 -0
- livekit/rtc/_proto/data_stream_pb2.py +171 -0
- livekit/rtc/_proto/data_stream_pb2.pyi +1498 -0
- livekit/rtc/_proto/data_track_pb2.py +120 -0
- livekit/rtc/_proto/data_track_pb2.pyi +1073 -0
- livekit/rtc/_proto/e2ee_pb2.py +81 -0
- livekit/rtc/_proto/e2ee_pb2.pyi +591 -0
- livekit/rtc/_proto/ffi_pb2.py +55 -0
- livekit/rtc/_proto/ffi_pb2.pyi +1246 -0
- livekit/rtc/_proto/handle_pb2.py +27 -0
- livekit/rtc/_proto/handle_pb2.pyi +51 -0
- livekit/rtc/_proto/participant_pb2.py +45 -0
- livekit/rtc/_proto/participant_pb2.pyi +313 -0
- livekit/rtc/_proto/room_pb2.py +311 -0
- livekit/rtc/_proto/room_pb2.pyi +3136 -0
- livekit/rtc/_proto/rpc_pb2.py +47 -0
- livekit/rtc/_proto/rpc_pb2.pyi +261 -0
- livekit/rtc/_proto/stats_pb2.py +123 -0
- livekit/rtc/_proto/stats_pb2.pyi +1514 -0
- livekit/rtc/_proto/track_pb2.py +76 -0
- livekit/rtc/_proto/track_pb2.pyi +544 -0
- livekit/rtc/_proto/track_publication_pb2.py +39 -0
- livekit/rtc/_proto/track_publication_pb2.pyi +145 -0
- livekit/rtc/_proto/video_frame_pb2.py +97 -0
- livekit/rtc/_proto/video_frame_pb2.pyi +838 -0
- livekit/rtc/_utils.py +187 -0
- livekit/rtc/apm.py +119 -0
- livekit/rtc/audio_filter.py +23 -0
- livekit/rtc/audio_frame.py +242 -0
- livekit/rtc/audio_mixer.py +247 -0
- livekit/rtc/audio_resampler.py +174 -0
- livekit/rtc/audio_source.py +191 -0
- livekit/rtc/audio_stream.py +354 -0
- livekit/rtc/data_stream.py +640 -0
- livekit/rtc/data_track.py +296 -0
- livekit/rtc/e2ee.py +320 -0
- livekit/rtc/encoded_video.py +127 -0
- livekit/rtc/event_emitter.py +215 -0
- livekit/rtc/frame_processor.py +37 -0
- livekit/rtc/jupyter.py +68 -0
- livekit/rtc/log.py +3 -0
- livekit/rtc/media_devices.py +596 -0
- livekit/rtc/participant.py +1171 -0
- livekit/rtc/platform_audio.py +426 -0
- livekit/rtc/py.typed +0 -0
- livekit/rtc/resources/LICENSE.md +4055 -0
- livekit/rtc/resources/__init__.py +1 -0
- livekit/rtc/resources/jupyter-html/index.html +101 -0
- livekit/rtc/resources/livekit_ffi.dll +0 -0
- livekit/rtc/resources/livekit_ffi.h +42 -0
- livekit/rtc/room.py +1304 -0
- livekit/rtc/rpc.py +244 -0
- livekit/rtc/synchronizer.py +202 -0
- livekit/rtc/track.py +264 -0
- livekit/rtc/track_publication.py +145 -0
- livekit/rtc/transcription.py +19 -0
- livekit/rtc/utils.py +138 -0
- livekit/rtc/version.py +1 -0
- livekit/rtc/video_frame.py +347 -0
- livekit/rtc/video_source.py +74 -0
- livekit/rtc/video_stream.py +191 -0
- livekit-1.2.1.dist-info/METADATA +80 -0
- livekit-1.2.1.dist-info/RECORD +71 -0
- livekit-1.2.1.dist-info/WHEEL +5 -0
- livekit-1.2.1.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,1073 @@
|
|
|
1
|
+
"""
|
|
2
|
+
@generated by mypy-protobuf. Do not edit manually!
|
|
3
|
+
isort:skip_file
|
|
4
|
+
Copyright 2026 LiveKit, Inc.
|
|
5
|
+
|
|
6
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
7
|
+
you may not use this file except in compliance with the License.
|
|
8
|
+
You may obtain a copy of the License at
|
|
9
|
+
|
|
10
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
11
|
+
|
|
12
|
+
Unless required by applicable law or agreed to in writing, software
|
|
13
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
14
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
15
|
+
See the License for the specific language governing permissions and
|
|
16
|
+
limitations under the License.
|
|
17
|
+
"""
|
|
18
|
+
|
|
19
|
+
import builtins
|
|
20
|
+
import google.protobuf.descriptor
|
|
21
|
+
import google.protobuf.internal.enum_type_wrapper
|
|
22
|
+
import google.protobuf.message
|
|
23
|
+
from . import handle_pb2
|
|
24
|
+
import sys
|
|
25
|
+
import typing
|
|
26
|
+
|
|
27
|
+
if sys.version_info >= (3, 10):
|
|
28
|
+
import typing as typing_extensions
|
|
29
|
+
else:
|
|
30
|
+
import typing_extensions
|
|
31
|
+
|
|
32
|
+
DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
|
|
33
|
+
|
|
34
|
+
class _DataTrackErrorCode:
|
|
35
|
+
ValueType = typing.NewType("ValueType", builtins.int)
|
|
36
|
+
V: typing_extensions.TypeAlias = ValueType
|
|
37
|
+
|
|
38
|
+
class _DataTrackErrorCodeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_DataTrackErrorCode.ValueType], builtins.type):
|
|
39
|
+
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
40
|
+
DATA_TRACK_ERROR_CODE_UNKNOWN: _DataTrackErrorCode.ValueType # 0
|
|
41
|
+
DATA_TRACK_ERROR_CODE_INVALID_HANDLE: _DataTrackErrorCode.ValueType # 1
|
|
42
|
+
DATA_TRACK_ERROR_CODE_DUPLICATE_TRACK_NAME: _DataTrackErrorCode.ValueType # 2
|
|
43
|
+
DATA_TRACK_ERROR_CODE_TRACK_UNPUBLISHED: _DataTrackErrorCode.ValueType # 3
|
|
44
|
+
DATA_TRACK_ERROR_CODE_BUFFER_FULL: _DataTrackErrorCode.ValueType # 4
|
|
45
|
+
DATA_TRACK_ERROR_CODE_SUBSCRIPTION_CLOSED: _DataTrackErrorCode.ValueType # 5
|
|
46
|
+
DATA_TRACK_ERROR_CODE_CANCELLED: _DataTrackErrorCode.ValueType # 6
|
|
47
|
+
DATA_TRACK_ERROR_CODE_PROTOCOL_ERROR: _DataTrackErrorCode.ValueType # 7
|
|
48
|
+
DATA_TRACK_ERROR_CODE_INTERNAL: _DataTrackErrorCode.ValueType # 8
|
|
49
|
+
|
|
50
|
+
class DataTrackErrorCode(_DataTrackErrorCode, metaclass=_DataTrackErrorCodeEnumTypeWrapper): ...
|
|
51
|
+
|
|
52
|
+
DATA_TRACK_ERROR_CODE_UNKNOWN: DataTrackErrorCode.ValueType # 0
|
|
53
|
+
DATA_TRACK_ERROR_CODE_INVALID_HANDLE: DataTrackErrorCode.ValueType # 1
|
|
54
|
+
DATA_TRACK_ERROR_CODE_DUPLICATE_TRACK_NAME: DataTrackErrorCode.ValueType # 2
|
|
55
|
+
DATA_TRACK_ERROR_CODE_TRACK_UNPUBLISHED: DataTrackErrorCode.ValueType # 3
|
|
56
|
+
DATA_TRACK_ERROR_CODE_BUFFER_FULL: DataTrackErrorCode.ValueType # 4
|
|
57
|
+
DATA_TRACK_ERROR_CODE_SUBSCRIPTION_CLOSED: DataTrackErrorCode.ValueType # 5
|
|
58
|
+
DATA_TRACK_ERROR_CODE_CANCELLED: DataTrackErrorCode.ValueType # 6
|
|
59
|
+
DATA_TRACK_ERROR_CODE_PROTOCOL_ERROR: DataTrackErrorCode.ValueType # 7
|
|
60
|
+
DATA_TRACK_ERROR_CODE_INTERNAL: DataTrackErrorCode.ValueType # 8
|
|
61
|
+
global___DataTrackErrorCode = DataTrackErrorCode
|
|
62
|
+
|
|
63
|
+
class _PublishDataTrackErrorCode:
|
|
64
|
+
ValueType = typing.NewType("ValueType", builtins.int)
|
|
65
|
+
V: typing_extensions.TypeAlias = ValueType
|
|
66
|
+
|
|
67
|
+
class _PublishDataTrackErrorCodeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_PublishDataTrackErrorCode.ValueType], builtins.type):
|
|
68
|
+
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
69
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_UNKNOWN: _PublishDataTrackErrorCode.ValueType # 0
|
|
70
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_INVALID_HANDLE: _PublishDataTrackErrorCode.ValueType # 1
|
|
71
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_DUPLICATE_NAME: _PublishDataTrackErrorCode.ValueType # 2
|
|
72
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_TIMEOUT: _PublishDataTrackErrorCode.ValueType # 3
|
|
73
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_DISCONNECTED: _PublishDataTrackErrorCode.ValueType # 4
|
|
74
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_NOT_ALLOWED: _PublishDataTrackErrorCode.ValueType # 5
|
|
75
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_INVALID_NAME: _PublishDataTrackErrorCode.ValueType # 6
|
|
76
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_LIMIT_REACHED: _PublishDataTrackErrorCode.ValueType # 7
|
|
77
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_PROTOCOL_ERROR: _PublishDataTrackErrorCode.ValueType # 8
|
|
78
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_INTERNAL: _PublishDataTrackErrorCode.ValueType # 9
|
|
79
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_INVALID_SCHEMA: _PublishDataTrackErrorCode.ValueType # 10
|
|
80
|
+
|
|
81
|
+
class PublishDataTrackErrorCode(_PublishDataTrackErrorCode, metaclass=_PublishDataTrackErrorCodeEnumTypeWrapper): ...
|
|
82
|
+
|
|
83
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_UNKNOWN: PublishDataTrackErrorCode.ValueType # 0
|
|
84
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_INVALID_HANDLE: PublishDataTrackErrorCode.ValueType # 1
|
|
85
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_DUPLICATE_NAME: PublishDataTrackErrorCode.ValueType # 2
|
|
86
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_TIMEOUT: PublishDataTrackErrorCode.ValueType # 3
|
|
87
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_DISCONNECTED: PublishDataTrackErrorCode.ValueType # 4
|
|
88
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_NOT_ALLOWED: PublishDataTrackErrorCode.ValueType # 5
|
|
89
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_INVALID_NAME: PublishDataTrackErrorCode.ValueType # 6
|
|
90
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_LIMIT_REACHED: PublishDataTrackErrorCode.ValueType # 7
|
|
91
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_PROTOCOL_ERROR: PublishDataTrackErrorCode.ValueType # 8
|
|
92
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_INTERNAL: PublishDataTrackErrorCode.ValueType # 9
|
|
93
|
+
PUBLISH_DATA_TRACK_ERROR_CODE_INVALID_SCHEMA: PublishDataTrackErrorCode.ValueType # 10
|
|
94
|
+
global___PublishDataTrackErrorCode = PublishDataTrackErrorCode
|
|
95
|
+
|
|
96
|
+
class _LocalDataTrackTryPushErrorCode:
|
|
97
|
+
ValueType = typing.NewType("ValueType", builtins.int)
|
|
98
|
+
V: typing_extensions.TypeAlias = ValueType
|
|
99
|
+
|
|
100
|
+
class _LocalDataTrackTryPushErrorCodeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_LocalDataTrackTryPushErrorCode.ValueType], builtins.type):
|
|
101
|
+
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
102
|
+
LOCAL_DATA_TRACK_TRY_PUSH_ERROR_CODE_UNKNOWN: _LocalDataTrackTryPushErrorCode.ValueType # 0
|
|
103
|
+
LOCAL_DATA_TRACK_TRY_PUSH_ERROR_CODE_INVALID_HANDLE: _LocalDataTrackTryPushErrorCode.ValueType # 1
|
|
104
|
+
LOCAL_DATA_TRACK_TRY_PUSH_ERROR_CODE_TRACK_UNPUBLISHED: _LocalDataTrackTryPushErrorCode.ValueType # 2
|
|
105
|
+
LOCAL_DATA_TRACK_TRY_PUSH_ERROR_CODE_QUEUE_FULL: _LocalDataTrackTryPushErrorCode.ValueType # 3
|
|
106
|
+
LOCAL_DATA_TRACK_TRY_PUSH_ERROR_CODE_INTERNAL: _LocalDataTrackTryPushErrorCode.ValueType # 4
|
|
107
|
+
|
|
108
|
+
class LocalDataTrackTryPushErrorCode(_LocalDataTrackTryPushErrorCode, metaclass=_LocalDataTrackTryPushErrorCodeEnumTypeWrapper): ...
|
|
109
|
+
|
|
110
|
+
LOCAL_DATA_TRACK_TRY_PUSH_ERROR_CODE_UNKNOWN: LocalDataTrackTryPushErrorCode.ValueType # 0
|
|
111
|
+
LOCAL_DATA_TRACK_TRY_PUSH_ERROR_CODE_INVALID_HANDLE: LocalDataTrackTryPushErrorCode.ValueType # 1
|
|
112
|
+
LOCAL_DATA_TRACK_TRY_PUSH_ERROR_CODE_TRACK_UNPUBLISHED: LocalDataTrackTryPushErrorCode.ValueType # 2
|
|
113
|
+
LOCAL_DATA_TRACK_TRY_PUSH_ERROR_CODE_QUEUE_FULL: LocalDataTrackTryPushErrorCode.ValueType # 3
|
|
114
|
+
LOCAL_DATA_TRACK_TRY_PUSH_ERROR_CODE_INTERNAL: LocalDataTrackTryPushErrorCode.ValueType # 4
|
|
115
|
+
global___LocalDataTrackTryPushErrorCode = LocalDataTrackTryPushErrorCode
|
|
116
|
+
|
|
117
|
+
class _SubscribeDataTrackErrorCode:
|
|
118
|
+
ValueType = typing.NewType("ValueType", builtins.int)
|
|
119
|
+
V: typing_extensions.TypeAlias = ValueType
|
|
120
|
+
|
|
121
|
+
class _SubscribeDataTrackErrorCodeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_SubscribeDataTrackErrorCode.ValueType], builtins.type):
|
|
122
|
+
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
123
|
+
SUBSCRIBE_DATA_TRACK_ERROR_CODE_UNKNOWN: _SubscribeDataTrackErrorCode.ValueType # 0
|
|
124
|
+
SUBSCRIBE_DATA_TRACK_ERROR_CODE_INVALID_HANDLE: _SubscribeDataTrackErrorCode.ValueType # 1
|
|
125
|
+
SUBSCRIBE_DATA_TRACK_ERROR_CODE_UNPUBLISHED: _SubscribeDataTrackErrorCode.ValueType # 2
|
|
126
|
+
SUBSCRIBE_DATA_TRACK_ERROR_CODE_TIMEOUT: _SubscribeDataTrackErrorCode.ValueType # 3
|
|
127
|
+
SUBSCRIBE_DATA_TRACK_ERROR_CODE_DISCONNECTED: _SubscribeDataTrackErrorCode.ValueType # 4
|
|
128
|
+
SUBSCRIBE_DATA_TRACK_ERROR_CODE_PROTOCOL_ERROR: _SubscribeDataTrackErrorCode.ValueType # 5
|
|
129
|
+
SUBSCRIBE_DATA_TRACK_ERROR_CODE_INTERNAL: _SubscribeDataTrackErrorCode.ValueType # 6
|
|
130
|
+
|
|
131
|
+
class SubscribeDataTrackErrorCode(_SubscribeDataTrackErrorCode, metaclass=_SubscribeDataTrackErrorCodeEnumTypeWrapper): ...
|
|
132
|
+
|
|
133
|
+
SUBSCRIBE_DATA_TRACK_ERROR_CODE_UNKNOWN: SubscribeDataTrackErrorCode.ValueType # 0
|
|
134
|
+
SUBSCRIBE_DATA_TRACK_ERROR_CODE_INVALID_HANDLE: SubscribeDataTrackErrorCode.ValueType # 1
|
|
135
|
+
SUBSCRIBE_DATA_TRACK_ERROR_CODE_UNPUBLISHED: SubscribeDataTrackErrorCode.ValueType # 2
|
|
136
|
+
SUBSCRIBE_DATA_TRACK_ERROR_CODE_TIMEOUT: SubscribeDataTrackErrorCode.ValueType # 3
|
|
137
|
+
SUBSCRIBE_DATA_TRACK_ERROR_CODE_DISCONNECTED: SubscribeDataTrackErrorCode.ValueType # 4
|
|
138
|
+
SUBSCRIBE_DATA_TRACK_ERROR_CODE_PROTOCOL_ERROR: SubscribeDataTrackErrorCode.ValueType # 5
|
|
139
|
+
SUBSCRIBE_DATA_TRACK_ERROR_CODE_INTERNAL: SubscribeDataTrackErrorCode.ValueType # 6
|
|
140
|
+
global___SubscribeDataTrackErrorCode = SubscribeDataTrackErrorCode
|
|
141
|
+
|
|
142
|
+
@typing.final
|
|
143
|
+
class DataTrackInfo(google.protobuf.message.Message):
|
|
144
|
+
"""MARK: - Common
|
|
145
|
+
|
|
146
|
+
Information about a published data track.
|
|
147
|
+
"""
|
|
148
|
+
|
|
149
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
150
|
+
|
|
151
|
+
NAME_FIELD_NUMBER: builtins.int
|
|
152
|
+
SID_FIELD_NUMBER: builtins.int
|
|
153
|
+
USES_E2EE_FIELD_NUMBER: builtins.int
|
|
154
|
+
SCHEMA_FIELD_NUMBER: builtins.int
|
|
155
|
+
FRAME_ENCODING_FIELD_NUMBER: builtins.int
|
|
156
|
+
name: builtins.str
|
|
157
|
+
"""Name of the track assigned by the publisher."""
|
|
158
|
+
sid: builtins.str
|
|
159
|
+
"""SFU-assigned track identifier."""
|
|
160
|
+
uses_e2ee: builtins.bool
|
|
161
|
+
"""Whether or not frames sent on the track use end-to-end encryption."""
|
|
162
|
+
@property
|
|
163
|
+
def schema(self) -> global___DataTrackSchemaId:
|
|
164
|
+
"""Schema associated with frames sent on the track, if any."""
|
|
165
|
+
|
|
166
|
+
@property
|
|
167
|
+
def frame_encoding(self) -> global___DataTrackFrameEncoding:
|
|
168
|
+
"""Encoding of frames sent on the track, if specified."""
|
|
169
|
+
|
|
170
|
+
def __init__(
|
|
171
|
+
self,
|
|
172
|
+
*,
|
|
173
|
+
name: builtins.str | None = ...,
|
|
174
|
+
sid: builtins.str | None = ...,
|
|
175
|
+
uses_e2ee: builtins.bool | None = ...,
|
|
176
|
+
schema: global___DataTrackSchemaId | None = ...,
|
|
177
|
+
frame_encoding: global___DataTrackFrameEncoding | None = ...,
|
|
178
|
+
) -> None: ...
|
|
179
|
+
def HasField(self, field_name: typing.Literal["frame_encoding", b"frame_encoding", "name", b"name", "schema", b"schema", "sid", b"sid", "uses_e2ee", b"uses_e2ee"]) -> builtins.bool: ...
|
|
180
|
+
def ClearField(self, field_name: typing.Literal["frame_encoding", b"frame_encoding", "name", b"name", "schema", b"schema", "sid", b"sid", "uses_e2ee", b"uses_e2ee"]) -> None: ...
|
|
181
|
+
|
|
182
|
+
global___DataTrackInfo = DataTrackInfo
|
|
183
|
+
|
|
184
|
+
@typing.final
|
|
185
|
+
class DataTrackFrame(google.protobuf.message.Message):
|
|
186
|
+
"""A frame published on a data track."""
|
|
187
|
+
|
|
188
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
189
|
+
|
|
190
|
+
PAYLOAD_FIELD_NUMBER: builtins.int
|
|
191
|
+
USER_TIMESTAMP_FIELD_NUMBER: builtins.int
|
|
192
|
+
payload: builtins.bytes
|
|
193
|
+
user_timestamp: builtins.int
|
|
194
|
+
def __init__(
|
|
195
|
+
self,
|
|
196
|
+
*,
|
|
197
|
+
payload: builtins.bytes | None = ...,
|
|
198
|
+
user_timestamp: builtins.int | None = ...,
|
|
199
|
+
) -> None: ...
|
|
200
|
+
def HasField(self, field_name: typing.Literal["payload", b"payload", "user_timestamp", b"user_timestamp"]) -> builtins.bool: ...
|
|
201
|
+
def ClearField(self, field_name: typing.Literal["payload", b"payload", "user_timestamp", b"user_timestamp"]) -> None: ...
|
|
202
|
+
|
|
203
|
+
global___DataTrackFrame = DataTrackFrame
|
|
204
|
+
|
|
205
|
+
@typing.final
|
|
206
|
+
class DataTrackError(google.protobuf.message.Message):
|
|
207
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
208
|
+
|
|
209
|
+
CODE_FIELD_NUMBER: builtins.int
|
|
210
|
+
MESSAGE_FIELD_NUMBER: builtins.int
|
|
211
|
+
code: global___DataTrackErrorCode.ValueType
|
|
212
|
+
message: builtins.str
|
|
213
|
+
def __init__(
|
|
214
|
+
self,
|
|
215
|
+
*,
|
|
216
|
+
code: global___DataTrackErrorCode.ValueType | None = ...,
|
|
217
|
+
message: builtins.str | None = ...,
|
|
218
|
+
) -> None: ...
|
|
219
|
+
def HasField(self, field_name: typing.Literal["code", b"code", "message", b"message"]) -> builtins.bool: ...
|
|
220
|
+
def ClearField(self, field_name: typing.Literal["code", b"code", "message", b"message"]) -> None: ...
|
|
221
|
+
|
|
222
|
+
global___DataTrackError = DataTrackError
|
|
223
|
+
|
|
224
|
+
@typing.final
|
|
225
|
+
class PublishDataTrackError(google.protobuf.message.Message):
|
|
226
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
227
|
+
|
|
228
|
+
CODE_FIELD_NUMBER: builtins.int
|
|
229
|
+
MESSAGE_FIELD_NUMBER: builtins.int
|
|
230
|
+
code: global___PublishDataTrackErrorCode.ValueType
|
|
231
|
+
message: builtins.str
|
|
232
|
+
def __init__(
|
|
233
|
+
self,
|
|
234
|
+
*,
|
|
235
|
+
code: global___PublishDataTrackErrorCode.ValueType | None = ...,
|
|
236
|
+
message: builtins.str | None = ...,
|
|
237
|
+
) -> None: ...
|
|
238
|
+
def HasField(self, field_name: typing.Literal["code", b"code", "message", b"message"]) -> builtins.bool: ...
|
|
239
|
+
def ClearField(self, field_name: typing.Literal["code", b"code", "message", b"message"]) -> None: ...
|
|
240
|
+
|
|
241
|
+
global___PublishDataTrackError = PublishDataTrackError
|
|
242
|
+
|
|
243
|
+
@typing.final
|
|
244
|
+
class LocalDataTrackTryPushError(google.protobuf.message.Message):
|
|
245
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
246
|
+
|
|
247
|
+
CODE_FIELD_NUMBER: builtins.int
|
|
248
|
+
MESSAGE_FIELD_NUMBER: builtins.int
|
|
249
|
+
code: global___LocalDataTrackTryPushErrorCode.ValueType
|
|
250
|
+
message: builtins.str
|
|
251
|
+
def __init__(
|
|
252
|
+
self,
|
|
253
|
+
*,
|
|
254
|
+
code: global___LocalDataTrackTryPushErrorCode.ValueType | None = ...,
|
|
255
|
+
message: builtins.str | None = ...,
|
|
256
|
+
) -> None: ...
|
|
257
|
+
def HasField(self, field_name: typing.Literal["code", b"code", "message", b"message"]) -> builtins.bool: ...
|
|
258
|
+
def ClearField(self, field_name: typing.Literal["code", b"code", "message", b"message"]) -> None: ...
|
|
259
|
+
|
|
260
|
+
global___LocalDataTrackTryPushError = LocalDataTrackTryPushError
|
|
261
|
+
|
|
262
|
+
@typing.final
|
|
263
|
+
class SubscribeDataTrackError(google.protobuf.message.Message):
|
|
264
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
265
|
+
|
|
266
|
+
CODE_FIELD_NUMBER: builtins.int
|
|
267
|
+
MESSAGE_FIELD_NUMBER: builtins.int
|
|
268
|
+
code: global___SubscribeDataTrackErrorCode.ValueType
|
|
269
|
+
message: builtins.str
|
|
270
|
+
def __init__(
|
|
271
|
+
self,
|
|
272
|
+
*,
|
|
273
|
+
code: global___SubscribeDataTrackErrorCode.ValueType | None = ...,
|
|
274
|
+
message: builtins.str | None = ...,
|
|
275
|
+
) -> None: ...
|
|
276
|
+
def HasField(self, field_name: typing.Literal["code", b"code", "message", b"message"]) -> builtins.bool: ...
|
|
277
|
+
def ClearField(self, field_name: typing.Literal["code", b"code", "message", b"message"]) -> None: ...
|
|
278
|
+
|
|
279
|
+
global___SubscribeDataTrackError = SubscribeDataTrackError
|
|
280
|
+
|
|
281
|
+
@typing.final
|
|
282
|
+
class DataTrackOptions(google.protobuf.message.Message):
|
|
283
|
+
"""MARK: - Local
|
|
284
|
+
|
|
285
|
+
Options for publishing a data track.
|
|
286
|
+
"""
|
|
287
|
+
|
|
288
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
289
|
+
|
|
290
|
+
NAME_FIELD_NUMBER: builtins.int
|
|
291
|
+
SCHEMA_FIELD_NUMBER: builtins.int
|
|
292
|
+
FRAME_ENCODING_FIELD_NUMBER: builtins.int
|
|
293
|
+
name: builtins.str
|
|
294
|
+
"""Track name used to identify the track to other participants.
|
|
295
|
+
|
|
296
|
+
Must not be empty and must be unique per publisher.
|
|
297
|
+
"""
|
|
298
|
+
@property
|
|
299
|
+
def schema(self) -> global___DataTrackSchemaId:
|
|
300
|
+
"""Schema describing frames sent on the track."""
|
|
301
|
+
|
|
302
|
+
@property
|
|
303
|
+
def frame_encoding(self) -> global___DataTrackFrameEncoding:
|
|
304
|
+
"""Encoding of frames sent on the track."""
|
|
305
|
+
|
|
306
|
+
def __init__(
|
|
307
|
+
self,
|
|
308
|
+
*,
|
|
309
|
+
name: builtins.str | None = ...,
|
|
310
|
+
schema: global___DataTrackSchemaId | None = ...,
|
|
311
|
+
frame_encoding: global___DataTrackFrameEncoding | None = ...,
|
|
312
|
+
) -> None: ...
|
|
313
|
+
def HasField(self, field_name: typing.Literal["frame_encoding", b"frame_encoding", "name", b"name", "schema", b"schema"]) -> builtins.bool: ...
|
|
314
|
+
def ClearField(self, field_name: typing.Literal["frame_encoding", b"frame_encoding", "name", b"name", "schema", b"schema"]) -> None: ...
|
|
315
|
+
|
|
316
|
+
global___DataTrackOptions = DataTrackOptions
|
|
317
|
+
|
|
318
|
+
@typing.final
|
|
319
|
+
class PublishDataTrackRequest(google.protobuf.message.Message):
|
|
320
|
+
"""Publish a data track"""
|
|
321
|
+
|
|
322
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
323
|
+
|
|
324
|
+
LOCAL_PARTICIPANT_HANDLE_FIELD_NUMBER: builtins.int
|
|
325
|
+
OPTIONS_FIELD_NUMBER: builtins.int
|
|
326
|
+
REQUEST_ASYNC_ID_FIELD_NUMBER: builtins.int
|
|
327
|
+
local_participant_handle: builtins.int
|
|
328
|
+
request_async_id: builtins.int
|
|
329
|
+
@property
|
|
330
|
+
def options(self) -> global___DataTrackOptions: ...
|
|
331
|
+
def __init__(
|
|
332
|
+
self,
|
|
333
|
+
*,
|
|
334
|
+
local_participant_handle: builtins.int | None = ...,
|
|
335
|
+
options: global___DataTrackOptions | None = ...,
|
|
336
|
+
request_async_id: builtins.int | None = ...,
|
|
337
|
+
) -> None: ...
|
|
338
|
+
def HasField(self, field_name: typing.Literal["local_participant_handle", b"local_participant_handle", "options", b"options", "request_async_id", b"request_async_id"]) -> builtins.bool: ...
|
|
339
|
+
def ClearField(self, field_name: typing.Literal["local_participant_handle", b"local_participant_handle", "options", b"options", "request_async_id", b"request_async_id"]) -> None: ...
|
|
340
|
+
|
|
341
|
+
global___PublishDataTrackRequest = PublishDataTrackRequest
|
|
342
|
+
|
|
343
|
+
@typing.final
|
|
344
|
+
class PublishDataTrackResponse(google.protobuf.message.Message):
|
|
345
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
346
|
+
|
|
347
|
+
ASYNC_ID_FIELD_NUMBER: builtins.int
|
|
348
|
+
async_id: builtins.int
|
|
349
|
+
def __init__(
|
|
350
|
+
self,
|
|
351
|
+
*,
|
|
352
|
+
async_id: builtins.int | None = ...,
|
|
353
|
+
) -> None: ...
|
|
354
|
+
def HasField(self, field_name: typing.Literal["async_id", b"async_id"]) -> builtins.bool: ...
|
|
355
|
+
def ClearField(self, field_name: typing.Literal["async_id", b"async_id"]) -> None: ...
|
|
356
|
+
|
|
357
|
+
global___PublishDataTrackResponse = PublishDataTrackResponse
|
|
358
|
+
|
|
359
|
+
@typing.final
|
|
360
|
+
class PublishDataTrackCallback(google.protobuf.message.Message):
|
|
361
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
362
|
+
|
|
363
|
+
ASYNC_ID_FIELD_NUMBER: builtins.int
|
|
364
|
+
TRACK_FIELD_NUMBER: builtins.int
|
|
365
|
+
ERROR_FIELD_NUMBER: builtins.int
|
|
366
|
+
async_id: builtins.int
|
|
367
|
+
@property
|
|
368
|
+
def track(self) -> global___OwnedLocalDataTrack: ...
|
|
369
|
+
@property
|
|
370
|
+
def error(self) -> global___PublishDataTrackError: ...
|
|
371
|
+
def __init__(
|
|
372
|
+
self,
|
|
373
|
+
*,
|
|
374
|
+
async_id: builtins.int | None = ...,
|
|
375
|
+
track: global___OwnedLocalDataTrack | None = ...,
|
|
376
|
+
error: global___PublishDataTrackError | None = ...,
|
|
377
|
+
) -> None: ...
|
|
378
|
+
def HasField(self, field_name: typing.Literal["async_id", b"async_id", "error", b"error", "result", b"result", "track", b"track"]) -> builtins.bool: ...
|
|
379
|
+
def ClearField(self, field_name: typing.Literal["async_id", b"async_id", "error", b"error", "result", b"result", "track", b"track"]) -> None: ...
|
|
380
|
+
def WhichOneof(self, oneof_group: typing.Literal["result", b"result"]) -> typing.Literal["track", "error"] | None: ...
|
|
381
|
+
|
|
382
|
+
global___PublishDataTrackCallback = PublishDataTrackCallback
|
|
383
|
+
|
|
384
|
+
@typing.final
|
|
385
|
+
class OwnedLocalDataTrack(google.protobuf.message.Message):
|
|
386
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
387
|
+
|
|
388
|
+
HANDLE_FIELD_NUMBER: builtins.int
|
|
389
|
+
INFO_FIELD_NUMBER: builtins.int
|
|
390
|
+
@property
|
|
391
|
+
def handle(self) -> handle_pb2.FfiOwnedHandle: ...
|
|
392
|
+
@property
|
|
393
|
+
def info(self) -> global___DataTrackInfo: ...
|
|
394
|
+
def __init__(
|
|
395
|
+
self,
|
|
396
|
+
*,
|
|
397
|
+
handle: handle_pb2.FfiOwnedHandle | None = ...,
|
|
398
|
+
info: global___DataTrackInfo | None = ...,
|
|
399
|
+
) -> None: ...
|
|
400
|
+
def HasField(self, field_name: typing.Literal["handle", b"handle", "info", b"info"]) -> builtins.bool: ...
|
|
401
|
+
def ClearField(self, field_name: typing.Literal["handle", b"handle", "info", b"info"]) -> None: ...
|
|
402
|
+
|
|
403
|
+
global___OwnedLocalDataTrack = OwnedLocalDataTrack
|
|
404
|
+
|
|
405
|
+
@typing.final
|
|
406
|
+
class LocalDataTrackTryPushRequest(google.protobuf.message.Message):
|
|
407
|
+
"""Try pushing a frame to subscribers of the track."""
|
|
408
|
+
|
|
409
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
410
|
+
|
|
411
|
+
TRACK_HANDLE_FIELD_NUMBER: builtins.int
|
|
412
|
+
FRAME_FIELD_NUMBER: builtins.int
|
|
413
|
+
track_handle: builtins.int
|
|
414
|
+
@property
|
|
415
|
+
def frame(self) -> global___DataTrackFrame: ...
|
|
416
|
+
def __init__(
|
|
417
|
+
self,
|
|
418
|
+
*,
|
|
419
|
+
track_handle: builtins.int | None = ...,
|
|
420
|
+
frame: global___DataTrackFrame | None = ...,
|
|
421
|
+
) -> None: ...
|
|
422
|
+
def HasField(self, field_name: typing.Literal["frame", b"frame", "track_handle", b"track_handle"]) -> builtins.bool: ...
|
|
423
|
+
def ClearField(self, field_name: typing.Literal["frame", b"frame", "track_handle", b"track_handle"]) -> None: ...
|
|
424
|
+
|
|
425
|
+
global___LocalDataTrackTryPushRequest = LocalDataTrackTryPushRequest
|
|
426
|
+
|
|
427
|
+
@typing.final
|
|
428
|
+
class LocalDataTrackTryPushResponse(google.protobuf.message.Message):
|
|
429
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
430
|
+
|
|
431
|
+
ERROR_FIELD_NUMBER: builtins.int
|
|
432
|
+
@property
|
|
433
|
+
def error(self) -> global___LocalDataTrackTryPushError: ...
|
|
434
|
+
def __init__(
|
|
435
|
+
self,
|
|
436
|
+
*,
|
|
437
|
+
error: global___LocalDataTrackTryPushError | None = ...,
|
|
438
|
+
) -> None: ...
|
|
439
|
+
def HasField(self, field_name: typing.Literal["error", b"error"]) -> builtins.bool: ...
|
|
440
|
+
def ClearField(self, field_name: typing.Literal["error", b"error"]) -> None: ...
|
|
441
|
+
|
|
442
|
+
global___LocalDataTrackTryPushResponse = LocalDataTrackTryPushResponse
|
|
443
|
+
|
|
444
|
+
@typing.final
|
|
445
|
+
class LocalDataTrackIsPublishedRequest(google.protobuf.message.Message):
|
|
446
|
+
"""Checks if the track is still published."""
|
|
447
|
+
|
|
448
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
449
|
+
|
|
450
|
+
TRACK_HANDLE_FIELD_NUMBER: builtins.int
|
|
451
|
+
track_handle: builtins.int
|
|
452
|
+
def __init__(
|
|
453
|
+
self,
|
|
454
|
+
*,
|
|
455
|
+
track_handle: builtins.int | None = ...,
|
|
456
|
+
) -> None: ...
|
|
457
|
+
def HasField(self, field_name: typing.Literal["track_handle", b"track_handle"]) -> builtins.bool: ...
|
|
458
|
+
def ClearField(self, field_name: typing.Literal["track_handle", b"track_handle"]) -> None: ...
|
|
459
|
+
|
|
460
|
+
global___LocalDataTrackIsPublishedRequest = LocalDataTrackIsPublishedRequest
|
|
461
|
+
|
|
462
|
+
@typing.final
|
|
463
|
+
class LocalDataTrackIsPublishedResponse(google.protobuf.message.Message):
|
|
464
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
465
|
+
|
|
466
|
+
IS_PUBLISHED_FIELD_NUMBER: builtins.int
|
|
467
|
+
is_published: builtins.bool
|
|
468
|
+
def __init__(
|
|
469
|
+
self,
|
|
470
|
+
*,
|
|
471
|
+
is_published: builtins.bool | None = ...,
|
|
472
|
+
) -> None: ...
|
|
473
|
+
def HasField(self, field_name: typing.Literal["is_published", b"is_published"]) -> builtins.bool: ...
|
|
474
|
+
def ClearField(self, field_name: typing.Literal["is_published", b"is_published"]) -> None: ...
|
|
475
|
+
|
|
476
|
+
global___LocalDataTrackIsPublishedResponse = LocalDataTrackIsPublishedResponse
|
|
477
|
+
|
|
478
|
+
@typing.final
|
|
479
|
+
class LocalDataTrackUnpublishRequest(google.protobuf.message.Message):
|
|
480
|
+
"""Unpublishes the track."""
|
|
481
|
+
|
|
482
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
483
|
+
|
|
484
|
+
TRACK_HANDLE_FIELD_NUMBER: builtins.int
|
|
485
|
+
track_handle: builtins.int
|
|
486
|
+
def __init__(
|
|
487
|
+
self,
|
|
488
|
+
*,
|
|
489
|
+
track_handle: builtins.int | None = ...,
|
|
490
|
+
) -> None: ...
|
|
491
|
+
def HasField(self, field_name: typing.Literal["track_handle", b"track_handle"]) -> builtins.bool: ...
|
|
492
|
+
def ClearField(self, field_name: typing.Literal["track_handle", b"track_handle"]) -> None: ...
|
|
493
|
+
|
|
494
|
+
global___LocalDataTrackUnpublishRequest = LocalDataTrackUnpublishRequest
|
|
495
|
+
|
|
496
|
+
@typing.final
|
|
497
|
+
class LocalDataTrackUnpublishResponse(google.protobuf.message.Message):
|
|
498
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
499
|
+
|
|
500
|
+
def __init__(
|
|
501
|
+
self,
|
|
502
|
+
) -> None: ...
|
|
503
|
+
|
|
504
|
+
global___LocalDataTrackUnpublishResponse = LocalDataTrackUnpublishResponse
|
|
505
|
+
|
|
506
|
+
@typing.final
|
|
507
|
+
class OwnedRemoteDataTrack(google.protobuf.message.Message):
|
|
508
|
+
"""MARK: - Remote"""
|
|
509
|
+
|
|
510
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
511
|
+
|
|
512
|
+
HANDLE_FIELD_NUMBER: builtins.int
|
|
513
|
+
INFO_FIELD_NUMBER: builtins.int
|
|
514
|
+
PUBLISHER_IDENTITY_FIELD_NUMBER: builtins.int
|
|
515
|
+
publisher_identity: builtins.str
|
|
516
|
+
"""Identity of the remote participant who published the track."""
|
|
517
|
+
@property
|
|
518
|
+
def handle(self) -> handle_pb2.FfiOwnedHandle: ...
|
|
519
|
+
@property
|
|
520
|
+
def info(self) -> global___DataTrackInfo: ...
|
|
521
|
+
def __init__(
|
|
522
|
+
self,
|
|
523
|
+
*,
|
|
524
|
+
handle: handle_pb2.FfiOwnedHandle | None = ...,
|
|
525
|
+
info: global___DataTrackInfo | None = ...,
|
|
526
|
+
publisher_identity: builtins.str | None = ...,
|
|
527
|
+
) -> None: ...
|
|
528
|
+
def HasField(self, field_name: typing.Literal["handle", b"handle", "info", b"info", "publisher_identity", b"publisher_identity"]) -> builtins.bool: ...
|
|
529
|
+
def ClearField(self, field_name: typing.Literal["handle", b"handle", "info", b"info", "publisher_identity", b"publisher_identity"]) -> None: ...
|
|
530
|
+
|
|
531
|
+
global___OwnedRemoteDataTrack = OwnedRemoteDataTrack
|
|
532
|
+
|
|
533
|
+
@typing.final
|
|
534
|
+
class OwnedDataTrackStream(google.protobuf.message.Message):
|
|
535
|
+
"""Handle to an active data track subscription.
|
|
536
|
+
|
|
537
|
+
Dropping the handle will unsubscribe from the track.
|
|
538
|
+
"""
|
|
539
|
+
|
|
540
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
541
|
+
|
|
542
|
+
HANDLE_FIELD_NUMBER: builtins.int
|
|
543
|
+
@property
|
|
544
|
+
def handle(self) -> handle_pb2.FfiOwnedHandle: ...
|
|
545
|
+
def __init__(
|
|
546
|
+
self,
|
|
547
|
+
*,
|
|
548
|
+
handle: handle_pb2.FfiOwnedHandle | None = ...,
|
|
549
|
+
) -> None: ...
|
|
550
|
+
def HasField(self, field_name: typing.Literal["handle", b"handle"]) -> builtins.bool: ...
|
|
551
|
+
def ClearField(self, field_name: typing.Literal["handle", b"handle"]) -> None: ...
|
|
552
|
+
|
|
553
|
+
global___OwnedDataTrackStream = OwnedDataTrackStream
|
|
554
|
+
|
|
555
|
+
@typing.final
|
|
556
|
+
class DataTrackSubscribeOptions(google.protobuf.message.Message):
|
|
557
|
+
"""Reserved for future subscription options."""
|
|
558
|
+
|
|
559
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
560
|
+
|
|
561
|
+
BUFFER_SIZE_FIELD_NUMBER: builtins.int
|
|
562
|
+
buffer_size: builtins.int
|
|
563
|
+
"""Maximum number of frames to buffer internally."""
|
|
564
|
+
def __init__(
|
|
565
|
+
self,
|
|
566
|
+
*,
|
|
567
|
+
buffer_size: builtins.int | None = ...,
|
|
568
|
+
) -> None: ...
|
|
569
|
+
def HasField(self, field_name: typing.Literal["buffer_size", b"buffer_size"]) -> builtins.bool: ...
|
|
570
|
+
def ClearField(self, field_name: typing.Literal["buffer_size", b"buffer_size"]) -> None: ...
|
|
571
|
+
|
|
572
|
+
global___DataTrackSubscribeOptions = DataTrackSubscribeOptions
|
|
573
|
+
|
|
574
|
+
@typing.final
|
|
575
|
+
class RemoteDataTrackIsPublishedRequest(google.protobuf.message.Message):
|
|
576
|
+
"""Checks if the track is still published."""
|
|
577
|
+
|
|
578
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
579
|
+
|
|
580
|
+
TRACK_HANDLE_FIELD_NUMBER: builtins.int
|
|
581
|
+
track_handle: builtins.int
|
|
582
|
+
def __init__(
|
|
583
|
+
self,
|
|
584
|
+
*,
|
|
585
|
+
track_handle: builtins.int | None = ...,
|
|
586
|
+
) -> None: ...
|
|
587
|
+
def HasField(self, field_name: typing.Literal["track_handle", b"track_handle"]) -> builtins.bool: ...
|
|
588
|
+
def ClearField(self, field_name: typing.Literal["track_handle", b"track_handle"]) -> None: ...
|
|
589
|
+
|
|
590
|
+
global___RemoteDataTrackIsPublishedRequest = RemoteDataTrackIsPublishedRequest
|
|
591
|
+
|
|
592
|
+
@typing.final
|
|
593
|
+
class RemoteDataTrackIsPublishedResponse(google.protobuf.message.Message):
|
|
594
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
595
|
+
|
|
596
|
+
IS_PUBLISHED_FIELD_NUMBER: builtins.int
|
|
597
|
+
is_published: builtins.bool
|
|
598
|
+
def __init__(
|
|
599
|
+
self,
|
|
600
|
+
*,
|
|
601
|
+
is_published: builtins.bool | None = ...,
|
|
602
|
+
) -> None: ...
|
|
603
|
+
def HasField(self, field_name: typing.Literal["is_published", b"is_published"]) -> builtins.bool: ...
|
|
604
|
+
def ClearField(self, field_name: typing.Literal["is_published", b"is_published"]) -> None: ...
|
|
605
|
+
|
|
606
|
+
global___RemoteDataTrackIsPublishedResponse = RemoteDataTrackIsPublishedResponse
|
|
607
|
+
|
|
608
|
+
@typing.final
|
|
609
|
+
class RemoteDataTrackPipelineOptions(google.protobuf.message.Message):
|
|
610
|
+
"""Track-level options that configure how the incoming-frame pipeline reassembles packets for a remote data track."""
|
|
611
|
+
|
|
612
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
613
|
+
|
|
614
|
+
MAX_PARTIAL_FRAMES_FIELD_NUMBER: builtins.int
|
|
615
|
+
max_partial_frames: builtins.int
|
|
616
|
+
"""Maximum number of partial frames the depacketizer will track concurrently for this track.
|
|
617
|
+
|
|
618
|
+
Zero is not a valid value; if a value of zero is provided, it will be clamped to one.
|
|
619
|
+
"""
|
|
620
|
+
def __init__(
|
|
621
|
+
self,
|
|
622
|
+
*,
|
|
623
|
+
max_partial_frames: builtins.int | None = ...,
|
|
624
|
+
) -> None: ...
|
|
625
|
+
def HasField(self, field_name: typing.Literal["max_partial_frames", b"max_partial_frames"]) -> builtins.bool: ...
|
|
626
|
+
def ClearField(self, field_name: typing.Literal["max_partial_frames", b"max_partial_frames"]) -> None: ...
|
|
627
|
+
|
|
628
|
+
global___RemoteDataTrackPipelineOptions = RemoteDataTrackPipelineOptions
|
|
629
|
+
|
|
630
|
+
@typing.final
|
|
631
|
+
class RemoteDataTrackSetPipelineOptionsRequest(google.protobuf.message.Message):
|
|
632
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
633
|
+
|
|
634
|
+
TRACK_HANDLE_FIELD_NUMBER: builtins.int
|
|
635
|
+
OPTIONS_FIELD_NUMBER: builtins.int
|
|
636
|
+
track_handle: builtins.int
|
|
637
|
+
@property
|
|
638
|
+
def options(self) -> global___RemoteDataTrackPipelineOptions: ...
|
|
639
|
+
def __init__(
|
|
640
|
+
self,
|
|
641
|
+
*,
|
|
642
|
+
track_handle: builtins.int | None = ...,
|
|
643
|
+
options: global___RemoteDataTrackPipelineOptions | None = ...,
|
|
644
|
+
) -> None: ...
|
|
645
|
+
def HasField(self, field_name: typing.Literal["options", b"options", "track_handle", b"track_handle"]) -> builtins.bool: ...
|
|
646
|
+
def ClearField(self, field_name: typing.Literal["options", b"options", "track_handle", b"track_handle"]) -> None: ...
|
|
647
|
+
|
|
648
|
+
global___RemoteDataTrackSetPipelineOptionsRequest = RemoteDataTrackSetPipelineOptionsRequest
|
|
649
|
+
|
|
650
|
+
@typing.final
|
|
651
|
+
class RemoteDataTrackSetPipelineOptionsResponse(google.protobuf.message.Message):
|
|
652
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
653
|
+
|
|
654
|
+
def __init__(
|
|
655
|
+
self,
|
|
656
|
+
) -> None: ...
|
|
657
|
+
|
|
658
|
+
global___RemoteDataTrackSetPipelineOptionsResponse = RemoteDataTrackSetPipelineOptionsResponse
|
|
659
|
+
|
|
660
|
+
@typing.final
|
|
661
|
+
class SubscribeDataTrackRequest(google.protobuf.message.Message):
|
|
662
|
+
"""Subscribe to a data track."""
|
|
663
|
+
|
|
664
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
665
|
+
|
|
666
|
+
TRACK_HANDLE_FIELD_NUMBER: builtins.int
|
|
667
|
+
OPTIONS_FIELD_NUMBER: builtins.int
|
|
668
|
+
track_handle: builtins.int
|
|
669
|
+
@property
|
|
670
|
+
def options(self) -> global___DataTrackSubscribeOptions: ...
|
|
671
|
+
def __init__(
|
|
672
|
+
self,
|
|
673
|
+
*,
|
|
674
|
+
track_handle: builtins.int | None = ...,
|
|
675
|
+
options: global___DataTrackSubscribeOptions | None = ...,
|
|
676
|
+
) -> None: ...
|
|
677
|
+
def HasField(self, field_name: typing.Literal["options", b"options", "track_handle", b"track_handle"]) -> builtins.bool: ...
|
|
678
|
+
def ClearField(self, field_name: typing.Literal["options", b"options", "track_handle", b"track_handle"]) -> None: ...
|
|
679
|
+
|
|
680
|
+
global___SubscribeDataTrackRequest = SubscribeDataTrackRequest
|
|
681
|
+
|
|
682
|
+
@typing.final
|
|
683
|
+
class SubscribeDataTrackResponse(google.protobuf.message.Message):
|
|
684
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
685
|
+
|
|
686
|
+
STREAM_FIELD_NUMBER: builtins.int
|
|
687
|
+
@property
|
|
688
|
+
def stream(self) -> global___OwnedDataTrackStream: ...
|
|
689
|
+
def __init__(
|
|
690
|
+
self,
|
|
691
|
+
*,
|
|
692
|
+
stream: global___OwnedDataTrackStream | None = ...,
|
|
693
|
+
) -> None: ...
|
|
694
|
+
def HasField(self, field_name: typing.Literal["stream", b"stream"]) -> builtins.bool: ...
|
|
695
|
+
def ClearField(self, field_name: typing.Literal["stream", b"stream"]) -> None: ...
|
|
696
|
+
|
|
697
|
+
global___SubscribeDataTrackResponse = SubscribeDataTrackResponse
|
|
698
|
+
|
|
699
|
+
@typing.final
|
|
700
|
+
class DataTrackStreamReadRequest(google.protobuf.message.Message):
|
|
701
|
+
"""Signal readiness to handle the next frame.
|
|
702
|
+
|
|
703
|
+
This allows the client to put backpressure on the internal receive buffer.
|
|
704
|
+
Sending this request will cause the next frame to be sent via `DataTrackStreamFrameReceived`
|
|
705
|
+
once one is available.
|
|
706
|
+
"""
|
|
707
|
+
|
|
708
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
709
|
+
|
|
710
|
+
STREAM_HANDLE_FIELD_NUMBER: builtins.int
|
|
711
|
+
stream_handle: builtins.int
|
|
712
|
+
def __init__(
|
|
713
|
+
self,
|
|
714
|
+
*,
|
|
715
|
+
stream_handle: builtins.int | None = ...,
|
|
716
|
+
) -> None: ...
|
|
717
|
+
def HasField(self, field_name: typing.Literal["stream_handle", b"stream_handle"]) -> builtins.bool: ...
|
|
718
|
+
def ClearField(self, field_name: typing.Literal["stream_handle", b"stream_handle"]) -> None: ...
|
|
719
|
+
|
|
720
|
+
global___DataTrackStreamReadRequest = DataTrackStreamReadRequest
|
|
721
|
+
|
|
722
|
+
@typing.final
|
|
723
|
+
class DataTrackStreamReadResponse(google.protobuf.message.Message):
|
|
724
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
725
|
+
|
|
726
|
+
EOS_EVENT_FIELD_NUMBER: builtins.int
|
|
727
|
+
@property
|
|
728
|
+
def eos_event(self) -> global___DataTrackStreamEOS:
|
|
729
|
+
"""The end-of-stream event if the stream has already ended."""
|
|
730
|
+
|
|
731
|
+
def __init__(
|
|
732
|
+
self,
|
|
733
|
+
*,
|
|
734
|
+
eos_event: global___DataTrackStreamEOS | None = ...,
|
|
735
|
+
) -> None: ...
|
|
736
|
+
def HasField(self, field_name: typing.Literal["eos_event", b"eos_event"]) -> builtins.bool: ...
|
|
737
|
+
def ClearField(self, field_name: typing.Literal["eos_event", b"eos_event"]) -> None: ...
|
|
738
|
+
|
|
739
|
+
global___DataTrackStreamReadResponse = DataTrackStreamReadResponse
|
|
740
|
+
|
|
741
|
+
@typing.final
|
|
742
|
+
class DataTrackStreamEvent(google.protobuf.message.Message):
|
|
743
|
+
"""Event emitted on an active stream."""
|
|
744
|
+
|
|
745
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
746
|
+
|
|
747
|
+
STREAM_HANDLE_FIELD_NUMBER: builtins.int
|
|
748
|
+
FRAME_RECEIVED_FIELD_NUMBER: builtins.int
|
|
749
|
+
EOS_FIELD_NUMBER: builtins.int
|
|
750
|
+
stream_handle: builtins.int
|
|
751
|
+
@property
|
|
752
|
+
def frame_received(self) -> global___DataTrackStreamFrameReceived: ...
|
|
753
|
+
@property
|
|
754
|
+
def eos(self) -> global___DataTrackStreamEOS: ...
|
|
755
|
+
def __init__(
|
|
756
|
+
self,
|
|
757
|
+
*,
|
|
758
|
+
stream_handle: builtins.int | None = ...,
|
|
759
|
+
frame_received: global___DataTrackStreamFrameReceived | None = ...,
|
|
760
|
+
eos: global___DataTrackStreamEOS | None = ...,
|
|
761
|
+
) -> None: ...
|
|
762
|
+
def HasField(self, field_name: typing.Literal["detail", b"detail", "eos", b"eos", "frame_received", b"frame_received", "stream_handle", b"stream_handle"]) -> builtins.bool: ...
|
|
763
|
+
def ClearField(self, field_name: typing.Literal["detail", b"detail", "eos", b"eos", "frame_received", b"frame_received", "stream_handle", b"stream_handle"]) -> None: ...
|
|
764
|
+
def WhichOneof(self, oneof_group: typing.Literal["detail", b"detail"]) -> typing.Literal["frame_received", "eos"] | None: ...
|
|
765
|
+
|
|
766
|
+
global___DataTrackStreamEvent = DataTrackStreamEvent
|
|
767
|
+
|
|
768
|
+
@typing.final
|
|
769
|
+
class DataTrackStreamFrameReceived(google.protobuf.message.Message):
|
|
770
|
+
"""A frame was received."""
|
|
771
|
+
|
|
772
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
773
|
+
|
|
774
|
+
FRAME_FIELD_NUMBER: builtins.int
|
|
775
|
+
@property
|
|
776
|
+
def frame(self) -> global___DataTrackFrame: ...
|
|
777
|
+
def __init__(
|
|
778
|
+
self,
|
|
779
|
+
*,
|
|
780
|
+
frame: global___DataTrackFrame | None = ...,
|
|
781
|
+
) -> None: ...
|
|
782
|
+
def HasField(self, field_name: typing.Literal["frame", b"frame"]) -> builtins.bool: ...
|
|
783
|
+
def ClearField(self, field_name: typing.Literal["frame", b"frame"]) -> None: ...
|
|
784
|
+
|
|
785
|
+
global___DataTrackStreamFrameReceived = DataTrackStreamFrameReceived
|
|
786
|
+
|
|
787
|
+
@typing.final
|
|
788
|
+
class DataTrackStreamEOS(google.protobuf.message.Message):
|
|
789
|
+
"""Stream has ended."""
|
|
790
|
+
|
|
791
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
792
|
+
|
|
793
|
+
ERROR_FIELD_NUMBER: builtins.int
|
|
794
|
+
@property
|
|
795
|
+
def error(self) -> global___SubscribeDataTrackError:
|
|
796
|
+
"""Present if stream ended before any frames were emitted due to subscription establishment failing.
|
|
797
|
+
Absent if the stream ended normally (i.e., due to the track being unpublished).
|
|
798
|
+
"""
|
|
799
|
+
|
|
800
|
+
def __init__(
|
|
801
|
+
self,
|
|
802
|
+
*,
|
|
803
|
+
error: global___SubscribeDataTrackError | None = ...,
|
|
804
|
+
) -> None: ...
|
|
805
|
+
def HasField(self, field_name: typing.Literal["error", b"error"]) -> builtins.bool: ...
|
|
806
|
+
def ClearField(self, field_name: typing.Literal["error", b"error"]) -> None: ...
|
|
807
|
+
|
|
808
|
+
global___DataTrackStreamEOS = DataTrackStreamEOS
|
|
809
|
+
|
|
810
|
+
@typing.final
|
|
811
|
+
class DataTrackSchemaEncoding(google.protobuf.message.Message):
|
|
812
|
+
"""MARK: - Schemas
|
|
813
|
+
|
|
814
|
+
Encoding used to interpret a data track schema definition.
|
|
815
|
+
"""
|
|
816
|
+
|
|
817
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
818
|
+
|
|
819
|
+
class _WellKnownSchemaEncoding:
|
|
820
|
+
ValueType = typing.NewType("ValueType", builtins.int)
|
|
821
|
+
V: typing_extensions.TypeAlias = ValueType
|
|
822
|
+
|
|
823
|
+
class _WellKnownSchemaEncodingEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[DataTrackSchemaEncoding._WellKnownSchemaEncoding.ValueType], builtins.type):
|
|
824
|
+
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
825
|
+
WELL_KNOWN_SCHEMA_ENCODING_UNSPECIFIED: DataTrackSchemaEncoding._WellKnownSchemaEncoding.ValueType # 0
|
|
826
|
+
WELL_KNOWN_SCHEMA_ENCODING_PROTOBUF: DataTrackSchemaEncoding._WellKnownSchemaEncoding.ValueType # 1
|
|
827
|
+
WELL_KNOWN_SCHEMA_ENCODING_FLATBUFFER: DataTrackSchemaEncoding._WellKnownSchemaEncoding.ValueType # 2
|
|
828
|
+
WELL_KNOWN_SCHEMA_ENCODING_ROS1_MSG: DataTrackSchemaEncoding._WellKnownSchemaEncoding.ValueType # 3
|
|
829
|
+
WELL_KNOWN_SCHEMA_ENCODING_ROS2_MSG: DataTrackSchemaEncoding._WellKnownSchemaEncoding.ValueType # 4
|
|
830
|
+
WELL_KNOWN_SCHEMA_ENCODING_ROS2_IDL: DataTrackSchemaEncoding._WellKnownSchemaEncoding.ValueType # 5
|
|
831
|
+
WELL_KNOWN_SCHEMA_ENCODING_OMG_IDL: DataTrackSchemaEncoding._WellKnownSchemaEncoding.ValueType # 6
|
|
832
|
+
WELL_KNOWN_SCHEMA_ENCODING_JSON_SCHEMA: DataTrackSchemaEncoding._WellKnownSchemaEncoding.ValueType # 7
|
|
833
|
+
|
|
834
|
+
class WellKnownSchemaEncoding(_WellKnownSchemaEncoding, metaclass=_WellKnownSchemaEncodingEnumTypeWrapper):
|
|
835
|
+
"""Well-known encoding for a schema definition."""
|
|
836
|
+
|
|
837
|
+
WELL_KNOWN_SCHEMA_ENCODING_UNSPECIFIED: DataTrackSchemaEncoding.WellKnownSchemaEncoding.ValueType # 0
|
|
838
|
+
WELL_KNOWN_SCHEMA_ENCODING_PROTOBUF: DataTrackSchemaEncoding.WellKnownSchemaEncoding.ValueType # 1
|
|
839
|
+
WELL_KNOWN_SCHEMA_ENCODING_FLATBUFFER: DataTrackSchemaEncoding.WellKnownSchemaEncoding.ValueType # 2
|
|
840
|
+
WELL_KNOWN_SCHEMA_ENCODING_ROS1_MSG: DataTrackSchemaEncoding.WellKnownSchemaEncoding.ValueType # 3
|
|
841
|
+
WELL_KNOWN_SCHEMA_ENCODING_ROS2_MSG: DataTrackSchemaEncoding.WellKnownSchemaEncoding.ValueType # 4
|
|
842
|
+
WELL_KNOWN_SCHEMA_ENCODING_ROS2_IDL: DataTrackSchemaEncoding.WellKnownSchemaEncoding.ValueType # 5
|
|
843
|
+
WELL_KNOWN_SCHEMA_ENCODING_OMG_IDL: DataTrackSchemaEncoding.WellKnownSchemaEncoding.ValueType # 6
|
|
844
|
+
WELL_KNOWN_SCHEMA_ENCODING_JSON_SCHEMA: DataTrackSchemaEncoding.WellKnownSchemaEncoding.ValueType # 7
|
|
845
|
+
|
|
846
|
+
WELL_KNOWN_FIELD_NUMBER: builtins.int
|
|
847
|
+
CUSTOM_FIELD_NUMBER: builtins.int
|
|
848
|
+
well_known: global___DataTrackSchemaEncoding.WellKnownSchemaEncoding.ValueType
|
|
849
|
+
custom: builtins.str
|
|
850
|
+
"""Identifier of a custom encoding not covered by the well-known cases.
|
|
851
|
+
This must be non-empty and no longer than 25 characters.
|
|
852
|
+
"""
|
|
853
|
+
def __init__(
|
|
854
|
+
self,
|
|
855
|
+
*,
|
|
856
|
+
well_known: global___DataTrackSchemaEncoding.WellKnownSchemaEncoding.ValueType | None = ...,
|
|
857
|
+
custom: builtins.str | None = ...,
|
|
858
|
+
) -> None: ...
|
|
859
|
+
def HasField(self, field_name: typing.Literal["custom", b"custom", "encoding", b"encoding", "well_known", b"well_known"]) -> builtins.bool: ...
|
|
860
|
+
def ClearField(self, field_name: typing.Literal["custom", b"custom", "encoding", b"encoding", "well_known", b"well_known"]) -> None: ...
|
|
861
|
+
def WhichOneof(self, oneof_group: typing.Literal["encoding", b"encoding"]) -> typing.Literal["well_known", "custom"] | None: ...
|
|
862
|
+
|
|
863
|
+
global___DataTrackSchemaEncoding = DataTrackSchemaEncoding
|
|
864
|
+
|
|
865
|
+
@typing.final
|
|
866
|
+
class DataTrackFrameEncoding(google.protobuf.message.Message):
|
|
867
|
+
"""Encoding used for frames sent on a data track."""
|
|
868
|
+
|
|
869
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
870
|
+
|
|
871
|
+
class _WellKnownFrameEncoding:
|
|
872
|
+
ValueType = typing.NewType("ValueType", builtins.int)
|
|
873
|
+
V: typing_extensions.TypeAlias = ValueType
|
|
874
|
+
|
|
875
|
+
class _WellKnownFrameEncodingEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[DataTrackFrameEncoding._WellKnownFrameEncoding.ValueType], builtins.type):
|
|
876
|
+
DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
|
|
877
|
+
WELL_KNOWN_FRAME_ENCODING_UNSPECIFIED: DataTrackFrameEncoding._WellKnownFrameEncoding.ValueType # 0
|
|
878
|
+
WELL_KNOWN_FRAME_ENCODING_ROS1: DataTrackFrameEncoding._WellKnownFrameEncoding.ValueType # 1
|
|
879
|
+
WELL_KNOWN_FRAME_ENCODING_CDR: DataTrackFrameEncoding._WellKnownFrameEncoding.ValueType # 2
|
|
880
|
+
WELL_KNOWN_FRAME_ENCODING_PROTOBUF: DataTrackFrameEncoding._WellKnownFrameEncoding.ValueType # 3
|
|
881
|
+
WELL_KNOWN_FRAME_ENCODING_FLATBUFFER: DataTrackFrameEncoding._WellKnownFrameEncoding.ValueType # 4
|
|
882
|
+
WELL_KNOWN_FRAME_ENCODING_CBOR: DataTrackFrameEncoding._WellKnownFrameEncoding.ValueType # 5
|
|
883
|
+
WELL_KNOWN_FRAME_ENCODING_MSGPACK: DataTrackFrameEncoding._WellKnownFrameEncoding.ValueType # 6
|
|
884
|
+
WELL_KNOWN_FRAME_ENCODING_JSON: DataTrackFrameEncoding._WellKnownFrameEncoding.ValueType # 7
|
|
885
|
+
|
|
886
|
+
class WellKnownFrameEncoding(_WellKnownFrameEncoding, metaclass=_WellKnownFrameEncodingEnumTypeWrapper):
|
|
887
|
+
"""Well-known encoding for frame payloads."""
|
|
888
|
+
|
|
889
|
+
WELL_KNOWN_FRAME_ENCODING_UNSPECIFIED: DataTrackFrameEncoding.WellKnownFrameEncoding.ValueType # 0
|
|
890
|
+
WELL_KNOWN_FRAME_ENCODING_ROS1: DataTrackFrameEncoding.WellKnownFrameEncoding.ValueType # 1
|
|
891
|
+
WELL_KNOWN_FRAME_ENCODING_CDR: DataTrackFrameEncoding.WellKnownFrameEncoding.ValueType # 2
|
|
892
|
+
WELL_KNOWN_FRAME_ENCODING_PROTOBUF: DataTrackFrameEncoding.WellKnownFrameEncoding.ValueType # 3
|
|
893
|
+
WELL_KNOWN_FRAME_ENCODING_FLATBUFFER: DataTrackFrameEncoding.WellKnownFrameEncoding.ValueType # 4
|
|
894
|
+
WELL_KNOWN_FRAME_ENCODING_CBOR: DataTrackFrameEncoding.WellKnownFrameEncoding.ValueType # 5
|
|
895
|
+
WELL_KNOWN_FRAME_ENCODING_MSGPACK: DataTrackFrameEncoding.WellKnownFrameEncoding.ValueType # 6
|
|
896
|
+
WELL_KNOWN_FRAME_ENCODING_JSON: DataTrackFrameEncoding.WellKnownFrameEncoding.ValueType # 7
|
|
897
|
+
|
|
898
|
+
WELL_KNOWN_FIELD_NUMBER: builtins.int
|
|
899
|
+
CUSTOM_FIELD_NUMBER: builtins.int
|
|
900
|
+
well_known: global___DataTrackFrameEncoding.WellKnownFrameEncoding.ValueType
|
|
901
|
+
custom: builtins.str
|
|
902
|
+
"""Identifier of a custom encoding not covered by the well-known cases.
|
|
903
|
+
This must be non-empty and no longer than 25 characters.
|
|
904
|
+
"""
|
|
905
|
+
def __init__(
|
|
906
|
+
self,
|
|
907
|
+
*,
|
|
908
|
+
well_known: global___DataTrackFrameEncoding.WellKnownFrameEncoding.ValueType | None = ...,
|
|
909
|
+
custom: builtins.str | None = ...,
|
|
910
|
+
) -> None: ...
|
|
911
|
+
def HasField(self, field_name: typing.Literal["custom", b"custom", "encoding", b"encoding", "well_known", b"well_known"]) -> builtins.bool: ...
|
|
912
|
+
def ClearField(self, field_name: typing.Literal["custom", b"custom", "encoding", b"encoding", "well_known", b"well_known"]) -> None: ...
|
|
913
|
+
def WhichOneof(self, oneof_group: typing.Literal["encoding", b"encoding"]) -> typing.Literal["well_known", "custom"] | None: ...
|
|
914
|
+
|
|
915
|
+
global___DataTrackFrameEncoding = DataTrackFrameEncoding
|
|
916
|
+
|
|
917
|
+
@typing.final
|
|
918
|
+
class DataTrackSchemaId(google.protobuf.message.Message):
|
|
919
|
+
"""Uniquely identifies a data track schema."""
|
|
920
|
+
|
|
921
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
922
|
+
|
|
923
|
+
NAME_FIELD_NUMBER: builtins.int
|
|
924
|
+
ENCODING_FIELD_NUMBER: builtins.int
|
|
925
|
+
name: builtins.str
|
|
926
|
+
"""Name component of the schema identifier."""
|
|
927
|
+
@property
|
|
928
|
+
def encoding(self) -> global___DataTrackSchemaEncoding:
|
|
929
|
+
"""Encoding of the schema definition."""
|
|
930
|
+
|
|
931
|
+
def __init__(
|
|
932
|
+
self,
|
|
933
|
+
*,
|
|
934
|
+
name: builtins.str | None = ...,
|
|
935
|
+
encoding: global___DataTrackSchemaEncoding | None = ...,
|
|
936
|
+
) -> None: ...
|
|
937
|
+
def HasField(self, field_name: typing.Literal["encoding", b"encoding", "name", b"name"]) -> builtins.bool: ...
|
|
938
|
+
def ClearField(self, field_name: typing.Literal["encoding", b"encoding", "name", b"name"]) -> None: ...
|
|
939
|
+
|
|
940
|
+
global___DataTrackSchemaId = DataTrackSchemaId
|
|
941
|
+
|
|
942
|
+
@typing.final
|
|
943
|
+
class DefineSchemaRequest(google.protobuf.message.Message):
|
|
944
|
+
"""Define (store) a schema definition for the local participant."""
|
|
945
|
+
|
|
946
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
947
|
+
|
|
948
|
+
LOCAL_PARTICIPANT_HANDLE_FIELD_NUMBER: builtins.int
|
|
949
|
+
SCHEMA_ID_FIELD_NUMBER: builtins.int
|
|
950
|
+
DEFINITION_FIELD_NUMBER: builtins.int
|
|
951
|
+
REQUEST_ASYNC_ID_FIELD_NUMBER: builtins.int
|
|
952
|
+
local_participant_handle: builtins.int
|
|
953
|
+
definition: builtins.str
|
|
954
|
+
request_async_id: builtins.int
|
|
955
|
+
@property
|
|
956
|
+
def schema_id(self) -> global___DataTrackSchemaId: ...
|
|
957
|
+
def __init__(
|
|
958
|
+
self,
|
|
959
|
+
*,
|
|
960
|
+
local_participant_handle: builtins.int | None = ...,
|
|
961
|
+
schema_id: global___DataTrackSchemaId | None = ...,
|
|
962
|
+
definition: builtins.str | None = ...,
|
|
963
|
+
request_async_id: builtins.int | None = ...,
|
|
964
|
+
) -> None: ...
|
|
965
|
+
def HasField(self, field_name: typing.Literal["definition", b"definition", "local_participant_handle", b"local_participant_handle", "request_async_id", b"request_async_id", "schema_id", b"schema_id"]) -> builtins.bool: ...
|
|
966
|
+
def ClearField(self, field_name: typing.Literal["definition", b"definition", "local_participant_handle", b"local_participant_handle", "request_async_id", b"request_async_id", "schema_id", b"schema_id"]) -> None: ...
|
|
967
|
+
|
|
968
|
+
global___DefineSchemaRequest = DefineSchemaRequest
|
|
969
|
+
|
|
970
|
+
@typing.final
|
|
971
|
+
class DefineSchemaResponse(google.protobuf.message.Message):
|
|
972
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
973
|
+
|
|
974
|
+
ASYNC_ID_FIELD_NUMBER: builtins.int
|
|
975
|
+
async_id: builtins.int
|
|
976
|
+
def __init__(
|
|
977
|
+
self,
|
|
978
|
+
*,
|
|
979
|
+
async_id: builtins.int | None = ...,
|
|
980
|
+
) -> None: ...
|
|
981
|
+
def HasField(self, field_name: typing.Literal["async_id", b"async_id"]) -> builtins.bool: ...
|
|
982
|
+
def ClearField(self, field_name: typing.Literal["async_id", b"async_id"]) -> None: ...
|
|
983
|
+
|
|
984
|
+
global___DefineSchemaResponse = DefineSchemaResponse
|
|
985
|
+
|
|
986
|
+
@typing.final
|
|
987
|
+
class DefineSchemaCallback(google.protobuf.message.Message):
|
|
988
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
989
|
+
|
|
990
|
+
ASYNC_ID_FIELD_NUMBER: builtins.int
|
|
991
|
+
ERROR_FIELD_NUMBER: builtins.int
|
|
992
|
+
async_id: builtins.int
|
|
993
|
+
error: builtins.str
|
|
994
|
+
"""Present if the schema could not be defined."""
|
|
995
|
+
def __init__(
|
|
996
|
+
self,
|
|
997
|
+
*,
|
|
998
|
+
async_id: builtins.int | None = ...,
|
|
999
|
+
error: builtins.str | None = ...,
|
|
1000
|
+
) -> None: ...
|
|
1001
|
+
def HasField(self, field_name: typing.Literal["async_id", b"async_id", "error", b"error"]) -> builtins.bool: ...
|
|
1002
|
+
def ClearField(self, field_name: typing.Literal["async_id", b"async_id", "error", b"error"]) -> None: ...
|
|
1003
|
+
|
|
1004
|
+
global___DefineSchemaCallback = DefineSchemaCallback
|
|
1005
|
+
|
|
1006
|
+
@typing.final
|
|
1007
|
+
class GetSchemaRequest(google.protobuf.message.Message):
|
|
1008
|
+
"""Retrieve a schema definition previously stored by a participant."""
|
|
1009
|
+
|
|
1010
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
1011
|
+
|
|
1012
|
+
LOCAL_PARTICIPANT_HANDLE_FIELD_NUMBER: builtins.int
|
|
1013
|
+
SCHEMA_ID_FIELD_NUMBER: builtins.int
|
|
1014
|
+
PARTICIPANT_IDENTITY_FIELD_NUMBER: builtins.int
|
|
1015
|
+
REQUEST_ASYNC_ID_FIELD_NUMBER: builtins.int
|
|
1016
|
+
local_participant_handle: builtins.int
|
|
1017
|
+
participant_identity: builtins.str
|
|
1018
|
+
"""Identity of the participant who owns the schema."""
|
|
1019
|
+
request_async_id: builtins.int
|
|
1020
|
+
@property
|
|
1021
|
+
def schema_id(self) -> global___DataTrackSchemaId: ...
|
|
1022
|
+
def __init__(
|
|
1023
|
+
self,
|
|
1024
|
+
*,
|
|
1025
|
+
local_participant_handle: builtins.int | None = ...,
|
|
1026
|
+
schema_id: global___DataTrackSchemaId | None = ...,
|
|
1027
|
+
participant_identity: builtins.str | None = ...,
|
|
1028
|
+
request_async_id: builtins.int | None = ...,
|
|
1029
|
+
) -> None: ...
|
|
1030
|
+
def HasField(self, field_name: typing.Literal["local_participant_handle", b"local_participant_handle", "participant_identity", b"participant_identity", "request_async_id", b"request_async_id", "schema_id", b"schema_id"]) -> builtins.bool: ...
|
|
1031
|
+
def ClearField(self, field_name: typing.Literal["local_participant_handle", b"local_participant_handle", "participant_identity", b"participant_identity", "request_async_id", b"request_async_id", "schema_id", b"schema_id"]) -> None: ...
|
|
1032
|
+
|
|
1033
|
+
global___GetSchemaRequest = GetSchemaRequest
|
|
1034
|
+
|
|
1035
|
+
@typing.final
|
|
1036
|
+
class GetSchemaResponse(google.protobuf.message.Message):
|
|
1037
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
1038
|
+
|
|
1039
|
+
ASYNC_ID_FIELD_NUMBER: builtins.int
|
|
1040
|
+
async_id: builtins.int
|
|
1041
|
+
def __init__(
|
|
1042
|
+
self,
|
|
1043
|
+
*,
|
|
1044
|
+
async_id: builtins.int | None = ...,
|
|
1045
|
+
) -> None: ...
|
|
1046
|
+
def HasField(self, field_name: typing.Literal["async_id", b"async_id"]) -> builtins.bool: ...
|
|
1047
|
+
def ClearField(self, field_name: typing.Literal["async_id", b"async_id"]) -> None: ...
|
|
1048
|
+
|
|
1049
|
+
global___GetSchemaResponse = GetSchemaResponse
|
|
1050
|
+
|
|
1051
|
+
@typing.final
|
|
1052
|
+
class GetSchemaCallback(google.protobuf.message.Message):
|
|
1053
|
+
DESCRIPTOR: google.protobuf.descriptor.Descriptor
|
|
1054
|
+
|
|
1055
|
+
ASYNC_ID_FIELD_NUMBER: builtins.int
|
|
1056
|
+
DEFINITION_FIELD_NUMBER: builtins.int
|
|
1057
|
+
ERROR_FIELD_NUMBER: builtins.int
|
|
1058
|
+
async_id: builtins.int
|
|
1059
|
+
definition: builtins.str
|
|
1060
|
+
"""The schema definition, present on success."""
|
|
1061
|
+
error: builtins.str
|
|
1062
|
+
"""Present if the schema could not be retrieved."""
|
|
1063
|
+
def __init__(
|
|
1064
|
+
self,
|
|
1065
|
+
*,
|
|
1066
|
+
async_id: builtins.int | None = ...,
|
|
1067
|
+
definition: builtins.str | None = ...,
|
|
1068
|
+
error: builtins.str | None = ...,
|
|
1069
|
+
) -> None: ...
|
|
1070
|
+
def HasField(self, field_name: typing.Literal["async_id", b"async_id", "definition", b"definition", "error", b"error"]) -> builtins.bool: ...
|
|
1071
|
+
def ClearField(self, field_name: typing.Literal["async_id", b"async_id", "definition", b"definition", "error", b"error"]) -> None: ...
|
|
1072
|
+
|
|
1073
|
+
global___GetSchemaCallback = GetSchemaCallback
|