Giới thiệu và build demo app cho Zoom SDK (ClientSDK)

Jul 23, 2021

1. Giới thiệu Zoom SDK

1.1. Video SDK

Video SDK là bộ kit phát triển ứng dụng cung cấp các chức năng video cộng tác để kết nối khách hàng và cộng đồng. Bộ SDK này cho phép xây dựng các ứng dụng với khả năng tuỳ biến cao và cho phép truy cập đến dữ liệu video và audio ở dang raw.

Hiện tại, Video SDK cho phép tích hợp và ứng dụng các chức năng sau:

  • Tạo một phiên liên lạc bằng video ngay lập tức
  • Chia sẻ màn hình trực tiếp từ thiết bị
  • Gửi tin nhắn (chat) từ phiên gọi video
  • Bắt và xem lại dữ liệu thô ở thiết bị nội bộ
  • Kiểm thử các sơ đồ dựng hình và thưởng thức truyền video và audio chất lượng cao
  • Quảng bá các phiên video cho các nhà cung cấp dịch vụ streaming bên thứ ba

1.2. Client SDK

Zoom Client SDK cho phép các nhà phát triển ứng dụng tích hợp các bộ tính năng có trong ứng dụng Zoom Client vào ứng dụng của họ.

2. Đăng ký và tạo ứng dụng

2.1. Đăng ký tài khoản

Vào trang https://zoom.us/signup và làm theo hướng dẫn để đăng ký 1 tài khoản zoom.

Sau khi đăng ký tài khoản, ta có thể sử dụng tài khoản cho cả chức năng của zoom (app) và chức năng develop

Giao diên chính của trang quản lý
Giao diện chính của trang quản lý

1.2. Tạo ứng dụng

  • Vào trang marketplace và đăng nhập bằng tài khoản zoom đã tạo.

    Chú ý: cần phân biệt trang quản lý của zoom (https://zoom.us/profile) và trang market place (https://marketplace.zoom.us/). Trang marketplace là dành cho các chức năng develop, tương tự với các trang develop của các dịch vụ/nền tảng khác

  • Giao diện trang marketplace
    Giao diện trang Marketplace của Zoom

  • Trong mục Develop, chọn Build App để tạo một ứng dụng mới
  • Xác nhận policy của zoom và chọn create SDK để tạo 1 ứng dụng có thể tích hợp SDK vào các ứng dụng client trên nền tảng được hỗ trợ. Làm theo các bước hướng dẫn để tạo được 1 ứng dụng
  • Sau khi tạo xong, ta có thể truy cập đến trang thông tin của ứng dụng đã tạo
  • Ta cũng có thể truy cập trang thông tin ứng dụng từ danh sách ứng dụng bằng cách bấm vào nut Manage ở góc trên bên phải
  • Các thông tin quan trọng ở trang quản lý ứng dụng là SDK KeySDK Secret

3. Tích hợp Client SDK và build demo app trên Windows/C++

3.1 Tải Zoom Client SDK

  • Tạo một ứng dụng SDK từ trang Marketplace và truy cập vào trang admin của ứng dụng vừa tạo
  • Chọn mục Download, Windows và bấm nút Download để download phiên bản SDK mới nhất

3.2 Cấu trúc thư mục

Sau khi giải nén SDK đã download, cấu trúc SDK như sau

├───bin
│ ├───Aomhost
│ └───ringtone
├───demo
│ ├───duilib
│ │ ├───include
│ │ │ ├───Control
│ │ │ ├───Core
│ │ │ ├───Layout
│ │ │ └───Utils
│ │ └───lib
│ └───sdk_demo_v2
│ ├───res
│ │ └───annotate
│ └───skin
├───h
│ ├───customized_ui
│ ├───meeting_service_components
│ └───rawdata
└───lib

Các thư mục đáng chú ý:

  • bin: các thư viện và các công cụ của Zoom Client SDK, các files trong thư mục này cần phải được copy vào đường dẫn ứng dụng để ứng dụng có thể sử dụng các tính năng của Zoom Client SDK
  • demo: source code của ứng dụng demo chức năng của Zoom Client SDK
  • h: headers để ứng dụng C++ có thể gọi và sử dụng các hàm của Zoom Client SDK
  • lib: các thư viện SDK để sử dụng khi build

Chú ý: Tên các thư mục có thể khác phụ thuộc vào phiên bản của SDK, nhưng về cơ bản các thư mục sẽ không khác nhau quá nhiều

Cấu trúc project demo:

Đi kèm Zoom Client SDK là một project demo sử dụng ngôn ngữ lập trình C++ để demo các chức năng của bộ SDK, nội dung thư mục này gồm có:

  • dui_lib: thư viện giao diện đồ hoạ người dùng (GUI) mà project demo sử dụng
  • sdk_demo: thư mục C++ solutions

3.3. Tích hợp SDK vào dự án C++

3.3.1. Môi trường dự án:

IDE:  Visual Studio 2019  Build Tools:  MSVC 14.25.2610  Zoom Client SDK Version:  5.5.12511.0422  Windows SDK Version:  10.0.18362.0

3.3.2. Cấu hình:

Mở trang cấu hình của project bằng cách bấm chuột phải vào tên project ở cửa sổ Solution Explorer và chọn Properties

Khi cửa sổ Properties của project hiện ra, ở phần General, phần Configuration chọn Release.

Chú ý: Do SDK không hỗ trợ Debug Mode nên phải chọn cấu hình là Release hoặc clone từ Release, việc build trên Debug Mode sẽ xảy ra lỗi.

Chỉnh đường dẫn cho mục Output Directory để cài đặt thư mục mà file exe sẽ được build ra. Thư mục này cần chứa tất cả các file trong thư mục bin của sdk (xem mục 3.2), có thể copy các file đó vào thư mục này hoặc chỉnh luôn Output Directory vào thư mục bin.

Trong C/C++ / General, thêm các đường dẫn đến header của duilib và SDK vào mục Additional Include Directories, đường dẫn tương ứng từ thư mục SDK là, có thể sử dụng đường dẫn tương đối từ thư mục project:

  • demo/duilib/include: headers của duilib
  • h: header của SDK

Trong mục Linker/General, ở phần Additional Library Directories, thêm đường dẫn các file thư viện của SDK và duilib:

  • demo/duilib/lib: lib của duilib, bao gồm DuiLib.lib và DuiLib64.lib
  • lib: lib của SDK, bao gồm sdk.lib

3.4. Build và chạy app demo

3.4.1. Build & Run

Chọn cấu hình build là Release, Platform là Win32 trên thanh công cụ

Chọn Build / Build Solution để build ra file exe ở thư mục đã setup ở phần trước

3.4.2. Chạy app demo

Sau khi build xong, file ứng dụng (exe) sẽ được build ra tại đường dẫn đã cấu hình, ở đây là sdk_demo_v2.exe

Chạy file sdk_demo_v2.exe để mở giao diện của app demo

Great! You've successfully subscribed.
Great! Next, complete checkout for full access.
Welcome back! You've successfully signed in.
Success! Your account is fully activated, you now have access to all content.