@webex/event-dictionary-ts 1.0.1609 → 1.0.1610

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.
Files changed (4) hide show
  1. package/generated/jsonschema/Event.json +82 -0
  2. package/generated/jsonschema/MediaQualityEvent.json +82 -0
  3. package/generated/typescript/index.d.ts +54 -0
  4. package/package.json +1 -1
package/generated/jsonschema/Event.json CHANGED
@@ -21217,6 +21217,88 @@
21217
21217
  }
21218
21218
  }
21219
21219
  }
21220
+ },
21221
+ "mediaState": {
21222
+ "type": "array",
21223
+ "items": {
21224
+ "type": "object",
21225
+ "description": "represents detailed information when there is an instance of media error (currently it covers media or media drop) at client side.",
21226
+ "additionalProperties": true,
21227
+ "required": [
21228
+ "stateType",
21229
+ "duration",
21230
+ "mediaType"
21231
+ ],
21232
+ "properties": {
21233
+ "stateType": {
21234
+ "enum": [
21235
+ "start",
21236
+ "during"
21237
+ ],
21238
+ "type": "string"
21239
+ },
21240
+ "duration": {
21241
+ "type": "number",
21242
+ "minimum": 0.0,
21243
+ "maximum": 9223372036854776000.0
21244
+ },
21245
+ "mediaType": {
21246
+ "type": "string",
21247
+ "enum": [
21248
+ "audio",
21249
+ "video",
21250
+ "share",
21251
+ "share_audio",
21252
+ "whiteboard",
21253
+ "gamestate"
21254
+ ]
21255
+ },
21256
+ "shareInstanceId": {
21257
+ "type": "string"
21258
+ },
21259
+ "direction": {
21260
+ "enum": [
21261
+ "RX",
21262
+ "TX",
21263
+ "BOTH"
21264
+ ],
21265
+ "type": "string"
21266
+ },
21267
+ "errorType": {
21268
+ "type": "string",
21269
+ "enum": [
21270
+ "NO_ERROR\t# No issues, reported under the report section for media error",
21271
+ "DECRYPT_ERROR\t#Decrypt related issues, srtp, mls ++",
21272
+ "DEVICE_ERROR",
21273
+ "LOAD_LIBRARY_ERROR\t# Fail to load media library, including security checks",
21274
+ "NO_FRAME_DECODE_ERROR\t# Video frame decode errors or Audio packet decode error",
21275
+ "NO_PACKET_RECV_ERROR\t# No packet received for a session (media type)",
21276
+ "INITIAL_MEMORY_ERROR\t# Fail to allocate memory. More common on 32-bits than 64-bits OS",
21277
+ "MAC_VIRTUAL_AUDIO_DRV_ERROR\t# In high frame share audio, mac need install virtual audio driver to capture computer audio.",
21278
+ "MEDIA_PROCESS_CRASH_ERROR\t# Media process crash",
21279
+ "HEARTBEAT_LOST_WITH_MEDIA_PROCESS_ERROR\t# Lost heart beat from media process, such as media process hung, IPC issue.",
21280
+ "LOCUS_SESSION_CONNECT_ERROR\t# Connect to locus server fail.",
21281
+ "NO_PACKET_SEND_ERROR\t# No packets send out.",
21282
+ "NETWORK_LOST_ERROR\t# Network lost causes meeting end.",
21283
+ "MEDIA_NOT_AVAILABLE\t# Media is not available after media channel is created, such as SCR failure.",
21284
+ "MEDIA_CONNECT_FAILURE"
21285
+ ]
21286
+ },
21287
+ "errorCode": {
21288
+ "type": "number",
21289
+ "minimum": -9223372036854776000.0,
21290
+ "maximum": 9223372036854776000.0
21291
+ },
21292
+ "errorCodeExt1": {
21293
+ "type": "number",
21294
+ "minimum": -9223372036854776000.0,
21295
+ "maximum": 9223372036854776000.0
21296
+ },
21297
+ "errorDescription": {
21298
+ "type": "string"
21299
+ }
21300
+ }
21301
+ }
21220
21302
  }
21221
21303
  }
21222
21304
  },
package/generated/jsonschema/MediaQualityEvent.json CHANGED
@@ -9132,6 +9132,88 @@
9132
9132
  }
9133
9133
  }
9134
9134
  }
9135
+ },
9136
+ "mediaState": {
9137
+ "type": "array",
9138
+ "items": {
9139
+ "type": "object",
9140
+ "description": "represents detailed information when there is an instance of media error (currently it covers media or media drop) at client side.",
9141
+ "additionalProperties": true,
9142
+ "required": [
9143
+ "stateType",
9144
+ "duration",
9145
+ "mediaType"
9146
+ ],
9147
+ "properties": {
9148
+ "stateType": {
9149
+ "enum": [
9150
+ "start",
9151
+ "during"
9152
+ ],
9153
+ "type": "string"
9154
+ },
9155
+ "duration": {
9156
+ "type": "number",
9157
+ "minimum": 0.0,
9158
+ "maximum": 9223372036854776000.0
9159
+ },
9160
+ "mediaType": {
9161
+ "type": "string",
9162
+ "enum": [
9163
+ "audio",
9164
+ "video",
9165
+ "share",
9166
+ "share_audio",
9167
+ "whiteboard",
9168
+ "gamestate"
9169
+ ]
9170
+ },
9171
+ "shareInstanceId": {
9172
+ "type": "string"
9173
+ },
9174
+ "direction": {
9175
+ "enum": [
9176
+ "RX",
9177
+ "TX",
9178
+ "BOTH"
9179
+ ],
9180
+ "type": "string"
9181
+ },
9182
+ "errorType": {
9183
+ "type": "string",
9184
+ "enum": [
9185
+ "NO_ERROR\t# No issues, reported under the report section for media error",
9186
+ "DECRYPT_ERROR\t#Decrypt related issues, srtp, mls ++",
9187
+ "DEVICE_ERROR",
9188
+ "LOAD_LIBRARY_ERROR\t# Fail to load media library, including security checks",
9189
+ "NO_FRAME_DECODE_ERROR\t# Video frame decode errors or Audio packet decode error",
9190
+ "NO_PACKET_RECV_ERROR\t# No packet received for a session (media type)",
9191
+ "INITIAL_MEMORY_ERROR\t# Fail to allocate memory. More common on 32-bits than 64-bits OS",
9192
+ "MAC_VIRTUAL_AUDIO_DRV_ERROR\t# In high frame share audio, mac need install virtual audio driver to capture computer audio.",
9193
+ "MEDIA_PROCESS_CRASH_ERROR\t# Media process crash",
9194
+ "HEARTBEAT_LOST_WITH_MEDIA_PROCESS_ERROR\t# Lost heart beat from media process, such as media process hung, IPC issue.",
9195
+ "LOCUS_SESSION_CONNECT_ERROR\t# Connect to locus server fail.",
9196
+ "NO_PACKET_SEND_ERROR\t# No packets send out.",
9197
+ "NETWORK_LOST_ERROR\t# Network lost causes meeting end.",
9198
+ "MEDIA_NOT_AVAILABLE\t# Media is not available after media channel is created, such as SCR failure.",
9199
+ "MEDIA_CONNECT_FAILURE"
9200
+ ]
9201
+ },
9202
+ "errorCode": {
9203
+ "type": "number",
9204
+ "minimum": -9223372036854776000.0,
9205
+ "maximum": 9223372036854776000.0
9206
+ },
9207
+ "errorCodeExt1": {
9208
+ "type": "number",
9209
+ "minimum": -9223372036854776000.0,
9210
+ "maximum": 9223372036854776000.0
9211
+ },
9212
+ "errorDescription": {
9213
+ "type": "string"
9214
+ }
9215
+ }
9216
+ }
9135
9217
  }
9136
9218
  }
9137
9219
  }
package/generated/typescript/index.d.ts CHANGED
@@ -9061,6 +9061,33 @@ export interface Event {
9061
9061
  }[];
9062
9062
  additionalProperties?: false;
9063
9063
  }[];
9064
+ mediaState?: {
9065
+ stateType: "start" | "during";
9066
+ duration: number;
9067
+ mediaType: "audio" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
9068
+ shareInstanceId?: string;
9069
+ direction?: "RX" | "TX" | "BOTH";
9070
+ errorType?:
9071
+ | "NO_ERROR\t# No issues, reported under the report section for media error"
9072
+ | "DECRYPT_ERROR\t#Decrypt related issues, srtp, mls ++"
9073
+ | "DEVICE_ERROR"
9074
+ | "LOAD_LIBRARY_ERROR\t# Fail to load media library, including security checks"
9075
+ | "NO_FRAME_DECODE_ERROR\t# Video frame decode errors or Audio packet decode error"
9076
+ | "NO_PACKET_RECV_ERROR\t# No packet received for a session (media type)"
9077
+ | "INITIAL_MEMORY_ERROR\t# Fail to allocate memory. More common on 32-bits than 64-bits OS"
9078
+ | "MAC_VIRTUAL_AUDIO_DRV_ERROR\t# In high frame share audio, mac need install virtual audio driver to capture computer audio."
9079
+ | "MEDIA_PROCESS_CRASH_ERROR\t# Media process crash"
9080
+ | "HEARTBEAT_LOST_WITH_MEDIA_PROCESS_ERROR\t# Lost heart beat from media process, such as media process hung, IPC issue."
9081
+ | "LOCUS_SESSION_CONNECT_ERROR\t# Connect to locus server fail."
9082
+ | "NO_PACKET_SEND_ERROR\t# No packets send out."
9083
+ | "NETWORK_LOST_ERROR\t# Network lost causes meeting end."
9084
+ | "MEDIA_NOT_AVAILABLE\t# Media is not available after media channel is created, such as SCR failure."
9085
+ | "MEDIA_CONNECT_FAILURE";
9086
+ errorCode?: number;
9087
+ errorCodeExt1?: number;
9088
+ errorDescription?: string;
9089
+ additionalProperties?: false;
9090
+ }[];
9064
9091
  additionalProperties?: false;
9065
9092
  }
9066
9093
  | {
@@ -20966,5 +20993,32 @@ export interface MediaQualityEvent {
20966
20993
  }[];
20967
20994
  additionalProperties?: false;
20968
20995
  }[];
20996
+ mediaState?: {
20997
+ stateType: "start" | "during";
20998
+ duration: number;
20999
+ mediaType: "audio" | "video" | "share" | "share_audio" | "whiteboard" | "gamestate";
21000
+ shareInstanceId?: string;
21001
+ direction?: "RX" | "TX" | "BOTH";
21002
+ errorType?:
21003
+ | "NO_ERROR\t# No issues, reported under the report section for media error"
21004
+ | "DECRYPT_ERROR\t#Decrypt related issues, srtp, mls ++"
21005
+ | "DEVICE_ERROR"
21006
+ | "LOAD_LIBRARY_ERROR\t# Fail to load media library, including security checks"
21007
+ | "NO_FRAME_DECODE_ERROR\t# Video frame decode errors or Audio packet decode error"
21008
+ | "NO_PACKET_RECV_ERROR\t# No packet received for a session (media type)"
21009
+ | "INITIAL_MEMORY_ERROR\t# Fail to allocate memory. More common on 32-bits than 64-bits OS"
21010
+ | "MAC_VIRTUAL_AUDIO_DRV_ERROR\t# In high frame share audio, mac need install virtual audio driver to capture computer audio."
21011
+ | "MEDIA_PROCESS_CRASH_ERROR\t# Media process crash"
21012
+ | "HEARTBEAT_LOST_WITH_MEDIA_PROCESS_ERROR\t# Lost heart beat from media process, such as media process hung, IPC issue."
21013
+ | "LOCUS_SESSION_CONNECT_ERROR\t# Connect to locus server fail."
21014
+ | "NO_PACKET_SEND_ERROR\t# No packets send out."
21015
+ | "NETWORK_LOST_ERROR\t# Network lost causes meeting end."
21016
+ | "MEDIA_NOT_AVAILABLE\t# Media is not available after media channel is created, such as SCR failure."
21017
+ | "MEDIA_CONNECT_FAILURE";
21018
+ errorCode?: number;
21019
+ errorCodeExt1?: number;
21020
+ errorDescription?: string;
21021
+ additionalProperties?: false;
21022
+ }[];
20969
21023
  additionalProperties?: false;
20970
21024
  }
package/package.json CHANGED
@@ -28,5 +28,5 @@
28
28
  "access": "public",
29
29
  "registry": "https://registry.npmjs.org"
30
30
  },
31
- "version": "1.0.1609"
31
+ "version": "1.0.1610"
32
32
  }