agora-python-server-sdk 2.2.1__tar.gz → 2.3.2__tar.gz

{agora_python_server_sdk-2.2.1/agora_python_server_sdk.egg-info → agora_python_server_sdk-2.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.1
 Name: agora_python_server_sdk
-Version: 2.2.1
+Version: 2.3.2
 Summary: A Python SDK for Agora Server
 Home-page: https://github.com/AgoraIO-Extensions/Agora-Python-Server-SDK
 Classifier: Intended Audience :: Developers
@@ -12,22 +12,28 @@ Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: requires-python
-Dynamic: summary
 
 # Note
 - This is a Python SDK wrapper for the Agora RTC SDK.
 - It supports Linux and Mac platforms.
 - The examples are provided as very simple demonstrations and are not recommended for use in production environments.
+-rtc examples：https://github.com/AgoraIO-Extensions/Agora-python-Server-SDK/examples
+-rtm examples: https://github.com/AgoraIO-Extensions/Agora-python-Server-SDK/examples_rtm
 
 # Very Important Notice !!!
-- A process can only have one instance.
+- A process can only have one instance,and the instance created in process startup is the global instance,and released in process shutdown.
 - An instance can have multiple connections.
 - In all observers or callbacks, you must not call the SDK's own APIs, nor perform CPU-intensive tasks in the callbacks; data copying is allowed.
+- supported video codec:
+  - H264: support both encoding and decoding
+  - VP8: support both encoding and decoding
+  - VP9: support both encoding and decoding
+  - H265: only decoding is supported, encoding willl support in the future
+  - AV1: both encoding and decoding are suported but if video image's solution is less than 360p, the codec will be changed to H264
+- if you want to recive the encoded video data:
+  - set: video_subscription_options.encodedFrameOnly = 1
+  - and then register: set_encoded_video_frame_observer
+
 
 # Required Operating Systems and Python Versions
 - Supported Linux versions:
@@ -51,11 +57,191 @@ pip install agora_python_server_sdk
 - Download and unzip [test_data.zip](https://download.agora.io/demo/test/test_data_202408221437.zip) to the Agora-Python-Server-SDK directory.
 
 ## Executing Test Script
+or linux os, should set env to ：/site_packages/agora/agora_sdk/, like:
+export LD_LIBRARY_PATH=/site_packages/agora/agora_sdk/
 ```
 python agora_rtc/examples/example_audio_pcm_send.py --appId=xxx --channelId=xxx --userId=xxx --audioFile=./test_data/demo.pcm --sampleRate=16000 --numOfChannels=1
 ```
 
 # Change log
+# 2025.10.23 release 2.3.2: support rtc and rtm in one package
+-- update: to support rtm.can support both rtc and rtm in one package.
+-- adjust sdk's directory structure
+-- update rtc sdk
+# 2025.10.09  release 2.3.1
+-- update arm64 rtc sdk:Fixed a JNI referencing issue in the previous arm64 build. This issue only outputs logs to the console and does not affect functionality.
+
+#2025.09.01  release 2.3.0
+
+Overview
+
+Agora Python SDK version 2.3.0 introduces significant enhancements for real-time audio and video communication, with particular optimizations for AI server scenarios. This release includes API improvements, automation of previously manual processes, and increased flexibility in connection configuration.
+
+New Features
+
+1. AudioScenarioAiServer Support
+
+• Added support for the AudioScenarioAiServer scenario type, now set as the default AudioScenario.
+
+• Enables configuration of different scenarios and profiles for connections within the same process.
+
+• Important: When using AI server scenario, client-side must use AIClient scenario to avoid audio abnormalities. Please consult Agora support for SDK versions supporting AIClient scenario.
+
+2. Enhanced Connection Configuration
+
+• Introduced PublishConfigure parameter in connection creation for setting:
+
+  • Scenario and profile configurations
+
+  • Audio/Video publication settings
+
+  • Other publication parameters
+
+• Added multiple observer registration methods to connections:
+
+  • RegisterLocalUserObserver
+
+  • RegisterAudioFrameObserver
+
+  • RegisterVideoFrameObserver
+
+  • RegisterVideoEncodedFrameObserver
+
+3. Stream Management Improvements
+
+• Added publication control methods:
+
+  • PublishAudio/UnpublishAudio
+
+  • PublishVideo/UnpublishVideo
+
+• Added data pushing methods:
+
+  • PushAudioPcmData/PushAudioEncodedData
+
+  • PushVideoFrame/PushVideoEncodedData
+
+• Added InterruptAudio method for supporting interruption functionality
+
+• Added IsPushToRTCCompleted method for checking push status
+
+• Added SendAudioMetaData method for audio metadata transmission
+
+4. Automation Enhancements
+
+• Eliminated manual CreateDataStream calls - now handled automatically
+
+• Automatic observer unregistration on Release() instead of manual unregistering
+
+• Internal handling of media node factory creation:
+
+  • No longer requires manual calls to newMediaNodeFactory
+
+  • Automatic handling of track creation (NewCustomAudioTrackPcm, NewCustomAudioTrackEncoded, NewCustomVideoTrack)
+
+  • Automatic management of audio data senders (NewAudioPcmDataSender)
+
+Integration Process
+
+The updated integration workflow is as follows:
+
+1. Initialize Agora Service (once per process startup):
+   config = AgoraServiceConfig()
+   agora_service = AgoraService()
+   agora_service.initialize(config)
+   
+
+2. Connection Management (can be looped for multiple connections):
+   # Create connection with configuration
+   con = agora_service.create_rtc_connection(con_config, publish_config)
+   
+   # Register observers
+   con.register_observer(conHandler)
+   con.register_audio_frame_observer(audioFrameObserver)
+   con.register_local_user_observer(localUserObserver)
+   
+   # Connect and publish
+   con.connect(token, channelName, userId)
+   con.publish_audio()  # or con.publish_video()
+   
+   # Push data
+   con.push_audio_pcm_data()  # or push_audio_encoded_data()
+   # or con.push_video_frame()/push_video_encoded_data()
+   
+   # Disconnect and release
+   con.disconnect()
+   con.release()
+   
+
+3. Release Agora Service (once during process termination):
+   agora_service.release()
+   
+
+Performance Recommendations
+
+1. For AI Scenarios:
+   • Use AudioScenarioAIServer for server-side applications
+
+   • Provides optimized performance with lower latency (20-30ms reduction on iPhone compared to chorus)
+
+   • Enhanced experience in weak network conditions
+
+   • Mandatory: Client must use AIClient scenario
+
+2. For Non-AI Scenarios:
+   • Consult Agora technical support for appropriate scenario configuration
+
+   • Ensure configuration matches specific business use cases
+
+Bug Fixes
+
+• Updated RTC SDK with 2 bug fixes
+
+Important Notes
+
+• Backward Compatibility: Review integration code for manual calls that are now automated
+
+• Scenario Matching: Ensure client-server scenario compatibility (AIServer requires AIClient)
+
+• Resource Management: Connection release now automatically handles observer unregistration
+
+• Consult Support: For specific integration guidance and upgrade assistance, contact Agora SA
+
+Summary of Core Changes
+
+Before After 2.3.0
+
+Manual CreateDataStream ✅ Automatic
+
+Manual observer unregistration ✅ Automatic on Release()
+
+Fixed per-process scenario ✅ Multi-scenario per process
+
+Client/Server scenario mismatch ❗ AIClient mandatory for AI use
+
+For detailed implementation guidance and version-specific support, please consult Agora technical support.
+
+
+## 2025.04.28 Release 2.2.4
+-- Update: update rtc sdk from 4.4.31 to 4.4.32
+## 2025.04.14 Release 2.2.3
+-- Fix: 
+  -- Fixed a bug in the salt processing in enable_encryption
+  -- Updated the logic in enable_encryption, no processing when enable is 0
+2025.04.10 Release 2.2.2
+-- Additions:
+  - Added push_video_encoded_file.py to support pushing mp4 files and h264 encoded h.264 files. Includes conversion from mp4 file avformat to raw 264 stream in annex B format.
+-- Additions:
+  - Added set_log_file_filter function to set the log filter level.
+-- Additions:
+  - Added support for arm64 version, but currently this version does not support audio label algorithm. Therefore, it is not supported on arm64!
+-- Changes:
+  - Modified localuserstats, local video stats, local audio stats, remote video stats, remote audio stats.
+-- Additions:
+  - Added connection::agora_rtc_conn_enable_encryption.
+-- Additions:
+  - Added connectionObserver::on_encryption_error (but not working for now, need to fix in the next monthly version 4.4.32).
+
 2025.02.26 Release 2.2.1
 --Update：
   ​- Reduced buffer size from ​180ms​ to ​100ms​ to minimize latency.
@@ -76,7 +262,6 @@ python agora_rtc/examples/example_audio_pcm_send.py --appId=xxx --channelId=xxx
   - Add the AudioMetaData interface: localuser::send_audio_meta_data. Done.
   - Add the OnAudioMetaDataReceived callback to localuserObserver::on_audio_meta_data_received. Done.
 -- Sample modifications.
-
 2024.12.17 Release 2.1.7
 --Changes:
 
@@ -104,7 +289,6 @@ python agora_rtc/examples/example_audio_pcm_send.py --appId=xxx --channelId=xxx
   -- Replaced the use of pacer with AudioConsumer for pushing PCM audio.
 - Updates:
   -- Updated the samples related to Pacer and VAD.
-
 ## 2024.12.03 release Version 2.1.5
 - Modifications:
   - LocalUser/audioTrack:
@@ -160,7 +344,6 @@ Fixed some bug.
 - Handle business operations.
 - When a user logs out, execute con.disconnect() and release the audio/video tracks and observers associated with the connection, but do not call con.release(); then put the connection back into the connection pool.
 - When the process exits, release the connection pool (release each con.release()), service/media_node_factory, and the connection pool (release each con.release()) to ensure resource release and optimal performance.
-
 ## Use of VAD
 # Source code: voice_detection.py
 # Sample code: example_audio_vad.py
@@ -191,7 +374,8 @@ Judge the value of state according to the returned state, and do corresponding p
 ### How to push the audio generated by TTS into the channel?
   # Source code: audio_consumer.py
   # Sample code: example_audio_consumer.py
-### How to release resources?
+
+### How to release resource?
 ## 如何释放资源？
     localuser.unpublish_audio(audio_track)
     localuser.unpublish_video(video_track)

{agora_python_server_sdk-2.2.1 → agora_python_server_sdk-2.3.2}/README.md

@@ -2,11 +2,23 @@
 - This is a Python SDK wrapper for the Agora RTC SDK.
 - It supports Linux and Mac platforms.
 - The examples are provided as very simple demonstrations and are not recommended for use in production environments.
+-rtc examples：https://github.com/AgoraIO-Extensions/Agora-python-Server-SDK/examples
+-rtm examples: https://github.com/AgoraIO-Extensions/Agora-python-Server-SDK/examples_rtm
 
 # Very Important Notice !!!
-- A process can only have one instance.
+- A process can only have one instance,and the instance created in process startup is the global instance,and released in process shutdown.
 - An instance can have multiple connections.
 - In all observers or callbacks, you must not call the SDK's own APIs, nor perform CPU-intensive tasks in the callbacks; data copying is allowed.
+- supported video codec:
+  - H264: support both encoding and decoding
+  - VP8: support both encoding and decoding
+  - VP9: support both encoding and decoding
+  - H265: only decoding is supported, encoding willl support in the future
+  - AV1: both encoding and decoding are suported but if video image's solution is less than 360p, the codec will be changed to H264
+- if you want to recive the encoded video data:
+  - set: video_subscription_options.encodedFrameOnly = 1
+  - and then register: set_encoded_video_frame_observer
+
 
 # Required Operating Systems and Python Versions
 - Supported Linux versions:
@@ -30,11 +42,191 @@ pip install agora_python_server_sdk
 - Download and unzip [test_data.zip](https://download.agora.io/demo/test/test_data_202408221437.zip) to the Agora-Python-Server-SDK directory.
 
 ## Executing Test Script
+or linux os, should set env to ：/site_packages/agora/agora_sdk/, like:
+export LD_LIBRARY_PATH=/site_packages/agora/agora_sdk/
 ```
 python agora_rtc/examples/example_audio_pcm_send.py --appId=xxx --channelId=xxx --userId=xxx --audioFile=./test_data/demo.pcm --sampleRate=16000 --numOfChannels=1
 ```
 
 # Change log
+# 2025.10.23 release 2.3.2: support rtc and rtm in one package
+-- update: to support rtm.can support both rtc and rtm in one package.
+-- adjust sdk's directory structure
+-- update rtc sdk
+# 2025.10.09  release 2.3.1
+-- update arm64 rtc sdk:Fixed a JNI referencing issue in the previous arm64 build. This issue only outputs logs to the console and does not affect functionality.
+
+#2025.09.01  release 2.3.0
+
+Overview
+
+Agora Python SDK version 2.3.0 introduces significant enhancements for real-time audio and video communication, with particular optimizations for AI server scenarios. This release includes API improvements, automation of previously manual processes, and increased flexibility in connection configuration.
+
+New Features
+
+1. AudioScenarioAiServer Support
+
+• Added support for the AudioScenarioAiServer scenario type, now set as the default AudioScenario.
+
+• Enables configuration of different scenarios and profiles for connections within the same process.
+
+• Important: When using AI server scenario, client-side must use AIClient scenario to avoid audio abnormalities. Please consult Agora support for SDK versions supporting AIClient scenario.
+
+2. Enhanced Connection Configuration
+
+• Introduced PublishConfigure parameter in connection creation for setting:
+
+  • Scenario and profile configurations
+
+  • Audio/Video publication settings
+
+  • Other publication parameters
+
+• Added multiple observer registration methods to connections:
+
+  • RegisterLocalUserObserver
+
+  • RegisterAudioFrameObserver
+
+  • RegisterVideoFrameObserver
+
+  • RegisterVideoEncodedFrameObserver
+
+3. Stream Management Improvements
+
+• Added publication control methods:
+
+  • PublishAudio/UnpublishAudio
+
+  • PublishVideo/UnpublishVideo
+
+• Added data pushing methods:
+
+  • PushAudioPcmData/PushAudioEncodedData
+
+  • PushVideoFrame/PushVideoEncodedData
+
+• Added InterruptAudio method for supporting interruption functionality
+
+• Added IsPushToRTCCompleted method for checking push status
+
+• Added SendAudioMetaData method for audio metadata transmission
+
+4. Automation Enhancements
+
+• Eliminated manual CreateDataStream calls - now handled automatically
+
+• Automatic observer unregistration on Release() instead of manual unregistering
+
+• Internal handling of media node factory creation:
+
+  • No longer requires manual calls to newMediaNodeFactory
+
+  • Automatic handling of track creation (NewCustomAudioTrackPcm, NewCustomAudioTrackEncoded, NewCustomVideoTrack)
+
+  • Automatic management of audio data senders (NewAudioPcmDataSender)
+
+Integration Process
+
+The updated integration workflow is as follows:
+
+1. Initialize Agora Service (once per process startup):
+   config = AgoraServiceConfig()
+   agora_service = AgoraService()
+   agora_service.initialize(config)
+   
+
+2. Connection Management (can be looped for multiple connections):
+   # Create connection with configuration
+   con = agora_service.create_rtc_connection(con_config, publish_config)
+   
+   # Register observers
+   con.register_observer(conHandler)
+   con.register_audio_frame_observer(audioFrameObserver)
+   con.register_local_user_observer(localUserObserver)
+   
+   # Connect and publish
+   con.connect(token, channelName, userId)
+   con.publish_audio()  # or con.publish_video()
+   
+   # Push data
+   con.push_audio_pcm_data()  # or push_audio_encoded_data()
+   # or con.push_video_frame()/push_video_encoded_data()
+   
+   # Disconnect and release
+   con.disconnect()
+   con.release()
+   
+
+3. Release Agora Service (once during process termination):
+   agora_service.release()
+   
+
+Performance Recommendations
+
+1. For AI Scenarios:
+   • Use AudioScenarioAIServer for server-side applications
+
+   • Provides optimized performance with lower latency (20-30ms reduction on iPhone compared to chorus)
+
+   • Enhanced experience in weak network conditions
+
+   • Mandatory: Client must use AIClient scenario
+
+2. For Non-AI Scenarios:
+   • Consult Agora technical support for appropriate scenario configuration
+
+   • Ensure configuration matches specific business use cases
+
+Bug Fixes
+
+• Updated RTC SDK with 2 bug fixes
+
+Important Notes
+
+• Backward Compatibility: Review integration code for manual calls that are now automated
+
+• Scenario Matching: Ensure client-server scenario compatibility (AIServer requires AIClient)
+
+• Resource Management: Connection release now automatically handles observer unregistration
+
+• Consult Support: For specific integration guidance and upgrade assistance, contact Agora SA
+
+Summary of Core Changes
+
+Before After 2.3.0
+
+Manual CreateDataStream ✅ Automatic
+
+Manual observer unregistration ✅ Automatic on Release()
+
+Fixed per-process scenario ✅ Multi-scenario per process
+
+Client/Server scenario mismatch ❗ AIClient mandatory for AI use
+
+For detailed implementation guidance and version-specific support, please consult Agora technical support.
+
+
+## 2025.04.28 Release 2.2.4
+-- Update: update rtc sdk from 4.4.31 to 4.4.32
+## 2025.04.14 Release 2.2.3
+-- Fix: 
+  -- Fixed a bug in the salt processing in enable_encryption
+  -- Updated the logic in enable_encryption, no processing when enable is 0
+2025.04.10 Release 2.2.2
+-- Additions:
+  - Added push_video_encoded_file.py to support pushing mp4 files and h264 encoded h.264 files. Includes conversion from mp4 file avformat to raw 264 stream in annex B format.
+-- Additions:
+  - Added set_log_file_filter function to set the log filter level.
+-- Additions:
+  - Added support for arm64 version, but currently this version does not support audio label algorithm. Therefore, it is not supported on arm64!
+-- Changes:
+  - Modified localuserstats, local video stats, local audio stats, remote video stats, remote audio stats.
+-- Additions:
+  - Added connection::agora_rtc_conn_enable_encryption.
+-- Additions:
+  - Added connectionObserver::on_encryption_error (but not working for now, need to fix in the next monthly version 4.4.32).
+
 2025.02.26 Release 2.2.1
 --Update：
   ​- Reduced buffer size from ​180ms​ to ​100ms​ to minimize latency.
@@ -55,7 +247,6 @@ python agora_rtc/examples/example_audio_pcm_send.py --appId=xxx --channelId=xxx
   - Add the AudioMetaData interface: localuser::send_audio_meta_data. Done.
   - Add the OnAudioMetaDataReceived callback to localuserObserver::on_audio_meta_data_received. Done.
 -- Sample modifications.
-
 2024.12.17 Release 2.1.7
 --Changes:
 
@@ -83,7 +274,6 @@ python agora_rtc/examples/example_audio_pcm_send.py --appId=xxx --channelId=xxx
   -- Replaced the use of pacer with AudioConsumer for pushing PCM audio.
 - Updates:
   -- Updated the samples related to Pacer and VAD.
-
 ## 2024.12.03 release Version 2.1.5
 - Modifications:
   - LocalUser/audioTrack:
@@ -139,7 +329,6 @@ Fixed some bug.
 - Handle business operations.
 - When a user logs out, execute con.disconnect() and release the audio/video tracks and observers associated with the connection, but do not call con.release(); then put the connection back into the connection pool.
 - When the process exits, release the connection pool (release each con.release()), service/media_node_factory, and the connection pool (release each con.release()) to ensure resource release and optimal performance.
-
 ## Use of VAD
 # Source code: voice_detection.py
 # Sample code: example_audio_vad.py
@@ -170,7 +359,8 @@ Judge the value of state according to the returned state, and do corresponding p
 ### How to push the audio generated by TTS into the channel?
   # Source code: audio_consumer.py
   # Sample code: example_audio_consumer.py
-### How to release resources?
+
+### How to release resource?
 ## 如何释放资源？
     localuser.unpublish_audio(audio_track)
     localuser.unpublish_video(video_track)

agora_python_server_sdk-2.3.2/agora/rtc/__init__.py

@@ -0,0 +1,33 @@
+#!/usr/bin/env python
+
+import hashlib
+import ssl
+import zipfile
+import site
+from urllib import request
+import ctypes
+import os
+import sys
+import platform
+import logging
+logger = logging.getLogger(__name__)
+ssl._create_default_https_context = ssl._create_unverified_context
+
+
+from .. import sdk_library_dir, sdk_rtc_dir, sdk_rtm_dir
+
+lib_dir = sdk_library_dir
+
+try:
+    if sys.platform == 'darwin':
+        lib_agora_rtc_path = os.path.join(lib_dir, 'libAgoraRtcKit.dylib')
+        agora_lib = ctypes.CDLL(lib_agora_rtc_path)
+
+    elif sys.platform == 'linux':
+        lib_agora_rtc_path = os.path.join(lib_dir, 'libagora_rtc_sdk.so')
+        #ctypes.CDLL(os.path.join(lib_dir, 'libagora-fdkaac.so'))
+        agora_lib = ctypes.CDLL(lib_agora_rtc_path)
+except OSError as e:
+    logger.error(f"Error loading the library: {e}")
+    logger.error(f"Attempted to load from: {lib_agora_rtc_path}")
+    sys.exit(1)