ZegoExpressDefines.js 44 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925
  1. /**
  2. * Application scenario.
  3. */
  4. export var ZegoScenario;
  5. (function (ZegoScenario) {
  6. /**
  7. * General scenario
  8. */
  9. ZegoScenario[ZegoScenario["General"] = 0] = "General";
  10. /**
  11. * Communication scenario
  12. */
  13. ZegoScenario[ZegoScenario["Communication"] = 1] = "Communication";
  14. /**
  15. * Live scenario
  16. */
  17. ZegoScenario[ZegoScenario["Live"] = 2] = "Live";
  18. })(ZegoScenario || (ZegoScenario = {}));
  19. /**
  20. * Language.
  21. */
  22. export var ZegoLanguage;
  23. (function (ZegoLanguage) {
  24. /**
  25. * English
  26. */
  27. ZegoLanguage[ZegoLanguage["English"] = 0] = "English";
  28. /**
  29. * Chinese
  30. */
  31. ZegoLanguage[ZegoLanguage["Chinese"] = 1] = "Chinese";
  32. })(ZegoLanguage || (ZegoLanguage = {}));
  33. export var ZegoOrientation;
  34. (function (ZegoOrientation) {
  35. ZegoOrientation[ZegoOrientation["PortraitUp"] = 0] = "PortraitUp";
  36. ZegoOrientation[ZegoOrientation["LandscapeLeft"] = 1] = "LandscapeLeft";
  37. ZegoOrientation[ZegoOrientation["PortraitDown"] = 2] = "PortraitDown";
  38. ZegoOrientation[ZegoOrientation["LandscapeRight"] = 3] = "LandscapeRight";
  39. })(ZegoOrientation || (ZegoOrientation = {}));
  40. /**
  41. * Engine state.
  42. */
  43. export var ZegoEngineState;
  44. (function (ZegoEngineState) {
  45. /**
  46. * The engine has started
  47. */
  48. ZegoEngineState[ZegoEngineState["Start"] = 0] = "Start";
  49. /**
  50. * The engine has stoped
  51. */
  52. ZegoEngineState[ZegoEngineState["Stop"] = 1] = "Stop";
  53. })(ZegoEngineState || (ZegoEngineState = {}));
  54. /**
  55. * Room state.
  56. */
  57. export var ZegoRoomState;
  58. (function (ZegoRoomState) {
  59. /**
  60. * Unconnected state, enter this state before logging in and after exiting the room. If there is a steady state abnormality in the process of logging in to the room, such as AppID and AppSign are incorrect, or if the same user name is logged in elsewhere and the local end is KickOut, it will enter this state.
  61. */
  62. ZegoRoomState[ZegoRoomState["DisConnected"] = 0] = "DisConnected";
  63. /**
  64. * The state that the connection is being requested. It will enter this state after successful execution login room function. The display of the UI is usually performed using this state. If the connection is interrupted due to poor network quality, the SDK will perform an internal retry and will return to the requesting connection status.
  65. */
  66. ZegoRoomState[ZegoRoomState["Connecting"] = 1] = "Connecting";
  67. /**
  68. * The status that is successfully connected. Entering this status indicates that the login to the room has been successful. The user can receive the callback notification of the user and the stream information in the room.
  69. */
  70. ZegoRoomState[ZegoRoomState["Connected"] = 2] = "Connected";
  71. })(ZegoRoomState || (ZegoRoomState = {}));
  72. /** Room mode. */
  73. export var ZegoRoomMode;
  74. (function (ZegoRoomMode) {
  75. /** Single room mode. */
  76. ZegoRoomMode[ZegoRoomMode["SingleRoom"] = 0] = "SingleRoom";
  77. /** Multiple room mode. */
  78. ZegoRoomMode[ZegoRoomMode["MultiRoom"] = 1] = "MultiRoom";
  79. })(ZegoRoomMode || (ZegoRoomMode = {}));
  80. /**
  81. * Publish channel.
  82. */
  83. export var ZegoPublishChannel;
  84. (function (ZegoPublishChannel) {
  85. /**
  86. * Main publish channel
  87. */
  88. ZegoPublishChannel[ZegoPublishChannel["Main"] = 0] = "Main";
  89. /**
  90. * Auxiliary publish channel
  91. */
  92. ZegoPublishChannel[ZegoPublishChannel["Aux"] = 1] = "Aux";
  93. })(ZegoPublishChannel || (ZegoPublishChannel = {}));
  94. /**
  95. * Publish stream status.
  96. */
  97. export var ZegoPublisherState;
  98. (function (ZegoPublisherState) {
  99. /**
  100. * The state is not published, and it is in this state before publishing the stream. If a steady-state exception occurs in the publish process, such as AppID and AppSign are incorrect, or if other users are already publishing the stream, there will be a failure and enter this state.
  101. */
  102. ZegoPublisherState[ZegoPublisherState["NoPublish"] = 0] = "NoPublish";
  103. /**
  104. * The state that it is requesting to publish the stream after the [startPublishingStream] function is successfully called. The UI is usually displayed through this state. If the connection is interrupted due to poor network quality, the SDK will perform an internal retry and will return to the requesting state.
  105. */
  106. ZegoPublisherState[ZegoPublisherState["PublishRequesting"] = 1] = "PublishRequesting";
  107. /**
  108. * The state that the stream is being published, entering the state indicates that the stream has been successfully published, and the user can communicate normally.
  109. */
  110. ZegoPublisherState[ZegoPublisherState["Publishing"] = 2] = "Publishing";
  111. })(ZegoPublisherState || (ZegoPublisherState = {}));
  112. /**
  113. * Video rendering fill mode.
  114. */
  115. export var ZegoViewMode;
  116. (function (ZegoViewMode) {
  117. /**
  118. * The proportional scaling up, there may be black borders
  119. */
  120. ZegoViewMode[ZegoViewMode["AspectFit"] = 0] = "AspectFit";
  121. /**
  122. * The proportional zoom fills the entire View and may be partially cut
  123. */
  124. ZegoViewMode[ZegoViewMode["AspectFill"] = 1] = "AspectFill";
  125. /**
  126. * Fill the entire view, the image may be stretched
  127. */
  128. ZegoViewMode[ZegoViewMode["ScaleToFill"] = 2] = "ScaleToFill";
  129. })(ZegoViewMode || (ZegoViewMode = {}));
  130. /**
  131. * Mirror mode for previewing or playing the of the stream.
  132. */
  133. export var ZegoVideoMirrorMode;
  134. (function (ZegoVideoMirrorMode) {
  135. /**
  136. * The mirror image only for previewing locally. This mode is used by default.
  137. */
  138. ZegoVideoMirrorMode[ZegoVideoMirrorMode["OnlyPreviewMirror"] = 0] = "OnlyPreviewMirror";
  139. /**
  140. * Both the video previewed locally and the far end playing the stream will see mirror image.
  141. */
  142. ZegoVideoMirrorMode[ZegoVideoMirrorMode["BothMirror"] = 1] = "BothMirror";
  143. /**
  144. * Both the video previewed locally and the far end playing the stream will not see mirror image.
  145. */
  146. ZegoVideoMirrorMode[ZegoVideoMirrorMode["NoMirror"] = 2] = "NoMirror";
  147. /**
  148. * The mirror image only for far end playing the stream.
  149. */
  150. ZegoVideoMirrorMode[ZegoVideoMirrorMode["OnlyPublishMirror"] = 3] = "OnlyPublishMirror";
  151. })(ZegoVideoMirrorMode || (ZegoVideoMirrorMode = {}));
  152. /// SEI type
  153. export var ZegoSEIType;
  154. (function (ZegoSEIType) {
  155. /// Using H.264 SEI (nalu type = 6, payload type = 243) type packaging, this type is not specified by the SEI standard, there is no conflict with the video encoder or the SEI in the video file, users do not need to follow the SEI content Do filtering, SDK uses this type by default.
  156. ZegoSEIType[ZegoSEIType["ZegoDefined"] = 0] = "ZegoDefined";
  157. /// SEI (nalu type = 6, payload type = 5) of H.264 is used for packaging. The H.264 standard has a prescribed format for this type: startcode + nalu type (6) + payload type (5) + len + payload (uuid + content) + trailing bits. Because the video encoder itself generates an SEI with a payload type of 5, or when a video file is used for streaming, such SEI may also exist in the video file, so when using this type, the user needs to use uuid + context as a buffer sending SEI. At this time, in order to distinguish the SEI generated by the video encoder itself, when the App sends this type of SEI, it can fill in the service-specific uuid (uuid length is 16 bytes). When the receiver uses the SDK to parse the SEI of the payload type 5, it will set filter string filters out the SEI matching the uuid and throws it to the business. If the filter string is not set, the SDK will throw all received SEI to the developer. uuid filter string setting function, [ZegoEngineConfig.advancedConfig("unregister_sei_filter","XXXXXX")], where unregister_sei_filter is the key, and XXXXX is the uuid filter string to be set.
  158. ZegoSEIType[ZegoSEIType["UserUnregister"] = 1] = "UserUnregister";
  159. })(ZegoSEIType || (ZegoSEIType = {}));
  160. /// Voice changer preset value.
  161. export var ZegoVoiceChangerPreset;
  162. (function (ZegoVoiceChangerPreset) {
  163. /// No Voice changer
  164. ZegoVoiceChangerPreset[ZegoVoiceChangerPreset["None"] = 0] = "None";
  165. /// Male to child voice (loli voice effect)
  166. ZegoVoiceChangerPreset[ZegoVoiceChangerPreset["MenToChild"] = 1] = "MenToChild";
  167. /// Male to female voice (kindergarten voice effect)
  168. ZegoVoiceChangerPreset[ZegoVoiceChangerPreset["MenToWomen"] = 2] = "MenToWomen";
  169. /// Female to child voice
  170. ZegoVoiceChangerPreset[ZegoVoiceChangerPreset["WomenToChild"] = 3] = "WomenToChild";
  171. /// Female to male voice
  172. ZegoVoiceChangerPreset[ZegoVoiceChangerPreset["WomenToMen"] = 4] = "WomenToMen";
  173. /// Foreigner voice effect
  174. ZegoVoiceChangerPreset[ZegoVoiceChangerPreset["Foreigner"] = 5] = "Foreigner";
  175. /// Autobot Optimus Prime voice effect
  176. ZegoVoiceChangerPreset[ZegoVoiceChangerPreset["OptimusPrime"] = 6] = "OptimusPrime";
  177. /// Android robot voice effect
  178. ZegoVoiceChangerPreset[ZegoVoiceChangerPreset["Android"] = 7] = "Android";
  179. /// Ethereal voice effect
  180. ZegoVoiceChangerPreset[ZegoVoiceChangerPreset["Ethereal"] = 8] = "Ethereal";
  181. /// Magnetic(Male) voice effect
  182. ZegoVoiceChangerPreset[ZegoVoiceChangerPreset["MaleMagnetic"] = 9] = "MaleMagnetic";
  183. /// Fresh(Female) voice effect
  184. ZegoVoiceChangerPreset[ZegoVoiceChangerPreset["FemaleFresh"] = 10] = "FemaleFresh";
  185. })(ZegoVoiceChangerPreset || (ZegoVoiceChangerPreset = {}));
  186. /// Reverberation preset value.
  187. export var ZegoReverbPreset;
  188. (function (ZegoReverbPreset) {
  189. /// No Reverberation
  190. ZegoReverbPreset[ZegoReverbPreset["None"] = 0] = "None";
  191. /// Soft room reverb effect
  192. ZegoReverbPreset[ZegoReverbPreset["SoftRoom"] = 1] = "SoftRoom";
  193. /// Large room reverb effect
  194. ZegoReverbPreset[ZegoReverbPreset["LargeRoom"] = 2] = "LargeRoom";
  195. /// Concer hall reverb effect
  196. ZegoReverbPreset[ZegoReverbPreset["ConcerHall"] = 3] = "ConcerHall";
  197. /// Valley reverb effect
  198. ZegoReverbPreset[ZegoReverbPreset["Valley"] = 4] = "Valley";
  199. /// Recording studio reverb effect
  200. ZegoReverbPreset[ZegoReverbPreset["RecordingStudio"] = 5] = "RecordingStudio";
  201. /// Basement reverb effect
  202. ZegoReverbPreset[ZegoReverbPreset["Basement"] = 6] = "Basement";
  203. /// KTV reverb effect
  204. ZegoReverbPreset[ZegoReverbPreset["KTV"] = 7] = "KTV";
  205. /// Popular reverb effect
  206. ZegoReverbPreset[ZegoReverbPreset["Popular"] = 8] = "Popular";
  207. /// Rock reverb effect
  208. ZegoReverbPreset[ZegoReverbPreset["Rock"] = 9] = "Rock";
  209. /// Vocal concert reverb effect
  210. ZegoReverbPreset[ZegoReverbPreset["VocalConcert"] = 10] = "VocalConcert";
  211. })(ZegoReverbPreset || (ZegoReverbPreset = {}));
  212. /**
  213. * Video configuration resolution and bitrate preset enumeration. The preset resolutions are adapted for mobile and desktop. On mobile, height is longer than width, and desktop is the opposite. For example, 1080p is actually 1080(w) x 1920(h) on mobile and 1920(w) x 1080(h) on desktop.
  214. */
  215. export var ZegoVideoConfigPreset;
  216. (function (ZegoVideoConfigPreset) {
  217. /**
  218. * Set the resolution to 320x180, the default is 15 fps, the code rate is 300 kbps
  219. */
  220. ZegoVideoConfigPreset[ZegoVideoConfigPreset["Preset180P"] = 0] = "Preset180P";
  221. /**
  222. * Set the resolution to 480x270, the default is 15 fps, the code rate is 400 kbps
  223. */
  224. ZegoVideoConfigPreset[ZegoVideoConfigPreset["Preset270P"] = 1] = "Preset270P";
  225. /**
  226. * Set the resolution to 640x360, the default is 15 fps, the code rate is 600 kbps
  227. */
  228. ZegoVideoConfigPreset[ZegoVideoConfigPreset["Preset360P"] = 2] = "Preset360P";
  229. /**
  230. * Set the resolution to 960x540, the default is 15 fps, the code rate is 1200 kbps
  231. */
  232. ZegoVideoConfigPreset[ZegoVideoConfigPreset["Preset540P"] = 3] = "Preset540P";
  233. /**
  234. * Set the resolution to 1280x720, the default is 15 fps, the code rate is 1500 kbps
  235. */
  236. ZegoVideoConfigPreset[ZegoVideoConfigPreset["Preset720P"] = 4] = "Preset720P";
  237. /**
  238. * Set the resolution to 1920x1080, the default is 15 fps, the code rate is 3000 kbps
  239. */
  240. ZegoVideoConfigPreset[ZegoVideoConfigPreset["Preset1080P"] = 5] = "Preset1080P";
  241. })(ZegoVideoConfigPreset || (ZegoVideoConfigPreset = {}));
  242. /**
  243. * Stream quality level.
  244. */
  245. export var ZegoStreamQualityLevel;
  246. (function (ZegoStreamQualityLevel) {
  247. /**
  248. * Excellent
  249. */
  250. ZegoStreamQualityLevel[ZegoStreamQualityLevel["Excellent"] = 0] = "Excellent";
  251. /**
  252. * Good
  253. */
  254. ZegoStreamQualityLevel[ZegoStreamQualityLevel["Good"] = 1] = "Good";
  255. /**
  256. * Normal
  257. */
  258. ZegoStreamQualityLevel[ZegoStreamQualityLevel["Medium"] = 2] = "Medium";
  259. /**
  260. * Bad
  261. */
  262. ZegoStreamQualityLevel[ZegoStreamQualityLevel["Bad"] = 3] = "Bad";
  263. /**
  264. * Failed
  265. */
  266. ZegoStreamQualityLevel[ZegoStreamQualityLevel["Die"] = 4] = "Die";
  267. })(ZegoStreamQualityLevel || (ZegoStreamQualityLevel = {}));
  268. /// Audio channel type.
  269. export var ZegoAudioChannel;
  270. (function (ZegoAudioChannel) {
  271. /// Unknown
  272. ZegoAudioChannel[ZegoAudioChannel["Unknown"] = 0] = "Unknown";
  273. /// Mono
  274. ZegoAudioChannel[ZegoAudioChannel["Mono"] = 1] = "Mono";
  275. /// Stereo
  276. ZegoAudioChannel[ZegoAudioChannel["Stereo"] = 2] = "Stereo";
  277. })(ZegoAudioChannel || (ZegoAudioChannel = {}));
  278. /// Audio capture stereo mode.
  279. export var ZegoAudioCaptureStereoMode;
  280. (function (ZegoAudioCaptureStereoMode) {
  281. /// Disable capture stereo, i.e. capture mono
  282. ZegoAudioCaptureStereoMode[ZegoAudioCaptureStereoMode["None"] = 0] = "None";
  283. /// Always enable capture stereo
  284. ZegoAudioCaptureStereoMode[ZegoAudioCaptureStereoMode["Always"] = 1] = "Always";
  285. /// Adaptive mode, capture stereo when publishing stream only, capture mono when publishing and playing stream (e.g. talk/intercom scenes)
  286. ZegoAudioCaptureStereoMode[ZegoAudioCaptureStereoMode["Adaptive"] = 2] = "Adaptive";
  287. })(ZegoAudioCaptureStereoMode || (ZegoAudioCaptureStereoMode = {}));
  288. /// Audio mix mode.
  289. export var ZegoAudioMixMode;
  290. (function (ZegoAudioMixMode) {
  291. /// Default mode, no special behavior
  292. ZegoAudioMixMode[ZegoAudioMixMode["Raw"] = 0] = "Raw";
  293. /// Audio focus mode, which can highlight the sound of a certain stream in multiple audio streams
  294. ZegoAudioMixMode[ZegoAudioMixMode["Focused"] = 1] = "Focused";
  295. })(ZegoAudioMixMode || (ZegoAudioMixMode = {}));
  296. /// Audio Codec ID.
  297. export var ZegoAudioCodecID;
  298. (function (ZegoAudioCodecID) {
  299. /// default
  300. ZegoAudioCodecID[ZegoAudioCodecID["Default"] = 0] = "Default";
  301. /// Normal
  302. ZegoAudioCodecID[ZegoAudioCodecID["Normal"] = 1] = "Normal";
  303. /// Normal2
  304. ZegoAudioCodecID[ZegoAudioCodecID["Normal2"] = 2] = "Normal2";
  305. /// Normal3
  306. ZegoAudioCodecID[ZegoAudioCodecID["Normal3"] = 3] = "Normal3";
  307. /// Low
  308. ZegoAudioCodecID[ZegoAudioCodecID["Low"] = 4] = "Low";
  309. /// Low2
  310. ZegoAudioCodecID[ZegoAudioCodecID["Low2"] = 5] = "Low2";
  311. /// Low3
  312. ZegoAudioCodecID[ZegoAudioCodecID["Low3"] = 6] = "Low3";
  313. })(ZegoAudioCodecID || (ZegoAudioCodecID = {}));
  314. /**
  315. * Video codec ID.
  316. */
  317. export var ZegoVideoCodecID;
  318. (function (ZegoVideoCodecID) {
  319. /**
  320. * Default (H.264)
  321. */
  322. ZegoVideoCodecID[ZegoVideoCodecID["Default"] = 0] = "Default";
  323. /**
  324. * Scalable Video Coding (H.264 SVC)
  325. */
  326. ZegoVideoCodecID[ZegoVideoCodecID["SVC"] = 1] = "SVC";
  327. /**
  328. * VP8
  329. */
  330. ZegoVideoCodecID[ZegoVideoCodecID["VP8"] = 2] = "VP8";
  331. /**
  332. * H.265
  333. */
  334. ZegoVideoCodecID[ZegoVideoCodecID["H265"] = 3] = "H265";
  335. })(ZegoVideoCodecID || (ZegoVideoCodecID = {}));
  336. /**
  337. * Player video layer.
  338. */
  339. export var ZegoPlayerVideoLayer;
  340. (function (ZegoPlayerVideoLayer) {
  341. /**
  342. * The layer to be played depends on the network status
  343. */
  344. ZegoPlayerVideoLayer[ZegoPlayerVideoLayer["Auto"] = 0] = "Auto";
  345. /**
  346. * Play the base layer (small resolution)
  347. */
  348. ZegoPlayerVideoLayer[ZegoPlayerVideoLayer["Base"] = 1] = "Base";
  349. /**
  350. * Play the extend layer (big resolution)
  351. */
  352. ZegoPlayerVideoLayer[ZegoPlayerVideoLayer["BaseExtend"] = 2] = "BaseExtend";
  353. })(ZegoPlayerVideoLayer || (ZegoPlayerVideoLayer = {}));
  354. /**
  355. * Video stream type
  356. */
  357. export var ZegoVideoStreamType;
  358. (function (ZegoVideoStreamType) {
  359. /**
  360. * The type to be played depends on the network status
  361. */
  362. ZegoVideoStreamType[ZegoVideoStreamType["Default"] = 0] = "Default";
  363. /**
  364. * small resolution type
  365. */
  366. ZegoVideoStreamType[ZegoVideoStreamType["Small"] = 1] = "Small";
  367. /**
  368. * big resolution type
  369. */
  370. ZegoVideoStreamType[ZegoVideoStreamType["Big"] = 2] = "Big";
  371. })(ZegoVideoStreamType || (ZegoVideoStreamType = {}));
  372. /// Audio echo cancellation mode.
  373. export var ZegoAECMode;
  374. (function (ZegoAECMode) {
  375. /// Aggressive echo cancellation may affect the sound quality slightly, but the echo will be very clean
  376. ZegoAECMode[ZegoAECMode["Aggressive"] = 0] = "Aggressive";
  377. /// Moderate echo cancellation, which may slightly affect a little bit of sound, but the residual echo will be less
  378. ZegoAECMode[ZegoAECMode["Medium"] = 1] = "Medium";
  379. /// Comfortable echo cancellation, that is, echo cancellation does not affect the sound quality of the sound, and sometimes there may be a little echo, but it will not affect the normal listening.
  380. ZegoAECMode[ZegoAECMode["Soft"] = 2] = "Soft";
  381. })(ZegoAECMode || (ZegoAECMode = {}));
  382. /// Active Noise Suppression mode.
  383. export var ZegoANSMode;
  384. (function (ZegoANSMode) {
  385. /// Soft ANS
  386. ZegoANSMode[ZegoANSMode["Soft"] = 0] = "Soft";
  387. /// Medium ANS
  388. ZegoANSMode[ZegoANSMode["Medium"] = 1] = "Medium";
  389. /// Aggressive ANS
  390. ZegoANSMode[ZegoANSMode["Aggressive"] = 2] = "Aggressive";
  391. })(ZegoANSMode || (ZegoANSMode = {}));
  392. /**
  393. * Traffic control property (bitmask enumeration).
  394. */
  395. export var ZegoTrafficControlProperty;
  396. (function (ZegoTrafficControlProperty) {
  397. /**
  398. * Basic
  399. */
  400. ZegoTrafficControlProperty[ZegoTrafficControlProperty["Basic"] = 0] = "Basic";
  401. /**
  402. * Adaptive FPS
  403. */
  404. ZegoTrafficControlProperty[ZegoTrafficControlProperty["AdaptiveFPS"] = 1] = "AdaptiveFPS";
  405. /**
  406. * Adaptive resolution
  407. */
  408. ZegoTrafficControlProperty[ZegoTrafficControlProperty["AdaptiveResolution"] = 2] = "AdaptiveResolution";
  409. /**
  410. * Adaptive Audio bitrate
  411. */
  412. ZegoTrafficControlProperty[ZegoTrafficControlProperty["AdaptiveAudioBitrate"] = 4] = "AdaptiveAudioBitrate";
  413. })(ZegoTrafficControlProperty || (ZegoTrafficControlProperty = {}));
  414. /**
  415. * Video transmission mode when current bitrate is lower than the set minimum bitrate.
  416. */
  417. export var ZegoTrafficControlMinVideoBitrateMode;
  418. (function (ZegoTrafficControlMinVideoBitrateMode) {
  419. /**
  420. * Stop video transmission when current bitrate is lower than the set minimum bitrate
  421. */
  422. ZegoTrafficControlMinVideoBitrateMode[ZegoTrafficControlMinVideoBitrateMode["NoVideo"] = 0] = "NoVideo";
  423. /**
  424. * Video is sent at a very low frequency (no more than 2fps) which is lower than the set minimum bitrate
  425. */
  426. ZegoTrafficControlMinVideoBitrateMode[ZegoTrafficControlMinVideoBitrateMode["UltraLowFPS"] = 1] = "UltraLowFPS";
  427. })(ZegoTrafficControlMinVideoBitrateMode || (ZegoTrafficControlMinVideoBitrateMode = {}));
  428. /**
  429. * Factors that trigger traffic control
  430. */
  431. export var ZegoTrafficControlFocusOnMode;
  432. (function (ZegoTrafficControlFocusOnMode) {
  433. /**
  434. * Focus only on the local network
  435. */
  436. ZegoTrafficControlFocusOnMode[ZegoTrafficControlFocusOnMode["LocalOnly"] = 0] = "LocalOnly";
  437. /**
  438. * Pay attention to the local network, but also take into account the remote network, currently only effective in the 1v1 scenario
  439. */
  440. ZegoTrafficControlFocusOnMode[ZegoTrafficControlFocusOnMode["Remote"] = 1] = "Remote";
  441. })(ZegoTrafficControlFocusOnMode || (ZegoTrafficControlFocusOnMode = {}));
  442. /**
  443. * Playing stream status.
  444. */
  445. export var ZegoPlayerState;
  446. (function (ZegoPlayerState) {
  447. /**
  448. * The state of the flow is not played, and it is in this state before the stream is played. If the steady flow anomaly occurs during the playing process, such as AppID and AppSign are incorrect, it will enter this state.
  449. */
  450. ZegoPlayerState[ZegoPlayerState["NoPlay"] = 0] = "NoPlay";
  451. /**
  452. * The state that the stream is being requested for playing. After the [startPlayingStream] function is successfully called, it will enter the state. The UI is usually displayed through this state. If the connection is interrupted due to poor network quality, the SDK will perform an internal retry and will return to the requesting state.
  453. */
  454. ZegoPlayerState[ZegoPlayerState["PlayRequesting"] = 1] = "PlayRequesting";
  455. /**
  456. * The state that the stream is being playing, entering the state indicates that the stream has been successfully played, and the user can communicate normally.
  457. */
  458. ZegoPlayerState[ZegoPlayerState["Playing"] = 2] = "Playing";
  459. })(ZegoPlayerState || (ZegoPlayerState = {}));
  460. /**
  461. * Media event when playing.
  462. */
  463. export var ZegoPlayerMediaEvent;
  464. (function (ZegoPlayerMediaEvent) {
  465. /**
  466. * Audio stuck event when playing
  467. */
  468. ZegoPlayerMediaEvent[ZegoPlayerMediaEvent["AudioBreakOccur"] = 0] = "AudioBreakOccur";
  469. /**
  470. * Audio stuck event recovery when playing
  471. */
  472. ZegoPlayerMediaEvent[ZegoPlayerMediaEvent["AudioBreakResume"] = 1] = "AudioBreakResume";
  473. /**
  474. * Video stuck event when playing
  475. */
  476. ZegoPlayerMediaEvent[ZegoPlayerMediaEvent["VideoBreakOccur"] = 2] = "VideoBreakOccur";
  477. /**
  478. * Video stuck event recovery when playing
  479. */
  480. ZegoPlayerMediaEvent[ZegoPlayerMediaEvent["VideoBreakResume"] = 3] = "VideoBreakResume";
  481. })(ZegoPlayerMediaEvent || (ZegoPlayerMediaEvent = {}));
  482. /**
  483. * Stream Resource Mode
  484. */
  485. export var ZegoStreamResourceMode;
  486. (function (ZegoStreamResourceMode) {
  487. /**
  488. * Default mode. The SDK will automatically select the streaming resource according to the cdnConfig parameters set by the player config and the ready-made background configuration.
  489. */
  490. ZegoStreamResourceMode[ZegoStreamResourceMode["Default"] = 0] = "Default";
  491. /**
  492. * Playing stream only from CDN.
  493. */
  494. ZegoStreamResourceMode[ZegoStreamResourceMode["OnlyCDN"] = 1] = "OnlyCDN";
  495. /**
  496. * Playing stream only from L3.
  497. */
  498. ZegoStreamResourceMode[ZegoStreamResourceMode["OnlyL3"] = 2] = "OnlyL3";
  499. /**
  500. * Playing stream only from RTC.
  501. */
  502. ZegoStreamResourceMode[ZegoStreamResourceMode["OnlyRTC"] = 3] = "OnlyRTC";
  503. })(ZegoStreamResourceMode || (ZegoStreamResourceMode = {}));
  504. /**
  505. * Update type.
  506. */
  507. export var ZegoUpdateType;
  508. (function (ZegoUpdateType) {
  509. /**
  510. * Add
  511. */
  512. ZegoUpdateType[ZegoUpdateType["Add"] = 0] = "Add";
  513. /**
  514. * Delete
  515. */
  516. ZegoUpdateType[ZegoUpdateType["Delete"] = 1] = "Delete";
  517. })(ZegoUpdateType || (ZegoUpdateType = {}));
  518. /// State of CDN relay.
  519. export var ZegoStreamRelayCDNState;
  520. (function (ZegoStreamRelayCDNState) {
  521. /// The state indicates that there is no CDN relay
  522. ZegoStreamRelayCDNState[ZegoStreamRelayCDNState["NoRelay"] = 0] = "NoRelay";
  523. /// The CDN relay is being requested
  524. ZegoStreamRelayCDNState[ZegoStreamRelayCDNState["RelayRequesting"] = 1] = "RelayRequesting";
  525. /// Entering this status indicates that the CDN relay has been successful
  526. ZegoStreamRelayCDNState[ZegoStreamRelayCDNState["Relaying"] = 2] = "Relaying";
  527. })(ZegoStreamRelayCDNState || (ZegoStreamRelayCDNState = {}));
  528. /// Reason for state of CDN relay changed.
  529. export var ZegoStreamRelayCDNUpdateReason;
  530. (function (ZegoStreamRelayCDNUpdateReason) {
  531. /// No error
  532. ZegoStreamRelayCDNUpdateReason[ZegoStreamRelayCDNUpdateReason["None"] = 0] = "None";
  533. /// Server error
  534. ZegoStreamRelayCDNUpdateReason[ZegoStreamRelayCDNUpdateReason["ServerError"] = 1] = "ServerError";
  535. /// Handshake error
  536. ZegoStreamRelayCDNUpdateReason[ZegoStreamRelayCDNUpdateReason["HandshakeFailed"] = 2] = "HandshakeFailed";
  537. /// Access point error
  538. ZegoStreamRelayCDNUpdateReason[ZegoStreamRelayCDNUpdateReason["AccessPointError"] = 3] = "AccessPointError";
  539. /// Stream create failure
  540. ZegoStreamRelayCDNUpdateReason[ZegoStreamRelayCDNUpdateReason["CreateStreamFailed"] = 4] = "CreateStreamFailed";
  541. /// Bad name
  542. ZegoStreamRelayCDNUpdateReason[ZegoStreamRelayCDNUpdateReason["BadName"] = 5] = "BadName";
  543. /// CDN server actively disconnected
  544. ZegoStreamRelayCDNUpdateReason[ZegoStreamRelayCDNUpdateReason["CDNServerDisconnected"] = 6] = "CDNServerDisconnected";
  545. /// Active disconnect
  546. ZegoStreamRelayCDNUpdateReason[ZegoStreamRelayCDNUpdateReason["Disconnected"] = 7] = "Disconnected";
  547. /// All mixer input streams sessions closed
  548. ZegoStreamRelayCDNUpdateReason[ZegoStreamRelayCDNUpdateReason["MixStreamAllInputStreamClosed"] = 8] = "MixStreamAllInputStreamClosed";
  549. /// All mixer input streams have no data
  550. ZegoStreamRelayCDNUpdateReason[ZegoStreamRelayCDNUpdateReason["MixStreamAllInputStreamNoData"] = 9] = "MixStreamAllInputStreamNoData";
  551. /// Internal error of stream mixer server
  552. ZegoStreamRelayCDNUpdateReason[ZegoStreamRelayCDNUpdateReason["MixStreamServerInternalError"] = 10] = "MixStreamServerInternalError";
  553. })(ZegoStreamRelayCDNUpdateReason || (ZegoStreamRelayCDNUpdateReason = {}));
  554. /// Audio device type.
  555. export var ZegoAudioDeviceType;
  556. (function (ZegoAudioDeviceType) {
  557. /// Audio input type
  558. ZegoAudioDeviceType[ZegoAudioDeviceType["Input"] = 0] = "Input";
  559. /// Audio output type
  560. ZegoAudioDeviceType[ZegoAudioDeviceType["Output"] = 1] = "Output";
  561. })(ZegoAudioDeviceType || (ZegoAudioDeviceType = {}));
  562. /** Audio route */
  563. export var ZegoAudioRoute;
  564. (function (ZegoAudioRoute) {
  565. /** Speaker */
  566. ZegoAudioRoute[ZegoAudioRoute["Speaker"] = 0] = "Speaker";
  567. /** Headphone */
  568. ZegoAudioRoute[ZegoAudioRoute["Headphone"] = 1] = "Headphone";
  569. /** Bluetooth device */
  570. ZegoAudioRoute[ZegoAudioRoute["Bluetooth"] = 2] = "Bluetooth";
  571. /** Receiver */
  572. ZegoAudioRoute[ZegoAudioRoute["Receiver"] = 3] = "Receiver";
  573. /** External USB audio device */
  574. ZegoAudioRoute[ZegoAudioRoute["ExternalUSB"] = 4] = "ExternalUSB";
  575. /** Apple AirPlay */
  576. ZegoAudioRoute[ZegoAudioRoute["AirPlay"] = 5] = "AirPlay";
  577. })(ZegoAudioRoute || (ZegoAudioRoute = {}));
  578. /// Mix stream content type.
  579. export var ZegoMixerInputContentType;
  580. (function (ZegoMixerInputContentType) {
  581. /// Mix stream for audio only
  582. ZegoMixerInputContentType[ZegoMixerInputContentType["Audio"] = 0] = "Audio";
  583. /// Mix stream for both audio and video
  584. ZegoMixerInputContentType[ZegoMixerInputContentType["Video"] = 1] = "Video";
  585. })(ZegoMixerInputContentType || (ZegoMixerInputContentType = {}));
  586. /// Capture pipeline scale mode.
  587. export var ZegoCapturePipelineScaleMode;
  588. (function (ZegoCapturePipelineScaleMode) {
  589. /// Zoom immediately after acquisition, default
  590. ZegoCapturePipelineScaleMode[ZegoCapturePipelineScaleMode["Pre"] = 0] = "Pre";
  591. /// Scaling while encoding
  592. ZegoCapturePipelineScaleMode[ZegoCapturePipelineScaleMode["Post"] = 1] = "Post";
  593. })(ZegoCapturePipelineScaleMode || (ZegoCapturePipelineScaleMode = {}));
  594. /// Video frame format.
  595. export var ZegoVideoFrameFormat;
  596. (function (ZegoVideoFrameFormat) {
  597. /// Unknown format, will take platform default
  598. ZegoVideoFrameFormat[ZegoVideoFrameFormat["Unknown"] = 0] = "Unknown";
  599. /// I420 (YUV420Planar) format
  600. ZegoVideoFrameFormat[ZegoVideoFrameFormat["I420"] = 1] = "I420";
  601. /// NV12 (YUV420SemiPlanar) format
  602. ZegoVideoFrameFormat[ZegoVideoFrameFormat["NV12"] = 2] = "NV12";
  603. /// NV21 (YUV420SemiPlanar) format
  604. ZegoVideoFrameFormat[ZegoVideoFrameFormat["NV21"] = 3] = "NV21";
  605. /// BGRA32 format
  606. ZegoVideoFrameFormat[ZegoVideoFrameFormat["BGRA32"] = 4] = "BGRA32";
  607. /// RGBA32 format
  608. ZegoVideoFrameFormat[ZegoVideoFrameFormat["RGBA32"] = 5] = "RGBA32";
  609. /// ARGB32 format
  610. ZegoVideoFrameFormat[ZegoVideoFrameFormat["ARGB32"] = 6] = "ARGB32";
  611. /// ABGR32 format
  612. ZegoVideoFrameFormat[ZegoVideoFrameFormat["ABGR32"] = 7] = "ABGR32";
  613. /// I422 (YUV422Planar) format
  614. ZegoVideoFrameFormat[ZegoVideoFrameFormat["I422"] = 8] = "I422";
  615. })(ZegoVideoFrameFormat || (ZegoVideoFrameFormat = {}));
  616. /// Video encoded frame format.
  617. export var ZegoVideoEncodedFrameFormat;
  618. (function (ZegoVideoEncodedFrameFormat) {
  619. /// AVC AVCC format
  620. ZegoVideoEncodedFrameFormat[ZegoVideoEncodedFrameFormat["AVCC"] = 0] = "AVCC";
  621. /// AVC Annex-B format
  622. ZegoVideoEncodedFrameFormat[ZegoVideoEncodedFrameFormat["AnnexB"] = 1] = "AnnexB";
  623. })(ZegoVideoEncodedFrameFormat || (ZegoVideoEncodedFrameFormat = {}));
  624. /// Video frame buffer type.
  625. export var ZegoVideoBufferType;
  626. (function (ZegoVideoBufferType) {
  627. /// Raw data type video frame
  628. ZegoVideoBufferType[ZegoVideoBufferType["Unknown"] = 0] = "Unknown";
  629. /// Raw data type video frame
  630. ZegoVideoBufferType[ZegoVideoBufferType["RawData"] = 1] = "RawData";
  631. /// Encoded data type video frame
  632. ZegoVideoBufferType[ZegoVideoBufferType["EncodedData"] = 2] = "EncodedData";
  633. /// Texture 2D type video frame
  634. ZegoVideoBufferType[ZegoVideoBufferType["GLTexture2D"] = 3] = "GLTexture2D";
  635. /// CVPixelBuffer type video frame
  636. ZegoVideoBufferType[ZegoVideoBufferType["CVPixelBuffer"] = 4] = "CVPixelBuffer";
  637. })(ZegoVideoBufferType || (ZegoVideoBufferType = {}));
  638. /// Video frame format series.
  639. export var ZegoVideoFrameFormatSeries;
  640. (function (ZegoVideoFrameFormatSeries) {
  641. /// RGB series
  642. ZegoVideoFrameFormatSeries[ZegoVideoFrameFormatSeries["RGB"] = 0] = "RGB";
  643. /// YUV series
  644. ZegoVideoFrameFormatSeries[ZegoVideoFrameFormatSeries["YUV"] = 1] = "YUV";
  645. })(ZegoVideoFrameFormatSeries || (ZegoVideoFrameFormatSeries = {}));
  646. /// Video frame flip mode.
  647. export var ZegoVideoFlipMode;
  648. (function (ZegoVideoFlipMode) {
  649. /// No flip
  650. ZegoVideoFlipMode[ZegoVideoFlipMode["None"] = 0] = "None";
  651. /// X-axis flip
  652. ZegoVideoFlipMode[ZegoVideoFlipMode["X"] = 1] = "X";
  653. /// Y-axis flip
  654. ZegoVideoFlipMode[ZegoVideoFlipMode["Y"] = 2] = "Y";
  655. /// X-Y-axis flip
  656. ZegoVideoFlipMode[ZegoVideoFlipMode["XY"] = 3] = "XY";
  657. })(ZegoVideoFlipMode || (ZegoVideoFlipMode = {}));
  658. /// Customize the audio processing configuration type.
  659. export var ZegoCustomAudioProcessType;
  660. (function (ZegoCustomAudioProcessType) {
  661. /// Remote audio processing
  662. ZegoCustomAudioProcessType[ZegoCustomAudioProcessType["Remote"] = 0] = "Remote";
  663. /// Capture audio processing
  664. ZegoCustomAudioProcessType[ZegoCustomAudioProcessType["Capture"] = 1] = "Capture";
  665. /// Remote audio and capture audio processing
  666. ZegoCustomAudioProcessType[ZegoCustomAudioProcessType["CaptureAndRemote"] = 2] = "CaptureAndRemote";
  667. })(ZegoCustomAudioProcessType || (ZegoCustomAudioProcessType = {}));
  668. /// Audio Config Preset.
  669. export var ZegoAudioConfigPreset;
  670. (function (ZegoAudioConfigPreset) {
  671. /// Basic sound quality (16 kbps, Mono, ZegoAudioCodecIDDefault)
  672. ZegoAudioConfigPreset[ZegoAudioConfigPreset["BasicQuality"] = 0] = "BasicQuality";
  673. /// Standard sound quality (48 kbps, Mono, ZegoAudioCodecIDDefault)
  674. ZegoAudioConfigPreset[ZegoAudioConfigPreset["StandardQuality"] = 1] = "StandardQuality";
  675. /// Standard sound quality (56 kbps, Stereo, ZegoAudioCodecIDDefault)
  676. ZegoAudioConfigPreset[ZegoAudioConfigPreset["StandardQualityStereo"] = 2] = "StandardQualityStereo";
  677. /// High sound quality (128 kbps, Mono, ZegoAudioCodecIDDefault)
  678. ZegoAudioConfigPreset[ZegoAudioConfigPreset["HighQuality"] = 3] = "HighQuality";
  679. /// High sound quality (192 kbps, Stereo, ZegoAudioCodecIDDefault)
  680. ZegoAudioConfigPreset[ZegoAudioConfigPreset["HighQualityStereo"] = 4] = "HighQualityStereo";
  681. })(ZegoAudioConfigPreset || (ZegoAudioConfigPreset = {}));
  682. /**
  683. * Player state.
  684. */
  685. export var ZegoMediaPlayerState;
  686. (function (ZegoMediaPlayerState) {
  687. /**
  688. * Not playing
  689. */
  690. ZegoMediaPlayerState[ZegoMediaPlayerState["NoPlay"] = 0] = "NoPlay";
  691. /**
  692. * Playing
  693. */
  694. ZegoMediaPlayerState[ZegoMediaPlayerState["Playing"] = 1] = "Playing";
  695. /**
  696. * Pausing
  697. */
  698. ZegoMediaPlayerState[ZegoMediaPlayerState["Pausing"] = 2] = "Pausing";
  699. /**
  700. * End of play
  701. */
  702. ZegoMediaPlayerState[ZegoMediaPlayerState["PlayEnded"] = 3] = "PlayEnded";
  703. })(ZegoMediaPlayerState || (ZegoMediaPlayerState = {}));
  704. /**
  705. * Player network event.
  706. */
  707. export var ZegoMediaPlayerNetworkEvent;
  708. (function (ZegoMediaPlayerNetworkEvent) {
  709. /**
  710. * Network resources are not playing well, and start trying to cache data
  711. */
  712. ZegoMediaPlayerNetworkEvent[ZegoMediaPlayerNetworkEvent["BufferBegin"] = 0] = "BufferBegin";
  713. /**
  714. * Network resources can be played smoothly
  715. */
  716. ZegoMediaPlayerNetworkEvent[ZegoMediaPlayerNetworkEvent["BufferEnded"] = 1] = "BufferEnded";
  717. })(ZegoMediaPlayerNetworkEvent || (ZegoMediaPlayerNetworkEvent = {}));
  718. /**
  719. * Audio channel.
  720. */
  721. export var ZegoMediaPlayerAudioChannel;
  722. (function (ZegoMediaPlayerAudioChannel) {
  723. /**
  724. * Audio channel left
  725. */
  726. ZegoMediaPlayerAudioChannel[ZegoMediaPlayerAudioChannel["Left"] = 0] = "Left";
  727. /**
  728. * Audio channel right
  729. */
  730. ZegoMediaPlayerAudioChannel[ZegoMediaPlayerAudioChannel["Right"] = 1] = "Right";
  731. /**
  732. * Audio channel all
  733. */
  734. ZegoMediaPlayerAudioChannel[ZegoMediaPlayerAudioChannel["All"] = 2] = "All";
  735. })(ZegoMediaPlayerAudioChannel || (ZegoMediaPlayerAudioChannel = {}));
  736. /// AudioEffectPlayer state.
  737. export var ZegoAudioEffectPlayState;
  738. (function (ZegoAudioEffectPlayState) {
  739. /// Not playing
  740. ZegoAudioEffectPlayState[ZegoAudioEffectPlayState["NoPlay"] = 0] = "NoPlay";
  741. /// Playing
  742. ZegoAudioEffectPlayState[ZegoAudioEffectPlayState["Playing"] = 1] = "Playing";
  743. /// Pausing
  744. ZegoAudioEffectPlayState[ZegoAudioEffectPlayState["Pausing"] = 2] = "Pausing";
  745. /// End of play
  746. ZegoAudioEffectPlayState[ZegoAudioEffectPlayState["PlayEnded"] = 3] = "PlayEnded";
  747. })(ZegoAudioEffectPlayState || (ZegoAudioEffectPlayState = {}));
  748. /// volume type.
  749. export var ZegoVolumeType;
  750. (function (ZegoVolumeType) {
  751. /// volume local
  752. ZegoVolumeType[ZegoVolumeType["Local"] = 0] = "Local";
  753. /// volume remote
  754. ZegoVolumeType[ZegoVolumeType["Remote"] = 1] = "Remote";
  755. })(ZegoVolumeType || (ZegoVolumeType = {}));
  756. /// audio sample rate.
  757. export var ZegoAudioSampleRate;
  758. (function (ZegoAudioSampleRate) {
  759. /// Unknown
  760. ZegoAudioSampleRate[ZegoAudioSampleRate["Unknown"] = 0] = "Unknown";
  761. /// 8K
  762. ZegoAudioSampleRate[ZegoAudioSampleRate["Rate8K"] = 8000] = "Rate8K";
  763. /// 16K
  764. ZegoAudioSampleRate[ZegoAudioSampleRate["Rate16K"] = 16000] = "Rate16K";
  765. /// 22.05K
  766. ZegoAudioSampleRate[ZegoAudioSampleRate["Rate22K"] = 22050] = "Rate22K";
  767. /// 24K
  768. ZegoAudioSampleRate[ZegoAudioSampleRate["Rate24K"] = 24000] = "Rate24K";
  769. /// 32K
  770. ZegoAudioSampleRate[ZegoAudioSampleRate["Rate32K"] = 32000] = "Rate32K";
  771. /// 44.1K
  772. ZegoAudioSampleRate[ZegoAudioSampleRate["Rate44K"] = 44100] = "Rate44K";
  773. /// 48K
  774. ZegoAudioSampleRate[ZegoAudioSampleRate["Rate48K"] = 48000] = "Rate48K";
  775. })(ZegoAudioSampleRate || (ZegoAudioSampleRate = {}));
  776. /// Audio capture source type.
  777. export var ZegoAudioSourceType;
  778. (function (ZegoAudioSourceType) {
  779. /// Default audio capture source (the main channel uses custom audio capture by default the aux channel uses the same sound as main channel by default)
  780. ZegoAudioSourceType[ZegoAudioSourceType["Default"] = 0] = "Default";
  781. /// Use custom audio capture, refer to [enableCustomAudioIO]
  782. ZegoAudioSourceType[ZegoAudioSourceType["Custom"] = 1] = "Custom";
  783. /// Use media player as audio source, only support aux channel
  784. ZegoAudioSourceType[ZegoAudioSourceType["MediaPlayer"] = 2] = "MediaPlayer";
  785. })(ZegoAudioSourceType || (ZegoAudioSourceType = {}));
  786. /// Record type.
  787. export var ZegoDataRecordType;
  788. (function (ZegoDataRecordType) {
  789. /// This field indicates that the Express-Audio SDK records audio by default, and the Express-Video SDK records audio and video by default. When recording files in .aac format, audio is also recorded by default.
  790. ZegoDataRecordType[ZegoDataRecordType["Default"] = 0] = "Default";
  791. /// only record audio
  792. ZegoDataRecordType[ZegoDataRecordType["OnlyAudio"] = 1] = "OnlyAudio";
  793. /// only record video, Audio SDK and recording .aac format files are invalid.
  794. ZegoDataRecordType[ZegoDataRecordType["OnlyVideo"] = 2] = "OnlyVideo";
  795. /// record audio and video. Express-Audio SDK and .aac format files are recorded only audio.
  796. ZegoDataRecordType[ZegoDataRecordType["AudioAndVideo"] = 3] = "AudioAndVideo";
  797. })(ZegoDataRecordType || (ZegoDataRecordType = {}));
  798. /// Record state.
  799. export var ZegoDataRecordState;
  800. (function (ZegoDataRecordState) {
  801. /// Unrecorded state, which is the state when a recording error occurs or before recording starts.
  802. ZegoDataRecordState[ZegoDataRecordState["NoRecord"] = 0] = "NoRecord";
  803. /// Recording in progress, in this state after successfully call [startRecordingCapturedData] function
  804. ZegoDataRecordState[ZegoDataRecordState["Recording"] = 1] = "Recording";
  805. /// Record successs
  806. ZegoDataRecordState[ZegoDataRecordState["Success"] = 2] = "Success";
  807. })(ZegoDataRecordState || (ZegoDataRecordState = {}));
  808. /// Audio data callback function enable bitmask enumeration.
  809. export var ZegoAudioDataCallbackBitMask;
  810. (function (ZegoAudioDataCallbackBitMask) {
  811. /// The mask bit of this field corresponds to the enable [onCapturedAudioData] callback function
  812. ZegoAudioDataCallbackBitMask[ZegoAudioDataCallbackBitMask["Captured"] = 1] = "Captured";
  813. /// The mask bit of this field corresponds to the enable [onPlaybackAudioData] callback function
  814. ZegoAudioDataCallbackBitMask[ZegoAudioDataCallbackBitMask["Playback"] = 2] = "Playback";
  815. /// The mask bit of this field corresponds to the enable [onMixedAudioData] callback function
  816. ZegoAudioDataCallbackBitMask[ZegoAudioDataCallbackBitMask["Mixed"] = 4] = "Mixed";
  817. /// The mask bit of this field corresponds to the enable [onPlayerAudioData] callback function
  818. ZegoAudioDataCallbackBitMask[ZegoAudioDataCallbackBitMask["Player"] = 8] = "Player";
  819. })(ZegoAudioDataCallbackBitMask || (ZegoAudioDataCallbackBitMask = {}));
  820. /// Network mode
  821. export var ZegoNetworkMode;
  822. (function (ZegoNetworkMode) {
  823. /// Offline (No network)
  824. ZegoNetworkMode[ZegoNetworkMode["Offline"] = 0] = "Offline";
  825. /// Unknown network mode
  826. ZegoNetworkMode[ZegoNetworkMode["Unknown"] = 1] = "Unknown";
  827. /// Wired Ethernet (LAN)
  828. ZegoNetworkMode[ZegoNetworkMode["Ethernet"] = 2] = "Ethernet";
  829. /// Wi-Fi (WLAN)
  830. ZegoNetworkMode[ZegoNetworkMode["WiFi"] = 3] = "WiFi";
  831. /// 2G Network (GPRS/EDGE/CDMA1x/etc.)
  832. ZegoNetworkMode[ZegoNetworkMode["Mode2G"] = 4] = "Mode2G";
  833. /// 3G Network (WCDMA/HSDPA/EVDO/etc.)
  834. ZegoNetworkMode[ZegoNetworkMode["Mode3G"] = 5] = "Mode3G";
  835. /// 4G Network (LTE)
  836. ZegoNetworkMode[ZegoNetworkMode["Mode4G"] = 6] = "Mode4G";
  837. /// 5G Network (NR (NSA/SA))
  838. ZegoNetworkMode[ZegoNetworkMode["Mode5G"] = 7] = "Mode5G";
  839. })(ZegoNetworkMode || (ZegoNetworkMode = {}));
  840. /// network speed test type
  841. export var ZegoNetworkSpeedTestType;
  842. (function (ZegoNetworkSpeedTestType) {
  843. /// uplink
  844. ZegoNetworkSpeedTestType[ZegoNetworkSpeedTestType["Uplink"] = 0] = "Uplink";
  845. /// downlink
  846. ZegoNetworkSpeedTestType[ZegoNetworkSpeedTestType["Downlink"] = 1] = "Downlink";
  847. })(ZegoNetworkSpeedTestType || (ZegoNetworkSpeedTestType = {}));
  848. /** The exception type for the device. */
  849. export var ZegoDeviceExceptionType;
  850. (function (ZegoDeviceExceptionType) {
  851. /** Unknown device exception. */
  852. ZegoDeviceExceptionType[ZegoDeviceExceptionType["Unknown"] = 0] = "Unknown";
  853. /** Generic device exception. */
  854. ZegoDeviceExceptionType[ZegoDeviceExceptionType["Generic"] = 1] = "Generic";
  855. /** Invalid device ID exception. */
  856. ZegoDeviceExceptionType[ZegoDeviceExceptionType["InvalidID"] = 2] = "InvalidID";
  857. /** Device permission is not granted. */
  858. ZegoDeviceExceptionType[ZegoDeviceExceptionType["PermissionNotGranted"] = 3] = "PermissionNotGranted";
  859. /** The capture frame rate of the device is 0. */
  860. ZegoDeviceExceptionType[ZegoDeviceExceptionType["ZeroCaptureFPS"] = 4] = "ZeroCaptureFPS";
  861. /** The device is being occupied. */
  862. ZegoDeviceExceptionType[ZegoDeviceExceptionType["DeviceOccupied"] = 5] = "DeviceOccupied";
  863. /** The device is unplugged (not plugged in). */
  864. ZegoDeviceExceptionType[ZegoDeviceExceptionType["DeviceUnplugged"] = 6] = "DeviceUnplugged";
  865. /** The device requires the system to restart before it can work (Windows platform only). */
  866. ZegoDeviceExceptionType[ZegoDeviceExceptionType["RebootRequired"] = 7] = "RebootRequired";
  867. /** The system media service is unavailable, e.g. when the iOS system detects that the current pressure is huge (such as playing a lot of animation), it is possible to disable all media related services (Apple platform only). */
  868. ZegoDeviceExceptionType[ZegoDeviceExceptionType["MediaServiceWereLost"] = 8] = "MediaServiceWereLost";
  869. /** The device is being occupied by Siri (Apple platform only). */
  870. ZegoDeviceExceptionType[ZegoDeviceExceptionType["SiriIsRecording"] = 9] = "SiriIsRecording";
  871. /** The device captured sound level is too low (Windows platform only). */
  872. ZegoDeviceExceptionType[ZegoDeviceExceptionType["SoundLevelTooLow"] = 10] = "SoundLevelTooLow";
  873. /** The device is being occupied, and maybe cause by iPad magnetic case (Apple platform only). */
  874. ZegoDeviceExceptionType[ZegoDeviceExceptionType["MagneticCase"] = 11] = "MagneticCase";
  875. })(ZegoDeviceExceptionType || (ZegoDeviceExceptionType = {}));
  876. /** Device type. */
  877. export var ZegoDeviceType;
  878. (function (ZegoDeviceType) {
  879. /** Unknown device type. */
  880. ZegoDeviceType[ZegoDeviceType["Unknown"] = 0] = "Unknown";
  881. /** Camera device. */
  882. ZegoDeviceType[ZegoDeviceType["Camera"] = 1] = "Camera";
  883. /** Microphone device. */
  884. ZegoDeviceType[ZegoDeviceType["Microphone"] = 2] = "Microphone";
  885. /** Speaker device. */
  886. ZegoDeviceType[ZegoDeviceType["Speaker"] = 3] = "Speaker";
  887. /** Audio device. (Other audio device that cannot be accurately classified into microphones or speakers.) */
  888. ZegoDeviceType[ZegoDeviceType["AudioDevice"] = 4] = "AudioDevice";
  889. })(ZegoDeviceType || (ZegoDeviceType = {}));
  890. /** Remote device status. */
  891. export var ZegoRemoteDeviceState;
  892. (function (ZegoRemoteDeviceState) {
  893. /** Device on */
  894. ZegoRemoteDeviceState[ZegoRemoteDeviceState["Open"] = 0] = "Open";
  895. /** General device error */
  896. ZegoRemoteDeviceState[ZegoRemoteDeviceState["GenericError"] = 1] = "GenericError";
  897. /** Invalid device ID */
  898. ZegoRemoteDeviceState[ZegoRemoteDeviceState["InvalidID"] = 2] = "InvalidID";
  899. /** No permission */
  900. ZegoRemoteDeviceState[ZegoRemoteDeviceState["NoAuthorization"] = 3] = "NoAuthorization";
  901. /** Captured frame rate is 0 */
  902. ZegoRemoteDeviceState[ZegoRemoteDeviceState["ZeroFPS"] = 4] = "ZeroFPS";
  903. /** The device is occupied */
  904. ZegoRemoteDeviceState[ZegoRemoteDeviceState["InUseByOther"] = 5] = "InUseByOther";
  905. /** The device is not plugged in or unplugged */
  906. ZegoRemoteDeviceState[ZegoRemoteDeviceState["Unplugged"] = 6] = "Unplugged";
  907. /** The system needs to be restarted */
  908. ZegoRemoteDeviceState[ZegoRemoteDeviceState["RebootRequired"] = 7] = "RebootRequired";
  909. /** System media services stop, such as under the iOS platform, when the system detects that the current pressure is huge (such as playing a lot of animation), it is possible to disable all media related services. */
  910. ZegoRemoteDeviceState[ZegoRemoteDeviceState["SystemMediaServicesLost"] = 8] = "SystemMediaServicesLost";
  911. /** Capturing disabled */
  912. ZegoRemoteDeviceState[ZegoRemoteDeviceState["Disable"] = 9] = "Disable";
  913. /** The remote device is muted */
  914. ZegoRemoteDeviceState[ZegoRemoteDeviceState["Mute"] = 10] = "Mute";
  915. /** The device is interrupted, such as a phone call interruption, etc. */
  916. ZegoRemoteDeviceState[ZegoRemoteDeviceState["Interruption"] = 11] = "Interruption";
  917. /** There are multiple apps at the same time in the foreground, such as the iPad app split screen, the system will prohibit all apps from using the camera. */
  918. ZegoRemoteDeviceState[ZegoRemoteDeviceState["InBackground"] = 12] = "InBackground";
  919. /** CDN server actively disconnected */
  920. ZegoRemoteDeviceState[ZegoRemoteDeviceState["MultiForegroundApp"] = 13] = "MultiForegroundApp";
  921. /** The system is under high load pressure and may cause abnormal equipment. */
  922. ZegoRemoteDeviceState[ZegoRemoteDeviceState["BySystemPressure"] = 14] = "BySystemPressure";
  923. /** The remote device is not supported to publish the device state. */
  924. ZegoRemoteDeviceState[ZegoRemoteDeviceState["NotSupport"] = 15] = "NotSupport";
  925. })(ZegoRemoteDeviceState || (ZegoRemoteDeviceState = {}));