Python

Server Gateway SDK API reference for Python.

OverviewCopy Anchor Link

• AgoraService

  Method	Description
  initialize	Initializes the AgoraService object.
  release	Releases the AgoraService object.
  create_rtc_connection	Creates an RTC connection object.
  create_custom_audio_track_pcm	Creates a local audio track object with a source that sends PCM audio data.
  create_custom_audio_track_encoded	Creates a local audio track object with a source that sends encoded audio data.
  create_media_node_factory	Creates a media node factory object.
  create_custom_video_track_frame	Creates a local video track object with a source that sends YUV format video data.
  create_custom_video_track_encoded	Creates a local video track object with a source that sends encoded video data.
  set_log_file	Sets the path and size of the SDK log file.

• RTCConnection

  Method	Description
  connect	Connects to the RTC channel.
  disconnect	Disconnects from the RTC channel.
  renew_token	Renews the token.
  register_observer	Registers an RTC connection observer.
  unregister_observer	Destroys the RTC connection observer.
  create_data_stream	Creates a data stream.
  send_stream_message	Sends a data stream message.
  get_agora_parameter	Gets the AgoraParameter object.
  get_local_user	Gets the LocalUser object.
  release	Releases the RTC connection.
  enable_encryption	Enables encryption.

• IRTCConnectionObserver

  Callback	Description
  on_connected	Occurs when the SDK connection state changes to 3.
  on_disconnected	Occurs when the SDK connection state changes to 1.
  on_token_privilege_will_expire	Occurs when the token will expire in 30 seconds.
  on_token_privilege_did_expire	Occurs when the token has expired.
  on_user_joined	Occurs when a remote user joins the channel.
  on_user_left	Occurs when a remote user leaves the channel.
  on_stream_message_error	Occurs when there is an error receiving a data stream message.
  on_error	Occurs when an error occurs.
  on_encryption_error	Occurs when encryption errors occur.

• LocalUser

  Method	Description
  set_user_role	Sets the user role.
  set_audio_encoder_configuration	Sets the audio encoder configuration.
  publish_audio	Sends the local audio track to the channel.
  unpublish_audio	Stops sending the local audio track to the channel.
  publish_video	Sends the local video track to the channel.
  unpublish_video	Stops sending the local video track to the channel.
  subscribe_audio	Subscribes to the audio stream sent by a specific remote user in the channel.
  subscribe_all_audio	Subscribes to all audio streams sent by remote users in the channel.
  unsubscribe_audio	Stops subscribing to the audio stream sent by a specific remote user in the channel.
  unsubscribe_all_audio	Stops subscribing to all audio streams sent by remote users in the channel.
  set_playback_audio_frame_before_mixing_parameters	Sets the audio data format for the on_playback_audio_frame_before_mixing callback.
  register_audio_frame_observer	Registers an audio frame observer.
  unregister_audio_frame_observer	Destroys the IAudioFrameObserver object.
  register_video_encoded_frame_observer	Registers an encoded video frame observer.
  unregister_video_encoded_frame_observer	Destroys the encoded video frame observer.
  subscribe_video	Subscribes to the video stream sent by a specific remote user in the channel.
  subscribe_all_video	Subscribes to all video streams sent by remote users in the channel.
  unsubscribe_video	Stops subscribing to the video stream sent by a specific remote user in the channel.
  unsubscribe_all_video	Stops subscribing to all video streams sent by remote users in the channel.
  register_local_user_observer	Registers a local user observer.
  unregister_local_user_observer	Destroys the local user observer.
  register_video_frame_observer	Registers an IVideoFrameObserver object.
  unregister_video_frame_observer	Destroys the IVideoFrameObserver object.
  get_rtc_connection	Gets the RtcConnection object.
  release	Releases all resources of the LocalUser object.
  send_audio_meta_data	Sends the audio metadata.

• LocalUserObserver

  Callback	Description
  on_local_audio_track_state_changed	Occurs when the state of a local audio track changes.
  on_user_audio_track_state_changed	Occurs when the state of a remote audio track changes.
  on_stream_message	Occurs when a data stream message is received.
  on_user_info_updated	Occurs when user media information is updated.
  on_audio_metadata_received	Occurs when the local user receives the audio metadata from the remote user.

• LocalAudioTrack

  Method	Description
  set_enabled	Enables or disables the local audio track.
  adjust_publish_volume	Adjusts the audio publish volume.
  set_max_buffer_audio_frame_number	Sets the maximum capacity of the audio send buffer.
  clear_sender_buffer	Clears the current audio send buffer.
  set_send_delay_ms	Sets the minimum data duration allowed to be sent by the audio send buffer.
  release	Releases the local audio track resources.

• LocalVideoTrack

  Method	Description
  set_enabled	Enables or disables the local video track.
  set_video_encoder_configuration	Sets the video encoder properties.

• MediaNodeFactory

  Method	Description
  create_audio_pcm_data_sender	Creates a PCM data sending module.
  create_audio_encoded_frame_sender	Creates an encoded audio data sending module.
  create_video_frame_sender	Creates a YUV video frame sending module.
  create_video_encoded_image_sender	Creates an encoded video sending module.
  release	Releases the MediaNodeFactory object.

• AudioPcmDataSender

  Method	Description
  send_audio_pcm_data	Sends PCM format audio data to the local audio track.

• AudioEncodedFrameSender

  Method	Description
  send_encoded_audio_frame	Sends an encoded audio frame to the local audio track.

• IAudioFrameObserver

  Callback	Description
  on_playback_audio_frame_before_mixing	Occurs when the audio data before mixing is received.

• VideoFrameSender

  Method	Description
  send_video_frame	Sends a YUV format video frame to the video track.

• IVideoFrameObserver

  Callback	Description
  on_frame	Occurs when a video frame is received.

• VideoEncodedImageSender

  Method	Description
  send_encoded_video_image	Sends an encoded video frame to the video track.

• IVideoEncodedFrameObserver

  Callback	Description
  on_encoded_video_frame	Occurs when the SDK receives an encoded video frame.

AgoraServiceCopy Anchor Link

The AgoraService class serves as the entry point for the SDK, allowing you to create media tracks and connections.

initializeCopy Anchor Link

Initializes the AgoraService object.

def initialize(self, config: AgoraServiceConfig)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

releaseCopy Anchor Link

Releases the AgoraService object.

def release(self)

create_rtc_connectionCopy Anchor Link

Creates an RTC connection object.

def create_rtc_connection(self, con_config: RTCConnConfig)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• RTCConnection object, if the method call succeeds.
• None, if the method call fails.

create_custom_audio_track_pcmCopy Anchor Link

Creates a local audio track object with an audio source that sends PCM audio data. This track object can be used to send audio data in PCM format.

def create_custom_audio_track_pcm(self, audio_pcm_data_sender: AudioPcmDataSender)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• LocalAudioTrack object, if the method call succeeds.
• None, if the method call fails.

create_custom_audio_track_encodedCopy Anchor Link

Creates a local audio track object with an audio source that sends encoded audio data. This track object can be used to send encoded audio data, such as Opus format encoded data.

def create_custom_audio_track_encoded(self, audio_encoded_frame_sender: AudioEncodedFrameSender, mix_mode: int)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• LocalAudioTrack object, if the method call succeeds.
• None, if the method call fails.

create_media_node_factoryCopy Anchor Link

Creates a media node factory object.

def create_media_node_factory(self)

ReturnsCopy Anchor Link

• MediaNodeFactory object, if the method call succeeds.
• None, if the method call fails.

create_custom_video_track_frameCopy Anchor Link

Creates a local video track object with a video source that sends YUV format video data. This track object can be used to send video data in YUV format.

def create_custom_video_track_frame(self, video_frame_sender: VideoFrameSender)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• LocalVideoTrack object, if the method call succeeds.
• None, if the method call fails.

create_custom_video_track_encodedCopy Anchor Link

Creates a local video track object with a video source that sends encoded video data. This track object can be used to send encoded video data, such as H.264 or VP8 format encoded data.

def create_custom_video_track_encoded(self, video_encoded_frame_sender: VideoEncodedImageSender, options: SenderOptions)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• LocalVideoTrack object, if the method call succeeds.
• None, if the method call fails.

set_log_fileCopy Anchor Link

Sets the path and size of the SDK log file.

def set_log_file(self, log_path: str, log_size: int = 512 * 1024)

The SDK generates 5 SDK log files and 5 API call log files by default, following these rules:

• The SDK log files names: agorasdk.log, agorasdk.1.log, agorasdk.2.log, agorasdk.3.log, agorasdk.4.log.
• The API call log files names: agoraapi.log, agoraapi.1.log, agoraapi.2.log, agoraapi.3.log, agoraapi.4.log.
• Each SDK log file has the default size of 1,024 KB; each API call log file has the default size of 2,048 KB. All log files are UTF-8 encoded.
• The latest logs are always written to agorasdk.log and agoraapi.log.

When agorasdk.log is full, the SDK handles the log files as follows:

• Deletes the agorasdk.4.log file, if it exists.
• Renames agorasdk.3.log to agorasdk.4.log.
• Renames agorasdk.2.log to agorasdk.3.log.
• Renames agorasdk.1.log to agorasdk.2.log.
• Creates a new agorasdk.log file.

The agoraapi.log file follows the same rotation rules as agorasdk.log.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

RTCConnectionCopy Anchor Link

The RtcConnection class is used to manage the connection between the SDK and the RTC channel. After the connection is complete, you can send and receive media streams in the RTC channel through the LocalUser object. Connecting to a channel is an asynchronous operation, and you can use the IRtcConnectionObserver object to listen for connection status changes and events. The RtcConnection object also monitors whether remote users join or leave the channel.

connectCopy Anchor Link

Connects to an RTC channel.

def connect(self, token: str, chan_id: str, user_id: str) -> int

When the method is successful, the connection status changes from to 2.

Depending on whether the connection is successful, the connection status changes to 3 or 5. The SDK triggers the on_connected or on_disconnected callback to notify you of the connection status change.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.
  • -2: The parameters are invalid.
  • -8: The current connection status is not 1.

disconnectCopy Anchor Link

Disconnects from the RTC channel. When the SDK disconnects from the channel, the connection status changes to 1. You can also learn about the disconnection through the on_disconnected callback.

def disconnect(self) -> int

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

renew_tokenCopy Anchor Link

Renews the token. The token expires after a certain period of time. When you receive the on_token_privilege_will_expire callback, you must generate a new Token from your server and use this method to update the token. Otherwise, the SDK disconnects from the channel.

def renew_token(self, token: str) -> int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

register_observerCopy Anchor Link

Registers the RTC connection observer.

def register_observer(self, conn_observer: IRTCConnectionObserver) -> int

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

unregister_observerCopy Anchor Link

Destroys the RTC connection observer.

def unregister_observer(self) -> int

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

create_data_streamCopy Anchor Link

Creates a data stream.

def create_data_stream(self, reliable: bool, ordered: bool) -> int

Each user can create up to 5 data streams in each channel.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• stream_id: Returns the data stream ID, if the method call succeeds.
• None: Failure.

send_stream_messageCopy Anchor Link

Sends a data stream message.

def send_stream_message(self, stream_id: int, data: str) -> int

The method sends a data stream message to all users in the channel. The SDK implements the following restrictions for this method:

• Up to 30 packets per second, and each packet is no more than 1 KB.
• Up to 6 KB of data per second per client.
• Each client can have up to 5 data channels at the same time.

After successfully calling this method, the remote end triggers the on_stream_message callback, and remote users can obtain the received stream messages in this callback.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

get_agora_parameterCopy Anchor Link

Gets the AgoraParameter object.

def get_agora_parameter(self)

ReturnsCopy Anchor Link

• AgoraParameter object, if the method call succeeds.
• None, if the method call fails.

get_local_userCopy Anchor Link

Gets the LocalUser object. Each connection corresponds to one local user.

def get_local_user(self)

ReturnsCopy Anchor Link

• LocalUser object, if the method call succeeds.
• None, if the method call fails.

releaseCopy Anchor Link

Releases the RTC connection.

def release(self)

enable_encryptionCopy Anchor Link

def enable_encryption(self, enabled: int, config: EncryptionConfig)

Enables encryption.

This method needs to be called before connect. You need to set the encryption mode and encryption configuration in this method.

ParametersCopy Anchor Link

enabled

Whether to enable encryption functionality:

• 1: Enable
• 0: Disable

config

The encryption configuration: EncryptionConfig.

IRTCConnectionObserverCopy Anchor Link

The IRTCConnectionObserver class, used to listen to the connection status of the SDK.

on_connectedCopy Anchor Link

Occurs when the connection state of the SDK changes to 3.

def on_connected(self, agora_rtc_conn, conn_info, reason)

ParametersCopy Anchor Link

agora_rtc_conn

The RTC connection object. See RtcConnection.

conn_info

Connection information. See RTCConnInfo.

reason

Connection state change reason:

• 0: Establishing a network connection.

• 1: Successfully joined the channel.

• 2: Network connection interrupted.

• 3: Network connection forbidden by the server.

• 4: Failed to join the channel.

• 5: Left the channel.

• 6: Invalid App ID. Please change to a valid App ID and try again.

• 7: Invalid channel name. Please change to a valid channel name and try again.

• 8: The generated token is invalid. Generally, the following reasons:

  • App Certificate is enabled on the console, but the Token is not used when joining the channel. When App Certificate is enabled, you must use a Token.
  • The uid specified in connect when joining the channel does not match the uid used when generating the Token.

• 9: The generated Token is invalid.

• 10: This user is banned by the server.

• 11: SDK attempts to reconnect due to setting a proxy server.

• 12: The network connection state changes due to updating the Token.

• 13: The client IP address changes, possibly due to changes in network type or the IP or port of the network operator.

• 14: SDK connection to the server times out, enters the automatic reconnection state.

• 15: Rejoined the channel successfully.

• 16: SDK and the server lose connection.

• 17: The connection state changes due to the echo test.

• 18: The user changed the local IP address.

on_disconnectedCopy Anchor Link

Occurs when the connection state of the SDK changes to 1.

def on_disconnected(self, agora_rtc_conn, conn_info, reason)

ParametersCopy Anchor Link

agora_rtc_conn

The RTC connection object. See RtcConnection.

conn_info

The connection information. See RTCConnInfo.

reason

Connection state change reason:

• 0: Establishing a network connection.

• 1: Successfully joined the channel.

• 2: Network connection interrupted.

• 3: Network connection forbidden by the server.

• 4: Failed to join the channel.

• 5: Left the channel.

• 6: Invalid App ID. Please change to a valid App ID and try again.

• 7: Invalid channel name. Please change to a valid channel name and try again.

• 8: The generated token is invalid. Generally, the following reasons:

  • App Certificate is enabled on the console, but the Token is not used when joining the channel. When App Certificate is enabled, you must use a Token.
  • The uid specified in connect when joining the channel does not match the uid used when generating the Token.

• 9: The generated Token is invalid.

• 10: This user is banned by the server.

• 11: SDK attempts to reconnect due to setting a proxy server.

• 12: The network connection state changes due to updating the Token.

• 13: The client IP address changes, possibly due to changes in network type or the IP or port of the network operator.

• 14: SDK connection to the server times out, enters the automatic reconnection state.

• 15: Rejoined the channel successfully.

• 16: SDK and the server lose connection.

• 17: The connection state changes due to the echo test.

• 18: The user changed the local IP address.

on_token_privilege_will_expireCopy Anchor Link

Occurs when the token will expire in 30 seconds.

def on_token_privilege_will_expire(self, agora_rtc_conn, token)

In the call process, if the Token is about to expire, the SDK triggers this callback 30 seconds before the Token expires to remind the app to update the Token.

When you receive this callback, you need to generate a new Token on the server side and call renew_token to pass the newly generated Token to the SDK.

ParametersCopy Anchor Link

on_token_privilege_did_expireCopy Anchor Link

Occurs when the token expires.

def on_token_privilege_did_expire(self, agora_rtc_conn)

In the call process, if the token expires, the SDK triggers this callback to remind the app to update the Token.

When you receive this callback, you need to generate a new Token on the server side and call connect to reconnect the channel.

ParametersCopy Anchor Link

on_user_joinedCopy Anchor Link

Occurs when a remote user joins the channel. You can get the remote user's ID through this callback.

def on_user_joined(self, agora_rtc_conn, user_id)

ParametersCopy Anchor Link

on_user_leftCopy Anchor Link

Occurs when a remote user leaves the channel. You can get the reason for the remote user leaving the channel through the reason parameter.

def on_user_left(self, agora_rtc_conn, user_id, reason)

ParametersCopy Anchor Link

agora_rtc_conn

The RTC connection object. See RtcConnection.

user_id

The remote user's ID.

reason

Connection state change reason:

• 0: Establishing a network connection.

• 1: Successfully joined the channel.

• 2: Network connection interrupted.

• 3: Network connection forbidden by the server.

• 4: Failed to join the channel.

• 5: Left the channel.

• 6: Invalid App ID. Please change to a valid App ID and try again.

• 7: Invalid channel name. Please change to a valid channel name and try again.

• 8: The generated token is invalid. Generally, the following reasons:

  • App Certificate is enabled on the console, but the Token is not used when joining the channel. When App Certificate is enabled, you must use a Token.
  • The uid specified in connect when joining the channel does not match the uid used when generating the Token.

• 9: The generated Token is invalid.

• 10: This user is banned by the server.

• 11: SDK attempts to reconnect due to setting a proxy server.

• 12: The network connection state changes due to updating the Token.

• 13: The client IP address changes, possibly due to changes in network type or the IP or port of the network operator.

• 14: SDK connection to the server times out, enters the automatic reconnection state.

• 15: Rejoined the channel successfully.

• 16: SDK and the server lose connection.

• 17: The connection state changes due to the echo test.

• 18: The user changed the local IP address.

on_stream_message_errorCopy Anchor Link

Occurs when a data stream message error occurs. This callback indicates that the local user has not received the stream message sent by the remote user using the send_stream_message method.

def on_stream_message_error(self, agora_rtc_conn, user_id_str, stream_id, code, missed, cached)

ParametersCopy Anchor Link

on_errorCopy Anchor Link

Occurs when there is an error. This callback indicates that an error related to the network or media occurred during the SDK runtime. Generally, the error reported by the SDK means that the SDK cannot automatically recover and requires intervention from the App or user prompt.

def on_error(self, agora_rtc_conn, error_code, error_msg)

ParametersCopy Anchor Link

on_encryption_errorCopy Anchor Link

def on_encryption_error(self, agora_rtc_conn, error_type)

Occurs when encryption errors occur.

ParametersCopy Anchor Link

LocalUserCopy Anchor Link

The LocalUser class. Defines the behavior and state of the local user. Each RTC connection has its own user. You can get the local user through get_local_user. Each user has two roles: the host (can send and receive audio and video streams) and the audience (can only receive audio and video streams).

set_user_roleCopy Anchor Link

Sets the user role. You can call this method before or after the user connects to the channel.

def set_user_role(self, role)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

set_audio_encoder_configurationCopy Anchor Link

Sets the audio encoding. The SDK applies the configuration to all audio tracks sent.

def set_audio_encoder_configuration(self, config)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

publish_audioCopy Anchor Link

Publishes the local audio track to the channel. By default, all published audio tracks are mixed.

def publish_audio(self, agora_local_audio_track:LocalAudioTrack)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.
  • -5: If the local user's role is not the host, this error is returned.

unpublish_audioCopy Anchor Link

Stops publishing the local audio track to the channel.

def unpublish_audio(self, agora_local_audio_track:LocalAudioTrack)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

publish_videoCopy Anchor Link

Publishes the local video track to the channel.

def publish_video(self, agora_local_video_track:LocalVideoTrack)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

unpublish_videoCopy Anchor Link

Stops publishing the local video track to the channel.

def unpublish_video(self, agora_local_video_track:LocalVideoTrack)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

subscribe_audioCopy Anchor Link

Subscribes to the audio stream sent by a specific remote user in the channel.

def subscribe_audio(self, user_id)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.
  • -2: If the user does not exist or user_id is invalid, this error is returned.

subscribe_all_audioCopy Anchor Link

Subscribes to all the audio streams sent by remote users in the channel. This method automatically subscribes to the audio streams sent by users who join the channel later.

def subscribe_all_audio(self)

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

unsubscribe_audioCopy Anchor Link

Stops subscribing to the audio stream sent by a specific remote user in the channel.

def unsubscribe_audio(self, user_id)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.
  • -2: If the user does not exist or user_id is invalid, this error is returned.

unsubscribe_all_audioCopy Anchor Link

Stops subscribing to all the audio streams sent by remote users in the channel. This method automatically cancels the subscription of the audio streams sent by users who join the channel later. You must call subscribe_audio or subscribe_all_audio to restore the subscription of audio.

def unsubscribe_all_audio(self)

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

set_playback_audio_frame_before_mixing_parametersCopy Anchor Link

Sets the audio data format reported by on_playback_audio_frame_before_mixing.

def set_playback_audio_frame_before_mixing_parameters(self, channels, sample_rate_hz)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

register_audio_frame_observerCopy Anchor Link

Registers the audio frame observer. You must implement the IAudioFrameObserver class and register the callback based on your needs.

def register_audio_frame_observer(self, observer: IAudioFrameObserver, enable_vad: int, vad_configure)

ParametersCopy Anchor Link

observer

IAudioFrameObserver class.

enable_vad

Whether to enable the built-in voice activity detection (VAD):

• 0: Disable VAD.
• 1: Enable VAD. The SDK returns the VAD results in the on_playback_audio_frame_before_mixing callback.

vad_configure

The VAD configuration, an AudioVadConfigV2 object. The SDK uses this parameter only when enable_vad is 1.

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

unregister_audio_frame_observerCopy Anchor Link

Destroys the IAudioFrameObserver object.

def unregister_audio_frame_observer(self)

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

register_video_encoded_frame_observerCopy Anchor Link

Registers the encoded video frame observer.

def register_video_encoded_frame_observer(self, agora_video_encoded_frame_observer:IVideoEncodedFrameObserver)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

unregister_video_encoded_frame_observerCopy Anchor Link

Destroys the encoded video frame observer.

def unregister_video_encoded_frame_observer(self)

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

subscribe_videoCopy Anchor Link

Subscribes to the video stream sent by a specific remote user in the channel.

def subscribe_video(self, user_id, options:VideoSubscriptionOptions)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.
  • -2: If the user does not exist or user_id is invalid, this error is returned.

subscribe_all_videoCopy Anchor Link

Subscribes to all the video streams sent by remote users in the channel. This method automatically subscribes to the video streams sent by users who join the channel later.

def subscribe_all_video(self, options:VideoSubscriptionOptions)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

unsubscribe_videoCopy Anchor Link

Stops subscribing to the video stream sent by a specific remote user in the channel.

def unsubscribe_video(self, user_id)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.
  • -2: If the user does not exist or user_id is invalid, this error is returned.

unsubscribe_all_videoCopy Anchor Link

Stops subscribing to all the video streams sent by remote users in the channel. This method automatically cancels the subscription of the video streams sent by users who join the channel later. You must call subscribe_video or subscribe_all_video to restore the subscription.

def unsubscribe_all_video(self)

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

register_local_user_observerCopy Anchor Link

Registers the local user observer.

def register_local_user_observer(self, observer:ILocalUserObserver)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

unregister_local_user_observerCopy Anchor Link

Destroys the local user observer.

def unregister_local_user_observer(self)

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

register_video_frame_observerCopy Anchor Link

Registers the IVideoFrameObserver object.

def register_video_frame_observer(self, agora_video_frame_observer2:IVideoFrameObserver)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

unregister_video_frame_observerCopy Anchor Link

Destroys the IVideoFrameObserver object.

def unregister_video_frame_observer(self)

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

get_rtc_connectionCopy Anchor Link

Gets the RtcConnection object.

def get_rtc_connection(self)

ReturnsCopy Anchor Link

• RtcConnection object: Success.
• None: Failure.

releaseCopy Anchor Link

Releases all resources of the LocalUser object.

def release(self)

send_audio_meta_dataCopy Anchor Link

def send_audio_meta_data(self, data)

Sends the audio metadata.

A successful call of this method triggers the on_audio_metadata_received callback on the remote end. The remote user can get the audio metadata in this callback.

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

LocalUserObserverCopy Anchor Link

The LocalUserObserver class.

on_local_audio_track_state_changedCopy Anchor Link

Triggered when the local audio track state changes.

def on_local_audio_track_state_changed(self, agora_local_user, agora_local_audio_track, state, error)

ParametersCopy Anchor Link

on_user_audio_track_state_changedCopy Anchor Link

Occurs when the remote audio track state changes.

def on_user_audio_track_state_changed(self, agora_local_user, user_id, agora_remote_audio_track, state, reason, elapsed)

ParametersCopy Anchor Link

on_stream_messageCopy Anchor Link

Callback for receiving data stream messages. This callback indicates that the local user has received the stream message sent by the remote user through the send_stream_message method.

def on_stream_message(self, agora_local_user, user_id, stream_id, data, length)

ParametersCopy Anchor Link

on_user_info_updatedCopy Anchor Link

Occurs when the user media information is updated.

def on_user_info_updated(self, agora_local_user, user_id, msg, val)

ParametersCopy Anchor Link

on_audio_meta_data_receivedCopy Anchor Link

def on_audio_meta_data_received(self, agora_local_user, user_id, data):

Occurs when the remote audio metadata is received.

This callback indicates that the local user has received the audio metadata sent by the remote user using the send_audio_meta_data method.

ParametersCopy Anchor Link

LocalAudioTrackCopy Anchor Link

The LocalAudioTrack class is the base class for the local audio track.

set_enabledCopy Anchor Link

Enables or disables the local audio track. After the local audio track is enabled, the SDK can capture, process, and encode local audio.

def set_enabled(self, enable)

ParametersCopy Anchor Link

adjust_publish_volumeCopy Anchor Link

Adjusts the audio publishing volume.

def adjust_publish_volume(self, volume)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

set_max_buffer_audio_frame_numberCopy Anchor Link

Sets the maximum capacity of the audio sending buffer.

def set_max_buffer_audio_frame_number(self, num)

In AI interaction applications, the frequency of sending audio frames by the sender may be uneven, for example, sending 1 frame every 20 ms or 3 frames every 20 ms. If the SDK sends data according to the actual sending frequency to the Agora server, the receiver may experience stuttering or frame loss. To optimize the audio transmission performance, the SDK sets an audio sending buffer. Regardless of the actual sending frequency of audio frames by the sender, the SDK stores data in the audio sending buffer. After the data in the audio sending buffer reaches the minimum allowed sending time, the SDK starts sending data to the receiver at a frequency of 10 ms per frame.

The default maximum capacity of the audio sending buffer is 6000, which means it can store up to 6000 frames of data, or 60 seconds of data. If you need a larger buffer capacity, you can call this method to adjust it. If you also need to set the minimum allowed sending time for the audio sending buffer, call the set_send_delay_ms method.

ParametersCopy Anchor Link

clear_sender_bufferCopy Anchor Link

Clears the current audio sending buffer.

def clear_sender_buffer(self)

If you no longer need the data in the current audio sending buffer, call this method to clear the buffer. For example, a user asks AI a question, and AI is answering the question through the SDK. At this time, the audio sending buffer of the SDK is constantly receiving and sending data. When the user interrupts AI's reply and asks another question, you can call this method to clear the buffered data that has not been sent out, so that the SDK can quickly buffer the AI's response to the new topic.

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

set_send_delay_msCopy Anchor Link

Sets the minimum data duration that the audio sending buffer allows to send.

def set_send_delay_ms(self, delay_ms:int)

The default minimum data duration that the SDK allows to send is 160 ms, which means the SDK waits until the audio sending buffer is filled with 160 ms of data before sending the data to the receiver. This will have the following effects:

• If the sender sends data that is greater than or equal to 160 ms, for example 800 ms, the SDK sends the data at a frequency of 10 ms per frame.
• If the sender sends data that is less than 160 ms, for example 100 ms, the SDK waits until the buffer data reaches 160 ms before sending the data at a frequency of 10 ms per frame. This will cause a delay of up to 60 ms.

You can adjust the minimum data duration according to your actual business needs by calling this method.

ParametersCopy Anchor Link

releaseCopy Anchor Link

Releases the local audio track resources.

def release(self)

LocalVideoTrackCopy Anchor Link

The LocalVideoTrack class. Provides basic methods for the local video track. You can publish one or multiple video tracks through the publish_video method.

set_enabledCopy Anchor Link

Enables or disables the local video track. After the local video track is enabled, the SDK can capture, process, and encode the local video.

def set_enabled(self, enable)

ParametersCopy Anchor Link

set_video_encoder_configurationCopy Anchor Link

Sets the video encoding properties.

def set_video_encoder_configuration(self, config)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

MediaNodeFactoryCopy Anchor Link

The MediaNodeFactory class.

create_audio_pcm_data_senderCopy Anchor Link

Creates a PCM data sender module. This method creates an AudioPcmDataSender object, which can be used in the create_custom_audio_track_pcm method.

def create_audio_pcm_data_sender(self)

ReturnsCopy Anchor Link

• AudioPcmDataSender object, if the method call succeeds.
• None, if the method call fails.

create_audio_encoded_frame_senderCopy Anchor Link

Creates an encoded audio data sender module. This method creates an AudioEncodedFrameSender object, which can be used in the create_custom_audio_track_encoded method.

def create_audio_encoded_frame_sender(self)

ReturnsCopy Anchor Link

• AudioEncodedFrameSender object, if the method call succeeds.
• None, if the method call fails.

create_video_frame_senderCopy Anchor Link

Creates a YUV video frame sender module. This method creates a VideoFrameSender object, which can be used in the create_custom_video_track_frame method.

def create_video_frame_sender(self)

ReturnsCopy Anchor Link

• VideoFrameSender object, if the method call succeeds.
• None, if the method call fails.

create_video_encoded_image_senderCopy Anchor Link

Creates an encoded video sender module. This method creates a VideoEncodedImageSender object, which can be used in the create_custom_video_track_encoded method.

def create_video_encoded_image_sender(self)

ReturnsCopy Anchor Link

• VideoEncodedImageSender object, if the method call succeeds.
• None, if the method call fails.

releaseCopy Anchor Link

Releases the MediaNodeFactory object.

def release(self)

AudioPcmDataSenderCopy Anchor Link

The AudioPcmDataSender class.

send_audio_pcm_dataCopy Anchor Link

Sends PCM audio data to the local audio track.

def send_audio_pcm_data(self, frame: PcmAudioFrame)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

AudioEncodedFrameSenderCopy Anchor Link

The AudioEncodedFrameSender Class.

send_encoded_audio_frameCopy Anchor Link

Sends an encoded audio frame to the audio track.

def send_encoded_audio_frame(self, buffer_ptr: int, buffer_size: int, frame_info: EncodedAudioFrameInfo)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

IAudioFrameObserverCopy Anchor Link

The IAudioFrameObserver class.

on_playback_audio_frame_before_mixingCopy Anchor Link

Gets the data before the playback audio is mixed.

def on_playback_audio_frame_before_mixing(self, agora_local_user, channelId, uid, frame: AudioFrame, vad_result_state: int, vad_result_bytearray: bytearray)

ParametersCopy Anchor Link

agora_local_user

The LocalUserObserver class.

channelId

The channel name.

uid

The remote user ID.

frame

The audio raw data. See AudioFrame.

vad_result_state

The VAD state. Valid only when you enable VAD in register_audio_frame_observer:

• < 0: VAD is not enabled.
• 0: Not speaking.
• 1: Started speaking.
• 2: Speaking.
• 3: Stopped speaking.

vad_result_bytearray

The audio data processed by VAD. When VAD is enabled, use this data instead of frame for downstream processing, such as speech recognition.

ReturnsCopy Anchor Link

• 0：The audio frame data is invalid, and the data is discarded.
• 1：The audio frame data is valid, and the data is sent.

VideoFrameSenderCopy Anchor Link

The VideoFrameSender class.

send_video_frameCopy Anchor Link

Sends a YUV format video frame to the video track.

def send_video_frame(self, frame:ExternalVideoFrame)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

IVideoFrameObserverCopy Anchor Link

The IVideoFrameObserver class.

on_frameCopy Anchor Link

def on_frame(self, channel_id, remote_uid, frame:VideoFrame)

Occurs when a video frame is received.

ParametersCopy Anchor Link

VideoEncodedImageSenderCopy Anchor Link

The VideoEncodedImageSender class.

send_encoded_video_imageCopy Anchor Link

Sends an encoded video frame to the video track.

def send_encoded_video_image(self, buffer_ptr:int, buffer_size:int, frame_info:EncodedVideoFrameInfo)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

• 0: Success.
• < 0: Failure.

IVideoEncodedFrameObserverCopy Anchor Link

The IVideoEncodedFrameObserver class.

on_encoded_video_frameCopy Anchor Link

Occurs when an encoded video frame is received.

def on_encoded_video_frame(self, uid, image_buffer, length, video_encoded_frame_info:EncodedVideoFrameInfo)

ParametersCopy Anchor Link

ReturnsCopy Anchor Link

Whether to accept the encoded video frame:

• 0: Do not accept.
• 1: Accept.

Data typeCopy Anchor Link

ClassesCopy Anchor Link

AgoraServiceConfigCopy Anchor Link

Global configuration of the AgoraServiceConfig class. Set when calling the initialize method.

@dataclass(kw_only=True)
class AgoraServiceConfig:
    log_path: str = ""
    log_size: int = 0
    enable_audio_processor: int = 1
    enable_audio_device: int = 0
    enable_video: int = 0
    context: object = None
    appid: str = ""
    area_code: int = AreaCode.AREA_CODE_GLOB.value
    channel_profile: ChannelProfileType = ChannelProfileType.CHANNEL_PROFILE_LIVE_BROADCASTING
    audio_scenario: AudioScenarioType = AudioScenarioType.AUDIO_SCENARIO_CHORUS
    use_string_uid: int = 0
    domain_limit: int = 0
    should_callbck_when_muted: int = 0

log_path

The full path to the log file. If this parameter is set to None, the log is located in the current application's pwd directory

log_size

The size of a single log file in KB. The default value is 1024 KB. If you set this parameter to 1024 KB, the SDK outputs a maximum of 5 MB of log files. If you set this parameter to less than 1024 KB, the setting does not take effect, and the maximum size of a single log file is still 1024 KB.

enable_audio_processor

Whether to enable the audio processing module. - 0: Disable the audio processing module. You will not be able to create an audio track. - 1: (Default) Enable the audio processing module.

enable_audio_device

Whether to enable the Audio Device Module (ADM). ADM is used to manage audio devices such as recording and playing audio. - 0: Disable the audio device module. You cannot record or play audio. - 1: (Default) Enable the audio device module. You can record and play audio. Note: If you set enable_audio_device to 0 and enable_audio_processor to 1, you will not be able to use audio devices, but you can push PCM audio data.

enable_video

Whether to enable video. - 0: (Default) Disable video. - 1: Enable video.

context

The context.

appid

Your Agora project's App ID. If your Agora project has enabled Token authentication, you can also assign this parameter to an RTC Token. See Agora account management for details.

area_code

The access region of the server. This feature is an advanced setting suitable for scenarios with access security restrictions. The area code supports bitwise operations. After specifying the access region, the SDK connects to Agora servers within the specified region. See AreaCode for details.

channel_profile

Channel profile. See ChannelProfileType for details.

audio_scenario

Audio encoding properties. See AudioScenarioType for details.

use_string_uid

Whether to use String user IDs.

• 0: Do not use.
• 1: Use.

domain_limit

Whether to enable domain limit:

• 1: Yes. Only connects to domains that are parsed by DNS.
• 0: (Default) No. There is no limit when connecting to domains.

should_callbck_when_muted

Whether the SDK still triggers the on_playback_audio_frame_before_mixing callback after a remote user mutes their audio:

• 0: (Default) No. The SDK stops triggering the callback when the remote user mutes their audio.
• Greater than 0: Yes. The SDK keeps triggering the callback when the remote user mutes their audio.

AudioEncoderConfigurationCopy Anchor Link

Audio encoder configuration.

@dataclass(kw_only=True)
class AudioEncoderConfiguration:
    audioProfile: AudioProfileType = AudioProfileType.AUDIO_PROFILE_DEFAULT

AudioFrameCopy Anchor Link

The AudioFrame class.

@dataclass(frozen=True, kw_only=True)
class AudioFrame:
    type: int
    samples_per_channel: int
    bytes_per_sample: int
    channels: int
    samples_per_sec: int
    buffer: bytearray
    render_time_ms: int
    avsync_type: int
    far_field_flag: int
    rms: int
    voice_prob: int
    music_prob: int
    pitch: int

AudioSubscriptionOptionsCopy Anchor Link

The audio subscription options.

@dataclass(kw_only=True)
class AudioSubscriptionOptions:
    packet_only: int = 0
    pcm_data_only: int = 0
    bytes_per_sample: int = 0
    number_of_channels: int = 0
    sample_rate_hz: int = 0

EncodedAudioFrameInfoCopy Anchor Link

The encoded audio data.

@dataclass(kw_only=True)
class EncodedAudioFrameInfo:
    capture_timems: int = 0
    codec: AudioCodecType = AudioCodecType.AUDIO_CODEC_AACLC
    number_of_channels: int = 1
    sample_rate: int = 16000
    samples_per_channel: int = 1024
    send_even_if_empty: int = 1
    speech: int = 1

EncodedVideoFrameInfoCopy Anchor Link

The encoded video data.

@dataclass(kw_only=True)
class EncodedVideoFrameInfo:
    codec_type: VideoCodecType = VideoCodecType.VIDEO_CODEC_NONE
    width: int = 0
    height: int = 0
    frames_per_second: int = 0
    frame_type: int = 0
    rotation: int = 0
    track_id: int = 0
    capture_time_ms: int = 0
    decode_time_ms: int = 0
    uid: int = 0
    stream_type: int = 0

EncryptionConfigCopy Anchor Link

@dataclass(kw_only=True)
class EncryptionConfig:
    encryption_mode: int
    encryption_key: str
    encryption_kdf_salt: bytearray = None

Encryption configuration.

encryption_mode

Encryption mode:

• 1: 128-bit AES encryption, XTS mode.
• 2: 128-bit AES encryption, ECB mode.
• 3: 256-bit AES encryption, XTS mode.
• 4: 128-bit SM4 encryption, ECB mode.
• 5: 128-bit AES encryption, GCM mode.
• 6: 256-bit AES encryption, GCM mode.
• 7: (Default) 128-bit AES encryption, GCM mode. This encryption mode requires setting a salt (encryption_kdf_salt).
• 8: 256-bit AES encryption, GCM mode. This encryption mode requires setting a salt (encryption_kdf_salt).

encryption_key

Encryption key, string type, with no length limit. It is recommended to use a 32-byte key.

encryption_kdf_salt

Encryption salt, 32 bytes in length. It is recommended to generate the salt using OpenSSL on the server side.

ExternalVideoFrameCopy Anchor Link

The YUV format video data.

@dataclass(kw_only=True)
class ExternalVideoFrame:
    type: int = 1
    format: int = 0
    buffer: bytearray = None
    stride: int = 0
    height: int = 0
    crop_left: int = 0
    crop_top: int = 0
    crop_right: int = 0
    crop_bottom: int = 0
    rotation: int = 0
    timestamp: int = 0
    egl_context: bytearray = None
    egl_type: int = 0
    texture_id: int = 0
    matrix: list = field(default_factory=list)
    metadata: bytearray = None
    alpha_buffer: bytearray = None
    fill_alpha_buffer: int = 0
    alpha_mode: int = 0
    color_space: ColorSpaceType = field(default_factory=ColorSpaceType)    

type

Video data type: - 1: Type is raw data. - 2: Type is raw data. - 3: Type is Texture.

format

Pixel format: - 0: Raw video pixel format. - 1: I420 format. - 4: RGBA format. - 16: I422 format. - 17: ID3D11TEXTURE2D format. Currently supported types are DXGI_FORMAT_B8G8R8A8_UNORM, DXGI_FORMAT_B8G8R8A8_TYPELESS, and DXGI_FORMAT_NV12. Note: The SDK currently does not support the Alpha channel. The incoming Alpha value will be discarded.

buffer

Video buffer.

stride

The stride of the incoming video frame, in pixels rather than bytes. For Texture, this value refers to the width of the Texture.

height

Height of the incoming video frame.

crop_left

Field related to raw data. Specifies the number of pixels cropped from the left. Default is 0. This parameter is only applicable to raw video data.

crop_top

Field related to raw data. Specifies the number of pixels cropped from the top. Default is 0. This parameter is only applicable to raw video data.

crop_right

Field related to raw data. Specifies the number of pixels cropped from the right. Default is 0. This parameter is only applicable to raw video data.

crop_bottom

Field related to raw data. Specifies the number of pixels cropped from the bottom. Default is 0. This parameter is only applicable to raw video data.

rotation

Field related to raw data. Specifies whether the incoming video frame should be rotated clockwise. Possible values are 0, 90, 180, 270. Default is 0.

timestamp

Timestamp of the incoming video frame, in milliseconds. Incorrect timestamps can cause frame drops or audio-video desynchronization.

egl_context

This parameter is only applicable to Texture format video data. - When using the OpenGL interface defined by Khronos (javax.microedition.khronos.egl.), set the eglContext to this field. - When using the OpenGL interface defined by Android (android.opengl.), set the eglContext to this field.

egl_type

This parameter is only applicable to Texture format video data. Refers to the EGL context type.

texture_id

This parameter is only applicable to Texture format video data. Refers to the Texture ID of the video frame.

matrix

This parameter is only applicable to Texture format video data. Refers to an input 4x4 transformation matrix, typically an identity matrix.

metadata

The metadata buffer of the video frame. The default value is None.

alpha_buffer

Alpha channel data output by the portrait segmentation algorithm. This data matches the size of the video frame, with each pixel value ranging from [0,255], where 0 represents the background and 255 represents the foreground (portrait). You can set this parameter to render the video background with various effects, such as transparency, solid color, images, or videos.

fill_alpha_buffer

[For BGRA or RGBA only] Whether to extract alphaBuffer from BGRA or RGBA data:

• 1: Yes. Set it to true if you do not explicitly specify the alphaBuffer.
• 0: (Default) No.

alpha_mode

The relative position between alphaBuffer and the frame:

• 0: (Default) Normal frame.
• 1: alphaBuffer is above the frame.
• 2: alphaBuffer is below the frame.
• 3: alphaBuffer is on the left of the frame.
• 4: alphaBuffer is on the right of the frame.

color_space

The color space of the video frame. See ColorSpaceType.

PcmAudioFrameCopy Anchor Link

PCM audio data.

@dataclass(kw_only=True)
class PcmAudioFrame:
    data: bytearray = None
    samples_per_channel: int = 0
    bytes_per_sample: int = 0
    number_of_channels: int = 0
    sample_rate: int = 0
    timestamp: int = 0

RTCConnConfigCopy Anchor Link

RTC connection configuration.

@dataclass(kw_only=True)
class RTCConnConfig:
    auto_subscribe_audio: int = 0
    auto_subscribe_video: int = 0
    enable_audio_recording_or_playout: int = 0
    max_send_bitrate: int = 0
    min_port: int = 0
    max_port: int = 0
    audio_subs_options: 'AudioSubscriptionOptions' = field(default_factory=AudioSubscriptionOptions)
    client_role_type: ClientRoleType = ClientRoleType.CLIENT_ROLE_BROADCASTER
    channel_profile: ChannelProfileType = ChannelProfileType.CHANNEL_PROFILE_LIVE_BROADCASTING
    audio_recv_media_packet: int = 0
    audio_recv_encoded_frame: int = 0
    video_recv_media_packet: int = 0

RTCConnInfoCopy Anchor Link

The RTC connection information.

@dataclass(frozen=True, kw_only=True)
class RTCConnInfo():
    id: int
    channel_id: str
    state: int
    local_user_id: str
    internal_uid: int

SenderOptionsCopy Anchor Link

Configuration of the local video track object that includes the video source for sending encoded video data.

@dataclass(kw_only=True)
class SenderOptions:
    target_bitrate: int
    cc_mode: TCcMode = TCcMode.CC_ENABLED
    codec_type: VideoCodecType = VideoCodecType.VIDEO_CODEC_NONE

VideoDimensionsCopy Anchor Link

Resolution of the video encoding.

@dataclass(kw_only=True)
class VideoDimensions:
    width: int
    height: int

VideoEncoderConfigurationCopy Anchor Link

Video encoding properties.

@dataclass(kw_only=True)
class VideoEncoderConfiguration:
    dimensions: VideoDimensions
    codec_type: VideoCodecType = VideoCodecType.VIDEO_CODEC_NONE
    frame_rate: int = 15
    bitrate: int = 0
    min_bitrate: int = 0
    orientation_mode: int = 0
    degradation_preference: int = 0
    mirror_mode: int = 0
    encode_alpha: int = 0

VideoFrameCopy Anchor Link

Properties of the video frame. The video data format is YUV420. The buffer is given as a pointer to a pointer. This interface cannot modify the pointer of the buffer, only the content of the buffer.

@dataclass(kw_only=True)
class VideoFrame():
    type: int = 0
    width: int = 0
    height: int = 0
    y_stride: int = 0
    u_stride: int = 0
    v_stride: int = 0
    y_buffer: bytearray = None
    u_buffer: bytearray = None
    v_buffer: bytearray = None
    rotation: int = 0
    render_time_ms: int = 0
    avsync_type: int = 0
    metadata: bytearray = None
    shared_context: str = None
    texture_id: int = 0
    matrix: list = None
    alpha_buffer: bytearray = None
    alpha_mode: int = 0

VideoSubscriptionOptionsCopy Anchor Link

Video subscription options.

@dataclass(kw_only=True)
class VideoSubscriptionOptions:
    type: VideoStreamType = VideoStreamType.VIDEO_STREAM_HIGH
    encodedFrameOnly: bool = False

EnumsCopy Anchor Link

AreaCodeCopy Anchor Link

Server access regions. This feature is an advanced setting and is used in scenarios with access security restrictions. The region code supports bitwise operations. After specifying the access region, the SDK will connect to the Agora servers within the specified region.

AudioCodecTypeCopy Anchor Link

Audio codec types.

AudioProfileTypeCopy Anchor Link

Audio profiles.

AUDIO_PROFILE_DEFAULT

0: Default audio profile.

• In communication scenarios: 16 kHz sampling rate, voice codec, mono, maximum encoding bitrate of 16 Kbps.
• In live broadcast scenarios: 48 kHz sampling rate, music codec, mono, maximum encoding bitrate of 64 Kbps.

AUDIO_PROFILE_SPEECH_STANDARD

1: Specifies a 32 kHz sampling rate, voice codec, mono, maximum encoding bitrate of 18 Kbps.

AUDIO_PROFILE_MUSIC_STANDARD

2: Specifies a 48 kHz sampling rate, music codec, mono, maximum encoding bitrate of 64 Kbps.

AUDIO_PROFILE_MUSIC_STANDARD_STEREO

3: Specifies a 48 kHz sampling rate, music codec, stereo, maximum encoding bitrate of 80 Kbps.

AUDIO_PROFILE_MUSIC_HIGH_QUALITY

4: Specifies a 48 kHz sampling rate, music codec, mono, maximum encoding bitrate of 96 Kbps.

AUDIO_PROFILE_MUSIC_HIGH_QUALITY_STEREO

5: Specifies a 48 kHz sampling rate, music codec, stereo, maximum encoding bitrate of 128 Kbps.

AUDIO_PROFILE_IOT

6: Specifies a 16 kHz sampling rate, voice codec, mono, with echo cancellation algorithm AES.

AUDIO_PROFILE_NUM

7: Enumeration boundary.

AudioScenarioTypeCopy Anchor Link

Audio scenario types.

ChannelProfileTypeCopy Anchor Link

Channel usage scenarios.

ClientRoleTypeCopy Anchor Link

User roles.

TCcModeCopy Anchor Link

Congestion control modes.

VideoCodecTypeCopy Anchor Link

Video codec types.

VideoStreamTypeCopy Anchor Link

Video stream types.