Skip to content

Latest commit

 

History

History
120 lines (80 loc) · 3.98 KB

Readme.zh.md

File metadata and controls

120 lines (80 loc) · 3.98 KB

Agora-Python-SDK

English | 中文

Agora RTC Python SDK，目前支持 Windows 和 macOS 平台。

新特性：AudioFrameObserver 从 v3.1.2.10 开始被支持。

运行环境

  • Xcode (macOS)
  • Visual Studio 2017+，需要添加C++支持 (Windows)
  • Python 3.6+

安装

您可以用pip3指令从PyPI上下载并安装，也可以使用本仓库的代码编译SDK。

方法一：使用PyPI（推荐）

仅支持64位操作系统，32位操作系统请使用方法二。

pip3 install agora-python-sdk

方法二：编译SDK

  1. Clone当前仓库。

    git clone https://github.com/AgoraIO-Community/Agora-Python-SDK.git

  2. 下载所需的SDK。

    • （macOS）在 Agora Video SDK for macOS 下载 SDK。解压缩之后，将 libs 目录下的 AograRtcEngineKit.framework 复制到仓库的根目录。
    • （Windows）在 Agora Video SDK for Windows 下载 SDK。解压缩之后，将 libs/x86_64（64位）或libs/x86（32位） 目录下的 agora_rtc_sdk.dll 和 agora_rtc_sdk.lib 复制到仓库的根目录。

  3. 编译SDK。

    打开命令行工具，定位到仓库目录，运行命令

    python3 setup.py build_ext --inplace

  4. （可选）将agorartc添加到site-packages文件夹中。

    若想要在任何路径下都可直接使用SDK，需要将相关的文件拷贝到site-packages路径下。可以通过如下命令找到其路径：

    python3 -c 'import site; print(site.getsitepackages())'

    将_agorartc.cpython-38-darwin.so、agorartc.py和AgoraRtcKit.framework或agora_rtc_sdk.dll和agora_rtc_sdk.lib复制到site-packages文件夹里。

    • macOS（终端）

      cp _agorartc.cpython-38-darwin.so [your-site-packages-folder-path]
cp agorartc.py [your-site-packages-folder-path]
cp -r AgoraRtcKit.framework [your-site-packages-folder-path]

    • Windows (PowerShell)

      cp _agorartc.cpython-38-darwin.so [your-site-packages-folder-path]
cp agorartc.py [your-site-packages-folder-path]
cp agora_rtc_sdk.dll [your-site-packages-folder-path]
cp agora_rtc_sdk.lib [your-site-packages-folder-path]

使用方法

您可以通过访问Agora-Python-QuickStart获取现有的示例。

您也可以根据如下教程完成一个简单的示例。

  1. 在终端（macOS）或PowerShell（Windows）中打开一个Python3控制台。

    python3

  2. 在Python控制台中完成示例。

    >>> import agorartc
>>> rtc = agorartc.createRtcEngineBridge()
>>> eventHandler = agorartc.RtcEngineEventHandlerBase()
>>> rtc.initEventHandler(eventHandler)
0 （成功）
>>> rtc.initialize("您的appID", None, agorartc.AREA_CODE_GLOB & 0xFFFFFFFF)  # 如您还未获取App ID，您可以查看附录(https://github.com/AgoraIO-Community/Agora-Python-SDK/blob/master/Readme.zh.md#%E9%99%84%E5%BD%95)。
0 （成功）
>>> rtc.enableVideo()
0 （成功）
>>> rtc.joinChannel("", "channel-name", "", 0)
0 （成功）
>>> rtc.leaveChannel()  # 离开频道
0 （成功）
>>> rtc.release()

帮助

如您需要了解关于我们API的更多信息，请参考Agora C++ API。

Python的API文档还在推进中，但我们已有的C++ API是相似的。*

附录

创建Agora账户并获取App ID

如果想要使用我们的SDK，您需要先获得一个App ID：

  1. 在agora.io中注册一个账号。当您完成注册后，您将被链接至控制台。
  2. 在控制台左侧点击Projects > Project List。
  3. 请将您从控制台中获取的App ID保存，您将会在调用SDK时使用。