# LocalUser 类 (/zh-CN/api-reference/rtc-server-sdk/python-api/localuser.python) > For AI agents: see the complete documentation index at [llms.txt](/llms.txt). `LocalUser` 类。定义了本地用户的行为和状态。每个 RTC 连接都有自己的用户。你可以通过 [`get_local_user`](/zh-CN/api-reference/rtc-server-sdk/python-api/rtcconnection.python#getlocaluser) 获取本地用户。每个用户有两种角色:主播(能发送和接收音视频流)和观众(只能接收音视频流)。 ## set_user_role [#set_user_role] ```python def set_user_role(self, role) ``` 设置用户角色。你可以在用户连接频道前或连接频道后调用该方法。 :::warning[注意] 如果 [`connect`](/zh-CN/api-reference/rtc-server-sdk/python-api/rtcconnection.python#connect) 中的 `token` 与 `role` 参数设置的角色不同,连接会失败。 ::: #### 参数 [#参数] | 参数 | 描述 | | --- | --- | | `role` | 用户角色。详见 [`ClientRoleType`](/zh-CN/api-reference/rtc-server-sdk/python-api/apidatatype.python#clientroletype)。 | #### 返回值 [#返回值] - 0: 方法调用成功。 - < 0: 方法调用失败。 ## set_audio_encoder_configuration [#set_audio_encoder_configuration] ```python def set_audio_encoder_configuration(self, config) ``` 设置音频编码。SDK 会将配置应用于全部发送的音频轨道。 #### 参数 [#参数-1] | 参数 | 描述 | |---------------|----------------------------------------------------------------------| | `config` | 音频编码配置。详见 [`AudioEncoderConfiguration`](/zh-CN/api-reference/rtc-server-sdk/python-api/apidatatype.python#audioencoderconfiguration)。 | #### 返回值 [#返回值-1] - 0: 方法调用成功。 - < 0: 方法调用失败。 ## publish_audio [#publish_audio] ```python def publish_audio(self, agora_local_audio_track:LocalAudioTrack) ``` 将本地音频轨道发送到频道。默认情况下,所有发布的音频轨道都会进行混音。 #### 参数 [#参数-2] | 参数 | 描述 | |---------------|----------------------------------------------------------------------| | `agora_local_audio_track` | 需要发布的本地音频轨道。详见 [`LocalAudioTrack`](/zh-CN/api-reference/rtc-server-sdk/python-api/localaudiotrack.python)。 | #### 返回值 [#返回值-2] - 0: 方法调用成功。 - < 0: 方法调用失败。 - `-5`: 如果本地用户的角色不是主播,会返回此错误。 ## unpublish_audio [#unpublish_audio] ```python def unpublish_audio(self, agora_local_audio_track:LocalAudioTrack) ``` 停止将本地音频轨道发送到频道。 #### 参数 [#参数-3] | 参数 | 描述 | |---------------|----------------------------------------------------------------------| | `agora_local_audio_track` | 需要停止发布的本地音频轨道。详见 [`LocalAudioTrack`](/zh-CN/api-reference/rtc-server-sdk/python-api/localaudiotrack.python)。 | #### 返回值 [#返回值-3] - 0: 方法调用成功。 - < 0: 方法调用失败。 ## publish_video [#publish_video] ```python def publish_video(self, agora_local_video_track:LocalVideoTrack) ``` 将本地视频轨道发送到频道。 #### 参数 [#参数-4] | 参数 | 描述 | |---------------|----------------------------------------------------------------------| | `agora_local_video_track` | 需要发布的本地视频轨道。详见 [`LocalVideoTrack`](/zh-CN/api-reference/rtc-server-sdk/python-api/localvideotrack.python)。 | #### 返回值 [#返回值-4] - 0: 方法调用成功。 - < 0: 方法调用失败。 ## unpublish_video [#unpublish_video] ```python def unpublish_video(self, agora_local_video_track:LocalVideoTrack) ``` 停止将本地视频轨道发送到频道。 #### 参数 [#参数-5] | 参数 | 描述 | |---------------|----------------------------------------------------------------------| | `agora_local_video_track` | 需要停止发布的本地视频轨道。详见 [`LocalVideoTrack`](/zh-CN/api-reference/rtc-server-sdk/python-api/localvideotrack.python)。 | #### 返回值 [#返回值-5] - 0: 方法调用成功。 - < 0: 方法调用失败。 ## subscribe_audio [#subscribe_audio] ```python def subscribe_audio(self, user_id) ``` 订阅频道中特定的远端用户发送的音频流。 #### 参数 [#参数-6] | 参数 | 描述 | |---------------|----------------------------------------------------------------------| | `user_id` | 远端用户的用户 ID。 | #### 返回值 [#返回值-6] - 0: 方法调用成功。 - < 0: 方法调用失败。 - `-2`: 如果用户不存在或 `user_id` 无效时会返回该错误。 ## subscribe_all_audio [#subscribe_all_audio] ```python def subscribe_all_audio(self) ``` 订阅频道中全部远端用户发送的音频流。该方法会自动订阅频道中后续加入的用户发送的音频流。 #### 返回值 [#返回值-7] - 0: 方法调用成功。 - < 0: 方法调用失败。 ## unsubscribe_audio [#unsubscribe_audio] ```python def unsubscribe_audio(self, user_id) ``` 停止订阅频道中特定的远端用户发送的音频流。 #### 参数 [#参数-7] | 参数 | 描述 | |---------------|----------------------------------------------------------------------| | `user_id` | 远端用户的用户 ID。 | #### 返回值 [#返回值-8] - 0: 方法调用成功。 - < 0: 方法调用失败。 - `-2`: 如果用户不存在或 `user_id` 无效时会返回该错误。 ## unsubscribe_all_audio [#unsubscribe_all_audio] ```python def unsubscribe_all_audio(self) ``` 停止订阅频道中全部远端用户发送的音频流。该方法会自动取消订阅频道中后续加入的用户发送的音频流。你必须调用 [`subscribe_audio`](/zh-CN/api-reference/rtc-server-sdk/python-api/localuser.python#subscribeaudio) 或 [`subscribe_all_audio`](/zh-CN/api-reference/rtc-server-sdk/python-api/localuser.python#subscribeallaudio) 才能恢复订阅音频。 #### 返回值 [#返回值-9] - 0: 方法调用成功。 - < 0: 方法调用失败。 ## set_playback_audio_frame_before_mixing_parameters [#set_playback_audio_frame_before_mixing_parameters] ```python def set_playback_audio_frame_before_mixing_parameters(self, channels, sample_rate_hz) ``` 设置 [`on_playback_audio_frame_before_mixing`](/zh-CN/api-reference/rtc-server-sdk/python-api/iaudioframeobserver.python#onplaybackaudioframebeforemixing) 报告的音频数据格式。 #### 参数 [#参数-8] | 参数 | 描述 | |---------------|----------------------------------------------------------------------| | `channels` | 音频数据声道数,可设置为 1(单声道) 或 2(双声道)。 | | `sample_rate_hz` | 音频数据采样率,可设置为 8000、 16000、32000、 44100 或 48000。 | #### 返回值 [#返回值-10] - 0: 方法调用成功。 - < 0: 方法调用失败。 ## register_audio_frame_observer [#register_audio_frame_observer] ```python def register_audio_frame_observer(self, observer:IAudioFrameObserver) ``` 注册音频帧观测器。你必须实现 [`IAudioFrameObserver`](/zh-CN/api-reference/rtc-server-sdk/python-api/iaudioframeobserver.python) 类并根据需求注册回调。 #### 参数 [#参数-9] | 参数 | 描述 | |---------------|----------------------------------------------------------------------| | `observer` | `IAudioFrameObserver` 类。 | #### 返回值 [#返回值-11] - 0: 方法调用成功。 - < 0: 方法调用失败。 ## unregister_audio_frame_observer [#unregister_audio_frame_observer] ```python def unregister_audio_frame_observer(self) ``` 销毁 [`IAudioFrameObserver`](/zh-CN/api-reference/rtc-server-sdk/python-api/iaudioframeobserver.python) 对象。 #### 返回值 [#返回值-12] - 0: 方法调用成功。 - < 0: 方法调用失败。 ## register_video_encoded_frame_observer [#register_video_encoded_frame_observer] ```python def register_video_encoded_frame_observer(self, agora_video_encoded_frame_observer:IVideoEncodedFrameObserver) ``` 注册已编码视频帧观测器。 #### 参数 [#参数-10] | 参数 | 描述 | |---------------|----------------------------------------------------------------------| | `agora_video_encoded_frame_observer` | 已编码视频帧观测器。详见 [`IVideoEncodedFrameObserver`](/zh-CN/api-reference/rtc-server-sdk/python-api/ivideoencodedframeobserver.python)。 | #### 返回值 [#返回值-13] - 0: 方法调用成功。 - < 0: 方法调用失败。 ## unregister_video_encoded_frame_observer [#unregister_video_encoded_frame_observer] ```python def unregister_video_encoded_frame_observer(self) ``` 注销已编码视频帧观测器。 #### 返回值 [#返回值-14] - 0: 方法调用成功。 - < 0: 方法调用失败。 ## subscribe_video [#subscribe_video] ```python def subscribe_video(self, user_id, options:VideoSubscriptionOptions) ``` 订阅频道中指定远端用户发送的视频流。 #### 参数 [#参数-11] | 参数 | 描述 | |---------------|----------------------------------------------------------------------| | `user_id` | 远端用户的用户 ID。 | | `options` | 订阅选项。详见 [`VideoSubscriptionOptions`](/zh-CN/api-reference/rtc-server-sdk/python-api/apidatatype.python#videosubscriptionoptions) | #### 返回值 [#返回值-15] - 0: 方法调用成功。 - < 0: 方法调用失败。 - `-2`:如果用户不存在或 `user_id` 无效时会返回该错误。 ## subscribe_all_video [#subscribe_all_video] ```python def subscribe_all_video(self, options:VideoSubscriptionOptions) ``` 订阅频道中全部远端用户发送的视频流。该方法会自动订阅频道中后续加入的用户发送的视频流。 #### 参数 [#参数-12] | 参数 | 描述 | |---------------|----------------------------------------------------------------------| | `options` | 订阅选项。详见 [`VideoSubscriptionOptions`](/zh-CN/api-reference/rtc-server-sdk/python-api/apidatatype.python#videosubscriptionoptions) | #### 返回值 [#返回值-16] - 0: 方法调用成功。 - < 0: 方法调用失败。 ## unsubscribe_video [#unsubscribe_video] ```python def unsubscribe_video(self, user_id) ``` 停止订阅频道中指定远端用户发送的视频流。 #### 参数 [#参数-13] | 参数 | 描述 | |---------------|----------------------------------------------------------------------| | `user_id` | 远端用户的用户 ID。 | #### 返回值 [#返回值-17] - 0: 方法调用成功。 - < 0: 方法调用失败。 - `-2`:如果用户不存在或 `user_id` 无效时会返回该错误。 ## unsubscribe_all_video [#unsubscribe_all_video] ```python def unsubscribe_all_video(self) ``` 停止订阅频道中全部远端用户发送的视频流。该方法会自动取消订阅频道中后续加入的用户发送的视频流。你必须调用 [`subscribe_video`](/zh-CN/api-reference/rtc-server-sdk/python-api/localuser.python#subscribevideo) 或 [`subscribe_all_video`](/zh-CN/api-reference/rtc-server-sdk/python-api/localuser.python#subscribeallvideo) 才能恢复订阅。 #### 返回值 [#返回值-18] - 0: 方法调用成功。 - < 0: 方法调用失败。 ## register_local_user_observer [#register_local_user_observer] ```python def register_local_user_observer(self, observer:ILocalUserObserver) ``` 注册本地用户观测器。 #### 参数 [#参数-14] | 参数 | 描述 | |---------------|----------------------------------------------------------------------| | `observer` | [`ILocalUserObserver`](/zh-CN/api-reference/rtc-server-sdk/python-api/localuserobserver.python) 类。 | #### 返回值 [#返回值-19] - 0: 方法调用成功。 - < 0: 方法调用失败。 ## unregister_local_user_observer [#unregister_local_user_observer] ```python def unregister_local_user_observer(self) ``` 销毁本地用户观测器。 #### 返回值 [#返回值-20] - 0: 方法调用成功。 - < 0: 方法调用失败。 ## register_video_frame_observer [#register_video_frame_observer] ```python def register_video_frame_observer(self, agora_video_frame_observer2:IVideoFrameObserver) ``` 注册 [`IVideoFrameObserver`](/zh-CN/api-reference/rtc-server-sdk/python-api/ivideoframeobserver.python) 对象。 #### 参数 [#参数-15] | 参数 | 描述 | |---------------|----------------------------------------------------------------------| | `agora_video_frame_observer2` | `IVideoFrameObserver` 类。 | #### 返回值 [#返回值-21] - 0: 方法调用成功。 - < 0: 方法调用失败。 ## unregister_video_frame_observer [#unregister_video_frame_observer] ```python def unregister_video_frame_observer(self, agora_video_frame_observer2) ``` 销毁 [`IVideoFrameObserver`](/zh-CN/api-reference/rtc-server-sdk/python-api/ivideoframeobserver.python) 对象。 #### 返回值 [#返回值-22] - 0: 方法调用成功。 - < 0: 方法调用失败。 ## get_rtc_connection [#get_rtc_connection] ```python def get_rtc_connection(self) ``` 获取 `RtcConnection` 对象。 #### 返回值 [#返回值-23] - `RtcConnection` 对象:方法调用成功。 - `None`:方法调用失败。 ## release [#release] ```python def release(self) ``` 释放 `LocalUser` 对象的所有资源。 ## send_audio_metadata [#send_audio_metadata] ```python def send_audio_meta_data(self, data) ``` 发送音频 Metadata 数据。 成功调用该方法后,远端会触发 [`on_audio_metadata_received`](/zh-CN/api-reference/rtc-server-sdk/python-api/localuserobserver.python#onaudiometadatareceived) 回调,远端用户可以在该回调中获取接收到的音频 Metadata 数据。 #### 参数 [#参数-16] | 参数 | 描述 | |---------------|----------------------------------------------------------------------| | `data` | 音频 Metadata 数据。 | #### 返回值 [#返回值-24] - 0: 方法调用成功。 - < 0: 方法调用失败。