1# NativeWindow 2 3 4提供NativeWindow功能，主要用来和egl对接。 5 6 7\@syscap SystemCapability.Graphic.Graphic2D.NativeWindow 8 9 10**起始版本：** 11 12 138 14 15 16## 汇总 17 18 19### 文件 20 21 | 文件名称 | 描述 | 22| -------- | -------- | 23| [external_window.h](external__window_8h.md) | 定义获取和使用NativeWindow的相关函数<br>引用文件：<native_window/external_window.h> | 24 25 26### 结构体 27 28 | 结构体名称 | 描述 | 29| -------- | -------- | 30| [Region](_region.md) | 表示本地窗口NativeWindow需要更新内容的矩形区域（脏区） | 31| [OHHDRMetaData](_o_h_h_d_r_meta_data.md) | HDR元数据结构体定义 | 32| [OHExtDataHandle](_o_h_ext_data_handle.md) | 扩展数据句柄结构体定义 | 33 34 35### 类型定义 36 37 | 类型定义名称 | 描述 | 38| -------- | -------- | 39| OHNativeWindow | 提供对NativeWindow的访问功能 | 40| OHNativeWindowBuffer | 提供对NativeWindow的访问功能 | 41| Region | 表示本地窗口NativeWindow需要更新内容的矩形区域（脏区） | 42 43 44### 枚举 45 46 | 枚举名称 | 描述 | 47| -------- | -------- | 48| [NativeWindowOperation](#nativewindowoperation) { SET_BUFFER_GEOMETRY, GET_BUFFER_GEOMETRY, GET_FORMAT, SET_FORMAT, GET_USAGE, SET_USAGE, SET_STRIDE, GET_STRIDE, SET_SWAP_INTERVAL, GET_SWAP_INTERVAL, SET_TIMEOUT, GET_TIMEOUT, SET_COLOR_GAMUT, GET_COLOR_GAMUT, SET_TRANSFORM, GET_TRANSFORM, SET_UI_TIMESTAMP } | OH_NativeWindow_NativeWindowHandleOpt函数中的操作码 | 49| [OHScalingMode](#ohscalingmode) { OH_SCALING_MODE_FREEZE = 0, OH_SCALING_MODE_SCALE_TO_WINDOW, OH_SCALING_MODE_SCALE_CROP, OH_SCALING_MODE_NO_SCALE_CROP } | 缩放模式 Scaling Mode | 50| [OHHDRMetadataKey](#ohhdrmetadatakey) { OH_METAKEY_RED_PRIMARY_X = 0, OH_METAKEY_RED_PRIMARY_Y = 1, OH_METAKEY_GREEN_PRIMARY_X = 2, OH_METAKEY_GREEN_PRIMARY_Y = 3, OH_METAKEY_BLUE_PRIMARY_X = 4, OH_METAKEY_BLUE_PRIMARY_Y = 5, OH_METAKEY_WHITE_PRIMARY_X = 6, OH_METAKEY_WHITE_PRIMARY_Y = 7, OH_METAKEY_MAX_LUMINANCE = 8, OH_METAKEY_MIN_LUMINANCE = 9, OH_METAKEY_MAX_CONTENT_LIGHT_LEVEL = 10, OH_METAKEY_MAX_FRAME_AVERAGE_LIGHT_LEVEL = 11, OH_METAKEY_HDR10_PLUS = 12, OH_METAKEY_HDR_VIVID = 13 } | 枚举HDR元数据关键字 | 51 52 53### 函数 54 55| 函数名称 | 描述 | 56| -------- | -------- | 57| [OH_NativeWindow_CreateNativeWindow](#oh_nativewindow_createnativewindow) (void \*pSurface) | 创建NativeWindow实例，每次调用都会产生一个新的NativeWindow实例 | 58| [OH_NativeWindow_DestroyNativeWindow](#oh_nativewindow_destroynativewindow) (OHNativeWindow \*window) | 将NativeWindow对象的引用计数减1，当引用计数为0的时候，该NativeWindow对象会被析构掉 | 59| [OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer](#oh_nativewindow_createnativewindowbufferfromsurfacebuffer) (void \*pSurfaceBuffer) | 创建NativeWindowBuffer实例，每次调用都会产生一个新的NativeWindowBuffer实例 | 60| [OH_NativeWindow_DestroyNativeWindowBuffer](#oh_nativewindow_destroynativewindowbuffer) (OHNativeWindowBuffer \*buffer) | 将NativeWindowBuffer对象的引用计数减1，当引用计数为0的时候，该NativeWindowBuffer对象会被析构掉 | 61| [OH_NativeWindow_NativeWindowRequestBuffer](#oh_nativewindow_nativewindowrequestbuffer) (OHNativeWindow \*window, OHNativeWindowBuffer \*\*buffer, int \*fenceFd) | 通过NativeWindow对象申请一块NativeWindowBuffer，用以内容生产 | 62| [OH_NativeWindow_NativeWindowFlushBuffer](#oh_nativewindow_nativewindowflushbuffer) (OHNativeWindow \*window, OHNativeWindowBuffer \*buffer, int fenceFd, [Region](_region.md) region) | 通过NativeWindow将生产好内容的NativeWindowBuffer放回到Buffer队列中，用以内容消费 | 63| [OH_NativeWindow_NativeWindowAbortBuffer](#oh_nativewindow_nativewindowabortbuffer) (OHNativeWindow \*window, OHNativeWindowBuffer \*buffer) | 通过NativeWindow将之前申请出来的NativeWindowBuffer返还到Buffer队列中，供下次再申请 | 64| [OH_NativeWindow_NativeWindowHandleOpt](#oh_nativewindow_nativewindowhandleopt) (OHNativeWindow \*window, int code,...) | 设置/获取NativeWindow的属性，包括设置/获取宽高、内容格式等 | 65| [OH_NativeWindow_GetBufferHandleFromNative](#oh_nativewindow_getbufferhandlefromnative) (OHNativeWindowBuffer \*buffer) | 通过NativeWindowBuffer获取该buffer的BufferHandle指针 | 66| [OH_NativeWindow_NativeObjectReference](#oh_nativewindow_nativeobjectreference) (void \*obj) | 增加一个NativeObject的引用计数 | 67| [OH_NativeWindow_NativeObjectUnreference](#oh_nativewindow_nativeobjectunreference) (void \*obj) | 减少一个NativeObject的引用计数，当引用计数减少为0时，该NativeObject将被析构掉 | 68| [OH_NativeWindow_GetNativeObjectMagic](#oh_nativewindow_getnativeobjectmagic) (void \*obj) | 获取NativeObject的MagicId | 69| [OH_NativeWindow_NativeWindowSetScalingMode](#oh_nativewindow_nativewindowsetscalingmode) (OHNativeWindow \*window, uint32_t sequence, [OHScalingMode](#ohscalingmode) scalingMode) | 设置NativeWindow的ScalingMode | 70| [OH_NativeWindow_NativeWindowSetMetaData](#oh_nativewindow_nativewindowsetmetadata) (OHNativeWindow \*window, uint32_t sequence, int32_t size, const [OHHDRMetaData](_o_h_h_d_r_meta_data.md) \*metaData) | 设置NativeWindow的元数据 | 71| [OH_NativeWindow_NativeWindowSetMetaDataSet](#oh_nativewindow_nativewindowsetmetadataset) (OHNativeWindow \*window, uint32_t sequence, [OHHDRMetadataKey](#ohhdrmetadatakey) key, int32_t size, const uint8_t \*metaData) | 设置NativeWindow的元数据集。 | 72| [OH_NativeWindow_NativeWindowSetTunnelHandle](#oh_nativewindow_nativewindowsettunnelhandle) (OHNativeWindow \*window, const [OHExtDataHandle](_o_h_ext_data_handle.md) \*handle) | 设置NativeWindow的TunnelHandle。 | 73 74 75## 详细描述 76 77 78## 枚举类型说明 79 80 81### NativeWindowOperation 82 83 84``` 85enum NativeWindowOperation 86``` 87 88**描述：** 89 90OH_NativeWindow_NativeWindowHandleOpt函数中的操作码 91 92 | 枚举值 | 说明 | 93| -------- | -------- | 94| SET_BUFFER_GEOMETRY | 设置本地窗口缓冲区几何图形， 函数中的可变参数是 [输入] int32_t height，[输入] int32_t width。 | 95| GET_BUFFER_GEOMETRY | 获取本地窗口缓冲区几何图形， 函数中的可变参数是 [输出] int32_t \*height， [输出] int32_t \*width。 | 96| GET_FORMAT | 获取本地窗口缓冲区格式， 函数中的可变参数是 [输出] int32_t \*format。 | 97| SET_FORMAT | 设置本地窗口缓冲区格式， 函数中的可变参数是 [输入] int32_t format。 | 98| GET_USAGE | 获取本地窗口缓冲区格式， 函数中的可变参数是 [输出] int32_t \*usage。 | 99| SET_USAGE | 设置本地窗口缓冲区使用方式， 函数中的可变参数是 [输入] int32_t usage。 | 100| SET_STRIDE | 设置本地窗口缓冲区步幅， 函数中的可变参数是 [输入] int32_t stride。 | 101| GET_STRIDE | 获取本地窗口缓冲区步幅， 函数中的可变参数是 [输出] int32_t \*stride。 | 102| SET_SWAP_INTERVAL | 设置本地窗口缓冲区交换间隔， 函数中的可变参数是 [输入] int32_t interval。 | 103| GET_SWAP_INTERVAL | 获取本地窗口缓冲区交换间隔， 函数中的可变参数是 [输出] int32_t \*interval。 | 104| SET_TIMEOUT | 设置请求本地窗口缓冲区的超时等待时间， 函数中的可变参数是 [输入] int32_t timeout。 | 105| GET_TIMEOUT | 获取请求本地窗口缓冲区的超时等待时间， 函数中的可变参数是 [输出] int32_t \*timeout。 | 106| SET_COLOR_GAMUT | 设置本地窗口缓冲区色彩空间， 函数中的可变参数是 [输入] int32_t colorGamut。 | 107| GET_COLOR_GAMUT | 获取本地窗口缓冲区色彩空间， 函数中的可变参数是 [out int32_t \*colorGamut]。 | 108| SET_TRANSFORM | 设置本地窗口缓冲区变换， 函数中的可变参数是 [输入] int32_t transform。 | 109| GET_TRANSFORM | 获取本地窗口缓冲区变换， 函数中的可变参数是 [输出] int32_t \*transform。 | 110| SET_UI_TIMESTAMP | 设置本地窗口缓冲区UI时间戳， 函数中的可变参数是 [输入] uint64_t uiTimestamp。 | 111 112 113### OHHDRMetadataKey 114 115 116``` 117enum OHHDRMetadataKey 118``` 119 120**描述：** 121 122枚举HDR元数据关键字 123 124 | 枚举值 | 描述 | 125| -------- | -------- | 126| OH_METAKEY_RED_PRIMARY_X | 红基色X坐标 | 127| OH_METAKEY_RED_PRIMARY_Y | 红基色Y坐标 | 128| OH_METAKEY_GREEN_PRIMARY_X | 绿基色X坐标 | 129| OH_METAKEY_GREEN_PRIMARY_Y | 绿基色Y坐标 | 130| OH_METAKEY_BLUE_PRIMARY_X | 蓝基色X坐标 | 131| OH_METAKEY_BLUE_PRIMARY_Y | 蓝基色Y坐标 | 132| OH_METAKEY_WHITE_PRIMARY_X | 白点X坐标 | 133| OH_METAKEY_WHITE_PRIMARY_Y | 白点Y坐标 | 134| OH_METAKEY_MAX_LUMINANCE | 最大的光亮度 | 135| OH_METAKEY_MIN_LUMINANCE | 最小的光亮度 | 136| OH_METAKEY_MAX_CONTENT_LIGHT_LEVEL | 最大的内容亮度水平 | 137| OH_METAKEY_MAX_FRAME_AVERAGE_LIGHT_LEVEL | 最大的帧平均亮度水平 | 138| OH_METAKEY_HDR10_PLUS | HDR10 Plus | 139| OH_METAKEY_HDR_VIVID | Vivid | 140 141 142### OHScalingMode 143 144 145``` 146enum OHScalingMode 147``` 148 149**描述：** 150 151缩放模式 Scaling Mode 152 153 | 枚举值 | 描述 | 154| -------- | -------- | 155| OH_SCALING_MODE_FREEZE | 在接收到窗口大小的缓冲区之前，不可以更新窗口内容 | 156| OH_SCALING_MODE_SCALE_TO_WINDOW | 缓冲区在二维中缩放以匹配窗口大小 | 157| OH_SCALING_MODE_SCALE_CROP | 缓冲区被统一缩放，使得缓冲区的较小尺寸与窗口大小匹配 | 158| OH_SCALING_MODE_NO_SCALE_CROP | 窗口被裁剪为缓冲区裁剪矩形的大小，裁剪矩形之外的像素被视为完全透明 | 159 160 161## 函数说明 162 163 164### OH_NativeWindow_CreateNativeWindow() 165 166 167``` 168OHNativeWindow* OH_NativeWindow_CreateNativeWindow (void * pSurface) 169``` 170 171**描述：** 172 173创建NativeWindow实例，每次调用都会产生一个新的NativeWindow实例 174 175\@syscap SystemCapability.Graphic.Graphic2D.NativeWindow 176 177**参数：** 178 179 | 名称 | 描述 | 180| -------- | -------- | 181| pSurface | 参数是一个指向生产者ProduceSurface的指针，类型为sptr<OHOS::Surface> | 182 183**返回：** 184 185返回一个指针，指向NativeWindow的结构体实例 186 187**起始版本：** 188 1898 190 191 192### OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer() 193 194 195``` 196OHNativeWindowBuffer* OH_NativeWindow_CreateNativeWindowBufferFromSurfaceBuffer (void * pSurfaceBuffer) 197``` 198 199**描述：** 200 201创建NativeWindowBuffer实例，每次调用都会产生一个新的NativeWindowBuffer实例 202 203\@syscap SystemCapability.Graphic.Graphic2D.NativeWindow 204 205**参数：** 206 207 | 名称 | 描述 | 208| -------- | -------- | 209| pSurfaceBuffer | 参数是一个指向生产者buffer的指针，类型为sptr<OHOS::SurfaceBuffer> | 210 211**返回：** 212 213返回一个指针，指向NativeWindowBuffer的结构体实例 214 215**起始版本：** 216 2178 218 219 220### OH_NativeWindow_DestroyNativeWindow() 221 222 223``` 224void OH_NativeWindow_DestroyNativeWindow (OHNativeWindow * window) 225``` 226 227**描述：** 228 229将NativeWindow对象的引用计数减1，当引用计数为0的时候，该NativeWindow对象会被析构掉 230 231\@syscap SystemCapability.Graphic.Graphic2D.NativeWindow 232 233**参数：** 234 235 | 名称 | 描述 | 236| -------- | -------- | 237| window | 参数是一个NativeWindow的结构体实例的指针 | 238 239**起始版本：** 240 2418 242 243 244### OH_NativeWindow_DestroyNativeWindowBuffer() 245 246 247``` 248void OH_NativeWindow_DestroyNativeWindowBuffer (OHNativeWindowBuffer * buffer) 249``` 250 251**描述：** 252 253将NativeWindowBuffer对象的引用计数减1，当引用计数为0的时候，该NativeWindowBuffer对象会被析构掉 254 255\@syscap SystemCapability.Graphic.Graphic2D.NativeWindow 256 257**参数：** 258 259 | 名称 | 描述 | 260| -------- | -------- | 261| buffer | 参数是一个NativeWindowBuffer的结构体实例的指针 | 262 263**起始版本：** 264 2658 266 267 268### OH_NativeWindow_GetBufferHandleFromNative() 269 270 271``` 272BufferHandle* OH_NativeWindow_GetBufferHandleFromNative (OHNativeWindowBuffer * buffer) 273``` 274 275**描述：** 276 277通过NativeWindowBuffer获取该buffer的BufferHandle指针 278 279\@syscap SystemCapability.Graphic.Graphic2D.NativeWindow 280 281**参数：** 282 283 | 名称 | 描述 | 284| -------- | -------- | 285| buffer | 参数是一个NativeWindowBuffer的结构体实例的指针 | 286 287**返回：** 288 289BufferHandle 返回一个指针，指向BufferHandle的结构体实例 290 291**起始版本：** 292 2938 294 295 296### OH_NativeWindow_GetNativeObjectMagic() 297 298 299``` 300int32_t OH_NativeWindow_GetNativeObjectMagic (void * obj) 301``` 302 303**描述：** 304 305获取NativeObject的MagicId 306 307\@syscap SystemCapability.Graphic.Graphic2D.NativeWindow 308 309**参数：** 310 311 | 名称 | 描述 | 312| -------- | -------- | 313| obj | 参数是一个NativeWindow or NativeWindowBuffer的结构体实例的指针 | 314 315**返回：** 316 317MagicId 返回值为魔鬼数字，每个NativeObject唯一 318 319**起始版本：** 320 3218 322 323 324### OH_NativeWindow_NativeObjectReference() 325 326 327``` 328int32_t OH_NativeWindow_NativeObjectReference (void * obj) 329``` 330 331**描述：** 332 333增加一个NativeObject的引用计数 334 335\@syscap SystemCapability.Graphic.Graphic2D.NativeWindow 336 337**参数：** 338 339 | 名称 | 描述 | 340| -------- | -------- | 341| obj | 参数是一个NativeWindow or NativeWindowBuffer的结构体实例的指针 | 342 343**返回：** 344 345GSError 返回值为错误码 346 347**起始版本：** 348 3498 350 351 352### OH_NativeWindow_NativeObjectUnreference() 353 354 355``` 356int32_t OH_NativeWindow_NativeObjectUnreference (void * obj) 357``` 358 359**描述：** 360 361减少一个NativeObject的引用计数，当引用计数减少为0时，该NativeObject将被析构掉 362 363\@syscap SystemCapability.Graphic.Graphic2D.NativeWindow 364 365**参数：** 366 367 | 名称 | 描述 | 368| -------- | -------- | 369| obj | 参数是一个NativeWindow or NativeWindowBuffer的结构体实例的指针 | 370 371**返回：** 372 373GSError 返回值为错误码 374 375**起始版本：** 376 3778 378 379 380### OH_NativeWindow_NativeWindowAbortBuffer() 381 382 383``` 384int32_t OH_NativeWindow_NativeWindowAbortBuffer (OHNativeWindow * window, OHNativeWindowBuffer * buffer ) 385``` 386 387**描述：** 388 389通过NativeWindow将之前申请出来的NativeWindowBuffer返还到Buffer队列中，供下次再申请 390 391\@syscap SystemCapability.Graphic.Graphic2D.NativeWindow 392 393**参数：** 394 395 | 名称 | 描述 | 396| -------- | -------- | 397| window | 参数是一个NativeWindow的结构体实例的指针 | 398| buffer | 参数是一个NativeWindowBuffer的结构体实例的指针 | 399 400**返回：** 401 402GSError 返回值为错误码 403 404**起始版本：** 405 4068 407 408 409### OH_NativeWindow_NativeWindowFlushBuffer() 410 411 412``` 413int32_t OH_NativeWindow_NativeWindowFlushBuffer (OHNativeWindow * window, OHNativeWindowBuffer * buffer, int fenceFd, Region region ) 414``` 415 416**描述：** 417 418通过NativeWindow将生产好内容的NativeWindowBuffer放回到Buffer队列中，用以内容消费 419 420\@syscap SystemCapability.Graphic.Graphic2D.NativeWindow 421 422**参数：** 423 424 | 名称 | 描述 | 425| -------- | -------- | 426| window | 参数是一个NativeWindow的结构体实例的指针 | 427| buffer | 参数是一个NativeWindowBuffer的结构体实例的指针 | 428| fenceFd | 参数是一个文件描述符句柄，用以同步时序 | 429| region | 参数表示一块脏区域，该区域有内容更新 | 430 431**返回：** 432 433GSError 返回值为错误码 434 435**起始版本：** 436 4378 438 439 440### OH_NativeWindow_NativeWindowHandleOpt() 441 442 443``` 444int32_t OH_NativeWindow_NativeWindowHandleOpt (OHNativeWindow * window, int code, ... ) 445``` 446 447**描述：** 448 449设置/获取NativeWindow的属性，包括设置/获取宽高、内容格式等 450 451\@syscap SystemCapability.Graphic.Graphic2D.NativeWindow 452 453**参数：** 454 455 | 名称 | 描述 | 456| -------- | -------- | 457| window | 参数是一个NativeWindow的结构体实例的指针 | 458| code | 表示操作码，详见[NativeWindowOperation](#nativewindowoperation) | 459| ... | 可变参数，必须与操作码一一对应 | 460 461**返回：** 462 463GSError 返回值为错误码 464 465**起始版本：** 466 4678 468 469 470### OH_NativeWindow_NativeWindowRequestBuffer() 471 472 473``` 474int32_t OH_NativeWindow_NativeWindowRequestBuffer (OHNativeWindow * window, OHNativeWindowBuffer ** buffer, int * fenceFd ) 475``` 476 477**描述：** 478 479通过NativeWindow对象申请一块NativeWindowBuffer，用以内容生产 480 481\@syscap SystemCapability.Graphic.Graphic2D.NativeWindow 482 483**参数：** 484 485 | 名称 | 描述 | 486| -------- | -------- | 487| window | 参数是一个NativeWindow的结构体实例的指针 | 488| buffer | 参数是一个NativeWindowBuffer的结构体实例的二级指针 | 489| fenceFd | 参数是一个文件描述符句柄 | 490 491**返回：** 492 493GSError 返回值为错误码 494 495**起始版本：** 496 4978 498 499 500### OH_NativeWindow_NativeWindowSetMetaData() 501 502 503``` 504int32_t OH_NativeWindow_NativeWindowSetMetaData (OHNativeWindow * window, uint32_t sequence, int32_t size, const OHHDRMetaData * metaData ) 505``` 506 507**描述：** 508 509设置NativeWindow的元数据. 510 511\@syscap SystemCapability.Graphic.Graphic2D.NativeWindow 512 513**参数：** 514 515 | 名称 | 描述 | 516| -------- | -------- | 517| window | 参数是一个NativeWindow的结构体实例的指针 | 518| sequence | 生产缓冲区的序列 | 519| size | OHHDRMetaData数组的大小 | 520| metaDate | 指向OHHDRMetaData数组的指针 | 521 522**返回：** 523 524GSError 返回值为错误码 525 526**起始版本：** 527 5289 529 530 531### OH_NativeWindow_NativeWindowSetMetaDataSet() 532 533 534``` 535int32_t OH_NativeWindow_NativeWindowSetMetaDataSet (OHNativeWindow * window, uint32_t sequence, OHHDRMetadataKey key, int32_t size, const uint8_t * metaData ) 536``` 537 538**描述：** 539 540设置NativeWindow的元数据集。 541 542\@syscap SystemCapability.Graphic.Graphic2D.NativeWindow 543 544**参数：** 545 546 | 名称 | 描述 | 547| -------- | -------- | 548| window | 参数是一个NativeWindow的结构体实例的指针。 | 549| sequence | 生产缓冲区的序列。 | 550| key | 枚举值OHHDRMetadataKey | 551| size | uint8_t向量的大小 | 552| metaDate | 指向uint8_t向量的指针 | 553 554**返回：** 555 556GSError 返回值为错误码 557 558**起始版本：** 559 5609 561 562 563### OH_NativeWindow_NativeWindowSetScalingMode() 564 565 566``` 567int32_t OH_NativeWindow_NativeWindowSetScalingMode (OHNativeWindow * window, uint32_t sequence, OHScalingMode scalingMode ) 568``` 569 570**描述：** 571 572设置NativeWindow的ScalingMode 573 574\@syscap SystemCapability.Graphic.Graphic2D.NativeWindow 575 576**参数：** 577 578 | 名称 | 描述 | 579| -------- | -------- | 580| window | 参数是一个NativeWindow的结构体实例的指针 | 581| sequence | 生产缓冲区的序列 | 582| scalingMode | 枚举值OHScalingMode | 583 584**返回：** 585 586GSError 返回值为错误码 587 588**起始版本：** 589 5909 591 592 593### OH_NativeWindow_NativeWindowSetTunnelHandle() 594 595 596``` 597int32_t OH_NativeWindow_NativeWindowSetTunnelHandle (OHNativeWindow * window, const OHExtDataHandle * handle ) 598``` 599 600**描述：** 601 602设置NativeWindow的TunnelHandle。 603 604\@syscap SystemCapability.Graphic.Graphic2D.NativeWindow 605 606**参数：** 607 608 | 名称 | 描述 | 609| -------- | -------- | 610| window | 参数是一个NativeWindow的结构体实例的指针 | 611| handle | 指向OHExtDataHandle的指针 | 612 613**返回：** 614 615GSError 返回值为错误码 616 617**起始版本：** 618 6199 620